Renaming AppState.setActive() -> setEnabled()

mulova · March 29, 2011, 1:14pm

For consistency, this patch renames setActive()/isActive() to setEnabled()/isEnabled()

http://hub.jmonkeyengine.org/groups/development-discussion-jme3/forum/topic/setactive-vs-setenabled/

[patch]

Index: src/core/com/jme3/cinematic/Cinematic.java

===================================================================

— src/core/com/jme3/cinematic/Cinematic.java (revision 7141)

+++ src/core/com/jme3/cinematic/Cinematic.java (working copy)

@@ -198,16 +198,33 @@

return initialized;

}

/**
```
* Use setEnabled() instead 
```
```
*/ 
```
@Deprecated

public void setActive(boolean active) {

```
 if (active) { 
```
```
 play(); 
```
```
 } 
```

```
 setEnabled(active); 
```

}

/**
```
* Use isEnabled() instead 
```
```
*/ 
```
@Deprecated

public boolean isActive() {
```
 return isEnabled(); 
```
}

+
public void setEnabled(boolean enabled) {
```
 if (enabled) { 
```
```
 play(); 
```
```
 } 
```
}

+
public boolean isEnabled() {

return playState == PlayState.Playing;

}

+

public void stateAttached(AppStateManager stateManager) {

}

Index: src/core/com/jme3/app/state/AppState.java

===================================================================

— src/core/com/jme3/app/state/AppState.java (revision 7141)

+++ src/core/com/jme3/app/state/AppState.java (working copy)

@@ -64,22 +64,41 @@

public boolean isInitialized();

/**
```
* Use setEnabled() instead. 
```

Activate or deactivate the functionality of the <code>AppState</code>.
The effect of this call depends on implementation. An
<code>AppState</code> starts as being active by default.

*
@param active activate the AppState or not.

*/

@Deprecated

public void setActive(boolean active);

/**
```
* Use isEnabled() instead. 
```

@return True if the <code>AppState</code> is active, false otherwise.

*
@see AppState#setActive(boolean)

*/

@Deprecated

public boolean isActive();

/**

* Enable or disable the functionality of the &lt;code&gt;AppState&lt;/code&gt;.<br />

* The effect of this call depends on implementation. An<br />

* &lt;code&gt;AppState&lt;/code&gt; starts as being enabled by default.<br />

```
* 
```

* @param active activate the AppState or not.<br />

```
*/ 
```
public void setEnabled(boolean active);

+
/**

* @return True if the &lt;code&gt;AppState&lt;/code&gt; is enabled, false otherwise.<br />

```
* 
```

* @see AppState#setEnabled(boolean)<br />

```
*/ 
```
public boolean isEnabled();
/**

Called when the state was attached.

*
@param stateManager State manager to which the state was attached to.

Index: src/core/com/jme3/app/state/AbstractAppState.java

===================================================================

— src/core/com/jme3/app/state/AbstractAppState.java (revision 7141)

+++ src/core/com/jme3/app/state/AbstractAppState.java (working copy)

@@ -49,7 +49,7 @@
is set back to false.

*/

protected boolean initialized = false;

private boolean active = true;

private boolean enabled = true;

public void initialize(AppStateManager stateManager, Application app) {

initialized = true;

@@ -59,12 +59,28 @@

return initialized;

}
/**
```
* Use setEnabled() instead 
```
```
*/ 
```
@Deprecated

public void setActive(boolean active) {

```
 this.active = active; 
```

```
 setEnabled(active); 
```

}

/**
```
* Use isEnabled() instead 
```
```
*/ 
```
@Deprecated

public boolean isActive() {

```
 return active; 
```

```
 return isEnabled(); 
```
}

+
public void setEnabled(boolean enabled) {
```
 this.enabled = enabled; 
```
}

+
public boolean isEnabled() {
```
 return enabled; 
```

}

public void stateAttached(AppStateManager stateManager) {

Index: src/core/com/jme3/app/state/AppStateManager.java

===================================================================

— src/core/com/jme3/app/state/AppStateManager.java (revision 7141)

+++ src/core/com/jme3/app/state/AppStateManager.java (working copy)

@@ -139,7 +139,7 @@

if (!state.isInitialized())

state.initialize(this, app);

           if (state.isActive()) {<br />

           if (state.isEnabled()) {<br />

state.update(tpf);

}

}

@@ -158,7 +158,7 @@

if (!state.isInitialized())

state.initialize(this, app);

           if (state.isActive()) {<br />

           if (state.isEnabled()) {<br />

state.render(rm);

}

}

@@ -177,7 +177,7 @@

if (!state.isInitialized())

state.initialize(this, app);

           if (state.isActive()) {<br />

           if (state.isEnabled()) {<br />

state.postRender();

}

}

Index: src/test/jme3test/animation/TestCameraMotionPath.java

===================================================================

— src/test/jme3test/animation/TestCameraMotionPath.java (revision 7141)

+++ src/test/jme3test/animation/TestCameraMotionPath.java (working copy)

@@ -60,7 +60,7 @@

private MotionTrack cameraMotionControl;

private ChaseCamera chaser;

private CameraNode camNode;

-

+

public static void main(String[] args) {

TestCameraMotionPath app = new TestCameraMotionPath();

app.start();

Index: src/jbullet/com/jme3/bullet/BulletAppState.java

===================================================================

— src/jbullet/com/jme3/bullet/BulletAppState.java (revision 7141)

+++ src/jbullet/com/jme3/bullet/BulletAppState.java (working copy)

@@ -149,11 +149,27 @@

return initialized;

}

/**
```
* Use setEnabled() instead 
```
```
*/ 
```
@Deprecated

public void setActive(boolean active) {

```
 this.active = active; 
```

```
 setEnabled(active); 
```

}

/**
```
* Use isEnabled() instead 
```
```
*/ 
```
@Deprecated

public boolean isActive() {
```
 return isEnabled(); 
```
}

+
public void setEnabled(boolean enabled) {
```
 this.active = enabled; 
```
}

+
public boolean isEnabled() {

return active;

}

[/patch]

mulova · March 31, 2011, 12:27am

because It doesn’t break any existing code and nehon agreed,

I committed this in svn. rev.7143

If there is a problem, let me know. then I’ll revert this.

nehon · March 31, 2011, 7:05am

Thanks Mulova

normen · April 2, 2011, 9:11pm

Keeping the deprecated method in the AppState interface was not such a good idea, the users using that will have to change their code anyway and when you keep the deprecated method they have to change it a second time when we finally remove it, I changed that and only kept setActive in the AbstractAppState. Also, please download the whole trunk folder and run a complete sdk build before committing and at least tell me when the build breaks, because otherwise the people will not get any updates until I somehow recognize the build is broken.

Cheers,

Normen

mulova · April 2, 2011, 9:29pm

I see. I’ll do as you said next time.

Have a nice weekend normen!

Momoko_Fan · April 2, 2011, 9:30pm

Also to add to what normen said, you should try running some of the relevant tests under jme3test before committing to make sure your changes did not break anything.

mulova · April 2, 2011, 9:58pm

Oops, Maybe I did something wrong. :o

It was so obvious so I didn’t do that.

I’ll always run relevant test from now on.

Good day Momoko_Fan.