hongshaorou/openrocket
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Bugfix] Cleaned up event-handling, esp. with active stages & graphics

Browse Source 
- added new ComponentChangeEvent type: GRAPHIC
  - does not change the rocket structure, nor behavior, but requires updates to the UI
- removed event handling from FlightConfiguration
  - caused a circular event loop
  - also, collected too many responsibilities in the class (bad code smell)
- minor refactor of event handling in Rocket. (no change in behavior)
- Fixed StageSelector behavior
  - should now pull selected configuration from rocket
  - should now correctly notify rocket (and indirectly, the graphics)
This commit is contained in:
Daniel_M_Williams 2016-01-23 20:03:53 -05:00
parent 39420ddfc0
commit fbd40859a5
8 changed files with 68 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
core/src/net/sf/openrocket/rocketcomponent/ComponentChangeEvent.java
View File

@ -14,7 +14,9 @@ public class ComponentChangeEvent extends EventObject {
UNDO( 16, "UNDO"),
MOTOR( 32, "Motor"),
EVENT( 64, "Event"),
TEXTURE ( 128, "Texture");
TEXTURE ( 128, "Texture")
, GRAPHIC( 256, "Configuration")
;
protected int value;
protected String name;
@ -39,8 +41,7 @@ public class ComponentChangeEvent extends EventObject {
/** A change that affects the mass and aerodynamic properties of the rocket */
public static final int AEROMASS_CHANGE = (TYPE.MASS.value | TYPE.AERODYNAMIC.value );
public static final int BOTH_CHANGE = AEROMASS_CHANGE; // syntactic sugar / backward compatibility
/** when a flight configuration fires an event, it is of this type */
public static final int CONFIG_CHANGE = (TYPE.MASS.value | TYPE.AERODYNAMIC.value | TYPE.TREE.value | TYPE.MOTOR.value | TYPE.EVENT.value);
/** A change that affects the rocket tree structure */
public static final int TREE_CHANGE = TYPE.TREE.value;
@ -52,6 +53,9 @@ public class ComponentChangeEvent extends EventObject {
public static final int EVENT_CHANGE = TYPE.EVENT.value;
/** A change to the 3D texture assigned to a component*/
public static final int TEXTURE_CHANGE = TYPE.TEXTURE.value;
// when a flight configuration fires an event, it is of this type
// UI-only change, but does not effect the true
public static final int GRAPHIC_CHANGE = TYPE.GRAPHIC.value;
//// A bit-field that contains all possible change types.
//// Will output as -1. for an explanation, see "twos-complement" representation of signed integers

14
core/src/net/sf/openrocket/rocketcomponent/FlightConfiguration.java
View File

@ -122,7 +122,7 @@ public class FlightConfiguration implements FlightConfigurableParameter<FlightCo
* @param stageNumber stage number to inactivate
*/
public void clearStage(final int stageNumber) {
setStageActive( stageNumber, false, true);
setStageActive( stageNumber, false );
}
/**
@ -132,7 +132,7 @@ public class FlightConfiguration implements FlightConfigurableParameter<FlightCo
*/
public void setOnlyStage(final int stageNumber) {
setAllStages(false, false);
setStageActive(stageNumber, true, true);
setStageActive(stageNumber, true);
}
/**
@ -141,16 +141,9 @@ public class FlightConfiguration implements FlightConfigurableParameter<FlightCo
* @param stageNumber stage number to flag
* @param _active inactive (<code>false</code>) or active (<code>true</code>)
*/
public void setStageActive(final int stageNumber, final boolean _active ) {
this.setStageActive(stageNumber, _active, true );
}
private void setStageActive(final int stageNumber, final boolean _active, final boolean updateRequired ) {
private void setStageActive(final int stageNumber, final boolean _active ) {
if ((0 <= stageNumber) && (stages.containsKey(stageNumber))) {
stages.get(stageNumber).active = _active;
if( updateRequired ){
update();
}
return;
}
log.error("error: attempt to retrieve via a bad stage number: " + stageNumber);
@ -396,6 +389,7 @@ public class FlightConfiguration implements FlightConfigurableParameter<FlightCo
updateStages();
updateMotors();
}
/////////////// Helper methods ///////////////
/**

48
core/src/net/sf/openrocket/rocketcomponent/Rocket.java
View File

@ -423,6 +423,10 @@ public class Rocket extends RocketComponent {
try {
checkState();
{ // vvvv DEVEL vvvv
System.err.println("fireEvent@rocket.");
} // ^^^^ DEVEL ^^^^
// Update modification ID's only for normal (not undo/redo) events
if (!cce.isUndoChange()) {
modID = UniqueID.next();
@ -436,18 +440,6 @@ public class Rocket extends RocketComponent {
functionalModID = modID;
}
// Update modification ID's only for normal (not undo/redo) events
{ // vvvv DEVEL vvvv
// String changeString;
// if (cce.isUndoChange()) {
// changeString = "an 'undo' change from: "+cce.getSource().getName()+" as:"+cce.toString();
// }else{
// changeString = "a normal change from: "+cce.getSource().getName()+" as:"+cce.toString();
// }
//
// log.error("Processing a rocket change: "+changeString, new IllegalArgumentException());
} // ^^^^ DEVEL ^^^^
// Check whether frozen
if (freezeList != null) {
log.debug("Rocket is in frozen state, adding event " + cce + " info freeze list");
@ -461,19 +453,10 @@ public class Rocket extends RocketComponent {
iterator.next().componentChanged(cce);
}
// notify all configurations
this.update();
updateConfigurations();
notifyAllListeners(cce);
// Notify all listeners
// Copy the list before iterating to prevent concurrent modification exceptions.
EventListener[] list = listenerList.toArray(new EventListener[0]);
for (EventListener l : list) {
if (l instanceof ComponentChangeListener) {
((ComponentChangeListener) l).componentChanged(cce);
} else if (l instanceof StateChangeListener) {
((StateChangeListener) l).stateChanged(cce);
}
}
} finally {
mutex.unlock("fireComponentChangeEvent");
}
@ -481,12 +464,29 @@ public class Rocket extends RocketComponent {
@Override
public void update(){
updateConfigurations();
}
private void updateConfigurations(){
this.selectedConfiguration.update();
for( FlightConfiguration config : configSet.values() ){
config.update();
}
}
private void notifyAllListeners(final ComponentChangeEvent cce){
// Copy the list before iterating to prevent concurrent modification exceptions.
EventListener[] list = listenerList.toArray(new EventListener[0]);
for (EventListener l : list) {
if (l instanceof ComponentChangeListener) {
((ComponentChangeListener) l).componentChanged(cce);
} else if (l instanceof StateChangeListener) {
((StateChangeListener) l).stateChanged(cce);
}
}
}
/**
* Freezes the rocket structure from firing any events. This may be performed to
* combine several actions on the structure into a single large action.

2
core/src/net/sf/openrocket/rocketcomponent/RocketComponent.java
View File

@ -1747,7 +1747,7 @@ public abstract class RocketComponent implements ChangeSource, Cloneable, Iterab
* @param type Type of event
* @see #fireComponentChangeEvent(ComponentChangeEvent)
*/
protected void fireComponentChangeEvent(int type) {
public void fireComponentChangeEvent(int type) {
fireComponentChangeEvent(new ComponentChangeEvent(this, type));
}

37
swing/src/net/sf/openrocket/gui/components/StageSelector.java
View File

@ -12,29 +12,30 @@ import javax.swing.JToggleButton;
import net.miginfocom.swing.MigLayout;
import net.sf.openrocket.l10n.Translator;
import net.sf.openrocket.rocketcomponent.AxialStage;
import net.sf.openrocket.rocketcomponent.ComponentChangeEvent;
import net.sf.openrocket.rocketcomponent.FlightConfiguration;
import net.sf.openrocket.rocketcomponent.Rocket;
import net.sf.openrocket.startup.Application;
import net.sf.openrocket.util.StateChangeListener;
@SuppressWarnings("serial")
public class StageSelector extends JPanel implements StateChangeListener {
private static final long serialVersionUID = -2898763402479628711L;
private static final Translator trans = Application.getTranslator();
private final FlightConfiguration configuration;
private final Rocket rocket;
private List<JToggleButton> buttons = new ArrayList<JToggleButton>();
public StageSelector(FlightConfiguration configuration) {
public StageSelector(Rocket _rkt) {
super(new MigLayout("gap 0!"));
this.configuration = configuration;
updateButtons();
this.rocket = _rkt;
updateButtons( this.rocket.getSelectedConfiguration() );
}
private void updateButtons() {
private void updateButtons( final FlightConfiguration configuration ) {
int stages = configuration.getStageCount();
if (buttons.size() == stages)
return;
@ -44,6 +45,7 @@ public class StageSelector extends JPanel implements StateChangeListener {
for(AxialStage stage : configuration.getRocket().getStageList()){
int stageNum = stage.getStageNumber();
JToggleButton button = new JToggleButton(new StageAction(stageNum));
button.setSelected(true);
this.add(button);
buttons.add(button);
}
@ -51,20 +53,20 @@ public class StageSelector extends JPanel implements StateChangeListener {
this.revalidate();
}
@Override
public void stateChanged(EventObject e) {
updateButtons();
public void stateChanged(EventObject eo) {
Object source = eo.getSource();
if( source instanceof Rocket ){
Rocket rkt = (Rocket) eo.getSource();
updateButtons( rkt.getSelectedConfiguration() );
}
}
private class StageAction extends AbstractAction implements StateChangeListener {
private static final long serialVersionUID = 7433006728984943763L;
private class StageAction extends AbstractAction {
private final int stageNumber;
public StageAction(final int stage) {
this.stageNumber = stage;
stateChanged(null);
}
@Override
@ -78,12 +80,9 @@ public class StageSelector extends JPanel implements StateChangeListener {
@Override
public void actionPerformed(ActionEvent e) {
configuration.toggleStage(stageNumber);
rocket.getSelectedConfiguration().toggleStage(stageNumber);
rocket.fireComponentChangeEvent(ComponentChangeEvent.GRAPHIC_CHANGE);
}
@Override
public void stateChanged(EventObject e) {
this.putValue(SELECTED_KEY, configuration.isStageActive(stageNumber));
}
}
}

4
swing/src/net/sf/openrocket/gui/dialogs/ComponentAnalysisDialog.java
View File

@ -166,11 +166,11 @@ public class ComponentAnalysisDialog extends JDialog implements StateChangeListe
panel.add(new BasicSlider(roll.getSliderModel(-20 * 2 * Math.PI, 20 * 2 * Math.PI)),
"growx, wrap");
// Stage and motor selection:
//// Active stages:
panel.add(new JLabel(trans.get("componentanalysisdlg.lbl.activestages")), "spanx, split, gapafter rel");
panel.add(new StageSelector(configuration), "gapafter paragraph");
Rocket rkt = rocketPanel.getDocument().getRocket();
panel.add(new StageSelector( rkt), "gapafter paragraph");
//// Motor configuration:
JLabel label = new JLabel(trans.get("componentanalysisdlg.lbl.motorconf"));

2
swing/src/net/sf/openrocket/gui/main/RocketActions.java
View File

@ -664,6 +664,7 @@ public class RocketActions {
RocketComponent parent = selected.getParent();
document.addUndoPosition("Move "+selected.getComponentName());
parent.moveChild(selected, parent.getChildPosition(selected)-1);
rocket.fireComponentChangeEvent( ComponentChangeEvent.TREE_CHANGE );
selectionModel.setSelectedComponent(selected);
}
@ -709,6 +710,7 @@ public class RocketActions {
RocketComponent parent = selected.getParent();
document.addUndoPosition("Move "+selected.getComponentName());
parent.moveChild(selected, parent.getChildPosition(selected)+1);
rocket.fireComponentChangeEvent( ComponentChangeEvent.TREE_CHANGE );
selectionModel.setSelectedComponent(selected);
}

12
swing/src/net/sf/openrocket/gui/scalefigure/RocketPanel.java
View File

@ -146,6 +146,7 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
private List<EventListener> listeners = new ArrayList<EventListener>();
/**
* The executor service used for running the background simulations.
* This uses a fixed-sized thread pool for all background simulations
@ -167,6 +168,11 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
});
}
public OpenRocketDocument getDocument(){
return this.document;
}
public RocketPanel(OpenRocketDocument document) {
this.document = document;
Rocket rkt = document.getRocket();
@ -295,8 +301,9 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
add(scaleSelector);
// Stage selector
final FlightConfiguration configuration = document.getDefaultConfiguration();
StageSelector stageSelector = new StageSelector(configuration);
final Rocket rkt = document.getRocket();
StageSelector stageSelector = new StageSelector( rkt );
rkt.addChangeListener(stageSelector);
add(stageSelector);
// Flight configuration selector
@ -847,4 +854,5 @@ public class RocketPanel extends JPanel implements TreeSelectionListener, Change
// putValue(Action.SELECTED_KEY, figure.getType() == type && !is3d);
// }
// }
}