1 package net.sf.openrocket.rocketcomponent;
3 import java.util.ArrayDeque;
4 import java.util.Collection;
5 import java.util.Deque;
6 import java.util.EventListener;
7 import java.util.Iterator;
9 import java.util.NoSuchElementException;
11 import net.sf.openrocket.l10n.Translator;
12 import net.sf.openrocket.logging.LogHelper;
13 import net.sf.openrocket.preset.ComponentPreset;
14 import net.sf.openrocket.startup.Application;
15 import net.sf.openrocket.util.ArrayList;
16 import net.sf.openrocket.util.BugException;
17 import net.sf.openrocket.util.ChangeSource;
18 import net.sf.openrocket.util.Color;
19 import net.sf.openrocket.util.Coordinate;
20 import net.sf.openrocket.util.Invalidator;
21 import net.sf.openrocket.util.LineStyle;
22 import net.sf.openrocket.util.MathUtil;
23 import net.sf.openrocket.util.SafetyMutex;
24 import net.sf.openrocket.util.UniqueID;
27 public abstract class RocketComponent implements ChangeSource, Cloneable, Iterable<RocketComponent> {
28 private static final LogHelper log = Application.getLogger();
29 private static final Translator trans = Application.getTranslator();
32 * Text is suitable to the form
33 * Position relative to: <title>
35 public enum Position {
36 /** Position relative to the top of the parent component. */
37 //// Top of the parent component
38 TOP(trans.get("RocketComponent.Position.TOP")),
39 /** Position relative to the middle of the parent component. */
40 //// Middle of the parent component
41 MIDDLE(trans.get("RocketComponent.Position.MIDDLE")),
42 /** Position relative to the bottom of the parent component. */
43 //// Bottom of the parent component
44 BOTTOM(trans.get("RocketComponent.Position.BOTTOM")),
45 /** Position after the parent component (for body components). */
46 //// After the parent component
47 AFTER(trans.get("RocketComponent.Position.AFTER")),
48 /** Specify an absolute X-coordinate position. */
49 //// Tip of the nose cone
50 ABSOLUTE(trans.get("RocketComponent.Position.ABSOLUTE"));
54 Position(String title) {
59 public String toString() {
65 * A safety mutex that can be used to prevent concurrent access to this component.
67 protected SafetyMutex mutex = SafetyMutex.newInstance();
69 //////// Parent/child trees
71 * Parent component of the current component, or null if none exists.
73 private RocketComponent parent = null;
76 * List of child components of this component.
78 private ArrayList<RocketComponent> children = new ArrayList<RocketComponent>();
81 //////// Parameters common to all components:
84 * Characteristic length of the component. This is used in calculating the coordinate
85 * transformations and positions of other components in reference to this component.
86 * This may and should be used as the "true" length of the component, where applicable.
87 * By default it is zero, i.e. no translation.
89 protected double length = 0;
92 * Positioning of this component relative to the parent component.
94 protected Position relativePosition;
97 * Offset of the position of this component relative to the normal position given by
98 * relativePosition. By default zero, i.e. no position change.
100 protected double position = 0;
103 // Color of the component, null means to use the default color
104 private Color color = null;
105 private LineStyle lineStyle = null;
109 private double overrideMass = 0;
110 private boolean massOverriden = false;
111 private double overrideCGX = 0;
112 private boolean cgOverriden = false;
114 private boolean overrideSubcomponents = false;
117 // User-given name of the component
118 private String name = null;
120 // User-specified comment
121 private String comment = "";
123 // Unique ID of the component
124 private String id = null;
126 // Preset component this component is based upon
127 private ComponentPreset presetComponent = null;
131 * Used to invalidate the component after calling {@link #copyFrom(RocketComponent)}.
133 private Invalidator invalidator = new Invalidator(this);
136 //// NOTE !!! All fields must be copied in the method copyFrom()! ////
141 * Default constructor. Sets the name of the component to the component's static name
142 * and the relative position of the component.
144 public RocketComponent(Position relativePosition) {
145 // These must not fire any events, due to Rocket undo system initialization
146 this.name = getComponentName();
147 this.relativePosition = relativePosition;
151 //////////// Methods that must be implemented ////////////
155 * Static component name. The name may not vary of the parameters, it must be static.
157 public abstract String getComponentName(); // Static component type name
160 * Return the component mass (regardless of mass overriding).
162 public abstract double getComponentMass(); // Mass of non-overridden component
165 * Return the component CG and mass (regardless of CG or mass overriding).
167 public abstract Coordinate getComponentCG(); // CG of non-overridden component
171 * Return the longitudinal (around the y- or z-axis) unitary moment of inertia.
172 * The unitary moment of inertia is the moment of inertia with the assumption that
173 * the mass of the component is one kilogram. The inertia is measured in
174 * respect to the non-overridden CG.
176 * @return the longitudinal unitary moment of inertia of this component.
178 public abstract double getLongitudinalUnitInertia();
182 * Return the rotational (around the x-axis) unitary moment of inertia.
183 * The unitary moment of inertia is the moment of inertia with the assumption that
184 * the mass of the component is one kilogram. The inertia is measured in
185 * respect to the non-overridden CG.
187 * @return the rotational unitary moment of inertia of this component.
189 public abstract double getRotationalUnitInertia();
193 * Test whether this component allows any children components. This method must
194 * return true if and only if {@link #isCompatible(Class)} returns true for any
195 * rocket component class.
197 * @return <code>true</code> if children can be attached to this component, <code>false</code> otherwise.
199 public abstract boolean allowsChildren();
202 * Test whether the given component type can be added to this component. This type safety
203 * is enforced by the <code>addChild()</code> methods. The return value of this method
204 * may change to reflect the current state of this component (e.g. two components of some
205 * type cannot be placed as children).
207 * @param type The RocketComponent class type to add.
208 * @return Whether such a component can be added.
210 public abstract boolean isCompatible(Class<? extends RocketComponent> type);
213 /* Non-abstract helper method */
215 * Test whether the given component can be added to this component. This is equivalent
216 * to calling <code>isCompatible(c.getClass())</code>.
218 * @param c Component to test.
219 * @return Whether the component can be added.
220 * @see #isCompatible(Class)
222 public final boolean isCompatible(RocketComponent c) {
224 return isCompatible(c.getClass());
230 * Return a collection of bounding coordinates. The coordinates must be such that
231 * the component is fully enclosed in their convex hull.
233 * @return a collection of coordinates that bound the component.
235 public abstract Collection<Coordinate> getComponentBounds();
238 * Return true if the component may have an aerodynamic effect on the rocket.
240 public abstract boolean isAerodynamic();
243 * Return true if the component may have an effect on the rocket's mass.
245 public abstract boolean isMassive();
251 //////////// Methods that may be overridden ////////////
255 * Shift the coordinates in the array corresponding to radial movement. A component
256 * that has a radial position must shift the coordinates in this array suitably.
257 * If the component is clustered, then a new array must be returned with a
258 * coordinate for each cluster.
260 * The default implementation simply returns the array, and thus produces no shift.
262 * @param c an array of coordinates to shift.
263 * @return an array of shifted coordinates. The method may modify the contents
264 * of the passed array and return the array itself.
266 public Coordinate[] shiftCoordinates(Coordinate[] c) {
273 * Called when any component in the tree fires a ComponentChangeEvent. This is by
274 * default a no-op, but subclasses may override this method to e.g. invalidate
275 * cached data. The overriding method *must* call
276 * <code>super.componentChanged(e)</code> at some point.
278 * @param e The event fired
280 protected void componentChanged(ComponentChangeEvent e) {
289 * Return the user-provided name of the component, or the component base
290 * name if the user-provided name is empty. This can be used in the UI.
292 * @return A string describing the component.
295 public final String toString() {
297 if (name.length() == 0)
298 return getComponentName();
305 * Create a string describing the basic component structure from this component downwards.
306 * @return a string containing the rocket structure
308 public final String toDebugString() {
309 mutex.lock("toDebugString");
311 StringBuilder sb = new StringBuilder();
313 return sb.toString();
315 mutex.unlock("toDebugString");
319 private void toDebugString(StringBuilder sb) {
320 sb.append(this.getClass().getSimpleName()).append('@').append(System.identityHashCode(this));
321 sb.append("[\"").append(this.getName()).append('"');
322 for (RocketComponent c : this.children) {
331 * Make a deep copy of the rocket component tree structure from this component
332 * downwards for copying purposes. Each component in the copy will be assigned
333 * a new component ID, making it a safe copy. This method does not fire any events.
335 * @return A deep copy of the structure.
337 public final RocketComponent copy() {
338 RocketComponent clone = copyWithOriginalID();
340 Iterator<RocketComponent> iterator = clone.iterator(true);
341 while (iterator.hasNext()) {
342 iterator.next().newID();
350 * Make a deep copy of the rocket component tree structure from this component
351 * downwards while maintaining the component ID's. The purpose of this method is
352 * to allow copies to be created with the original ID's for the purpose of the
353 * undo/redo mechanism. This method should not be used for other purposes,
354 * such as copy/paste. This method does not fire any events.
356 * This method must be overridden by any component that refers to mutable objects,
357 * or if some fields should not be copied. This should be performed by
358 * <code>RocketComponent c = super.copyWithOriginalID();</code> and then cloning/modifying
359 * the appropriate fields.
361 * This is not performed as serializing/deserializing for performance reasons.
363 * @return A deep copy of the structure.
365 protected RocketComponent copyWithOriginalID() {
366 mutex.lock("copyWithOriginalID");
369 RocketComponent clone;
371 clone = (RocketComponent) this.clone();
372 } catch (CloneNotSupportedException e) {
373 throw new BugException("CloneNotSupportedException encountered, report a bug!", e);
377 clone.mutex = SafetyMutex.newInstance();
379 // Reset all parent/child information
381 clone.children = new ArrayList<RocketComponent>();
383 // Add copied children to the structure without firing events.
384 for (RocketComponent child : this.children) {
385 RocketComponent childCopy = child.copyWithOriginalID();
386 // Don't use add method since it fires events
387 clone.children.add(childCopy);
388 childCopy.parent = clone;
391 this.checkComponentStructure();
392 clone.checkComponentStructure();
396 mutex.unlock("copyWithOriginalID");
401 ////////////// Methods that may not be overridden ////////////
405 ////////// Common parameter setting/getting //////////
408 * Return the color of the object to use in 2D figures, or <code>null</code>
409 * to use the default color.
411 public final Color getColor() {
417 * Set the color of the object to use in 2D figures.
419 public final void setColor(Color c) {
420 if ((color == null && c == null) ||
421 (color != null && color.equals(c)))
426 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
430 public final LineStyle getLineStyle() {
435 public final void setLineStyle(LineStyle style) {
436 if (this.lineStyle == style)
439 this.lineStyle = style;
440 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
447 * Get the current override mass. The mass is not necessarily in use
450 * @return the override mass
452 public final double getOverrideMass() {
458 * Set the current override mass. The mass is not set to use by this
461 * @param m the override mass
463 public final void setOverrideMass(double m) {
464 if (MathUtil.equals(m, overrideMass))
467 overrideMass = Math.max(m, 0);
469 fireComponentChangeEvent(ComponentChangeEvent.MASS_CHANGE);
473 * Return whether mass override is active for this component. This does NOT
474 * take into account whether a parent component is overriding the mass.
476 * @return whether the mass is overridden
478 public final boolean isMassOverridden() {
480 return massOverriden;
484 * Set whether the mass is currently overridden.
486 * @param o whether the mass is overridden
488 public final void setMassOverridden(boolean o) {
489 if (massOverriden == o) {
494 fireComponentChangeEvent(ComponentChangeEvent.MASS_CHANGE);
502 * Return the current override CG. The CG is not necessarily overridden.
504 * @return the override CG
506 public final Coordinate getOverrideCG() {
508 return getComponentCG().setX(overrideCGX);
512 * Return the x-coordinate of the current override CG.
514 * @return the x-coordinate of the override CG.
516 public final double getOverrideCGX() {
522 * Set the current override CG to (x,0,0).
524 * @param x the x-coordinate of the override CG to set.
526 public final void setOverrideCGX(double x) {
527 if (MathUtil.equals(overrideCGX, x))
530 this.overrideCGX = x;
531 if (isCGOverridden())
532 fireComponentChangeEvent(ComponentChangeEvent.MASS_CHANGE);
534 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
538 * Return whether the CG is currently overridden.
540 * @return whether the CG is overridden
542 public final boolean isCGOverridden() {
548 * Set whether the CG is currently overridden.
550 * @param o whether the CG is overridden
552 public final void setCGOverridden(boolean o) {
553 if (cgOverriden == o) {
558 fireComponentChangeEvent(ComponentChangeEvent.MASS_CHANGE);
564 * Return whether the mass and/or CG override overrides all subcomponent values
565 * as well. The default implementation is a normal getter/setter implementation,
566 * however, subclasses are allowed to override this behavior if some subclass
567 * always or never overrides subcomponents. In this case the subclass should
568 * also override {@link #isOverrideSubcomponentsEnabled()} to return
569 * <code>false</code>.
571 * @return whether the current mass and/or CG override overrides subcomponents as well.
573 public boolean getOverrideSubcomponents() {
575 return overrideSubcomponents;
580 * Set whether the mass and/or CG override overrides all subcomponent values
581 * as well. See {@link #getOverrideSubcomponents()} for details.
583 * @param override whether the mass and/or CG override overrides all subcomponent.
585 public void setOverrideSubcomponents(boolean override) {
586 if (overrideSubcomponents == override) {
590 overrideSubcomponents = override;
591 fireComponentChangeEvent(ComponentChangeEvent.MASS_CHANGE);
595 * Return whether the option to override all subcomponents is enabled or not.
596 * The default implementation returns <code>false</code> if neither mass nor
597 * CG is overridden, <code>true</code> otherwise.
599 * This method may be overridden if the setting of overriding subcomponents
602 * @return whether the option to override subcomponents is currently enabled.
604 public boolean isOverrideSubcomponentsEnabled() {
606 return isCGOverridden() || isMassOverridden();
613 * Get the user-defined name of the component.
615 public final String getName() {
621 * Set the user-defined name of the component. If name==null, sets the name to
622 * the default name, currently the component name.
624 public final void setName(String name) {
625 if (this.name.equals(name)) {
629 if (name == null || name.matches("^\\s*$"))
630 this.name = getComponentName();
633 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
638 * Return the comment of the component. The component may contain multiple lines
639 * using \n as a newline separator.
641 * @return the comment of the component.
643 public final String getComment() {
649 * Set the comment of the component.
651 * @param comment the comment of the component.
653 public final void setComment(String comment) {
654 if (this.comment.equals(comment))
660 this.comment = comment;
661 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
667 * Return the preset component that this component is based upon.
669 * @return the preset component, or <code>null</code> if this is not based on a preset.
671 public final ComponentPreset getPresetComponent() {
672 return presetComponent;
676 * Return the most compatible preset type for this component.
677 * This method should be overridden by components which have presets
679 * @return the most compatible ComponentPreset.Type or <code>null</code> if no presets are compatible.
681 public ComponentPreset.Type getPresetType() {
686 * Set the preset component this component is based upon and load all of the
689 * @param preset the preset component to load, or <code>null</code> to clear the preset.
691 public final void loadPreset(ComponentPreset preset) {
692 if (presetComponent == preset) {
696 if (preset == null) {
701 // TODO - do we need to this compatibility check?
703 if (preset.getComponentClass() != this.getClass()) {
704 throw new IllegalArgumentException("Attempting to load preset of type " + preset.getComponentClass()
705 + " into component of type " + this.getClass());
709 RocketComponent root = getRoot();
711 if (root instanceof Rocket) {
712 rocket = (Rocket) root;
718 if (rocket != null) {
722 loadFromPreset(preset);
724 this.presetComponent = preset;
725 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
728 if (rocket != null) {
736 * Load component properties from the specified preset. The preset is guaranteed
737 * to be of the correct type.
739 * This method should fire the appropriate events related to the changes. The rocket
740 * is frozen by the caller, so the events will be automatically combined.
742 * This method must FIRST perform the preset loading and THEN call super.loadFromPreset().
743 * This is because mass setting requires the dimensions to be set beforehand.
745 * @param preset the preset to load from
747 protected void loadFromPreset(ComponentPreset preset) {
753 * Clear the current component preset. This does not affect the component properties
756 public final void clearPreset() {
757 if (presetComponent == null)
759 presetComponent = null;
760 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
766 * Returns the unique ID of the component.
768 * @return the ID of the component.
770 public final String getID() {
775 * Generate a new ID for this component.
777 private final void newID() {
779 this.id = UniqueID.uuid();
786 * Get the characteristic length of the component, for example the length of a body tube
787 * of the length of the root chord of a fin. This is used in positioning the component
788 * relative to its parent.
790 * If the length of a component is settable, the class must define the setter method
793 public final double getLength() {
799 * Get the positioning of the component relative to its parent component.
800 * This is one of the enums of {@link Position}. A setter method is not provided,
801 * but can be provided by a subclass.
803 public final Position getRelativePosition() {
805 return relativePosition;
810 * Set the positioning of the component relative to its parent component.
811 * The actual position of the component is maintained to the best ability.
813 * The default implementation is of protected visibility, since many components
814 * do not support setting the relative position. A component that does support
815 * it should override this with a public method that simply calls this
816 * supermethod AND fire a suitable ComponentChangeEvent.
818 * @param position the relative positioning.
820 protected void setRelativePosition(RocketComponent.Position position) {
821 if (this.relativePosition == position)
825 // Update position so as not to move the component
826 if (this.parent != null) {
827 double thisPos = this.toRelative(Coordinate.NUL, this.parent)[0].x;
831 this.position = this.toAbsolute(Coordinate.NUL)[0].x;
835 this.position = thisPos;
839 this.position = thisPos - (this.parent.length - this.length) / 2;
843 this.position = thisPos - (this.parent.length - this.length);
847 throw new BugException("Unknown position type: " + position);
851 this.relativePosition = position;
852 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
857 * Determine position relative to given position argument. Note: This is a side-effect free method. No state
860 * @param thePosition the relative position to be used as the basis for the computation
861 * @param relativeTo the position is computed relative the the given component
863 * @return double position of the component relative to the parent, with respect to <code>position</code>
865 public double asPositionValue(Position thePosition, RocketComponent relativeTo) {
866 double result = this.position;
867 if (relativeTo != null) {
868 double thisPos = this.toRelative(Coordinate.NUL, relativeTo)[0].x;
870 switch (thePosition) {
872 result = this.toAbsolute(Coordinate.NUL)[0].x;
878 result = thisPos - (relativeTo.length - this.length) / 2;
881 result = thisPos - (relativeTo.length - this.length);
884 throw new BugException("Unknown position type: " + thePosition);
891 * Get the position value of the component. The exact meaning of the value is
892 * dependent on the current relative positioning.
894 * @return the positional value.
896 public final double getPositionValue() {
903 * Set the position value of the component. The exact meaning of the value
904 * depends on the current relative positioning.
906 * The default implementation is of protected visibility, since many components
907 * do not support setting the relative position. A component that does support
908 * it should override this with a public method that simply calls this
909 * supermethod AND fire a suitable ComponentChangeEvent.
911 * @param value the position value of the component.
913 public void setPositionValue(double value) {
914 if (MathUtil.equals(this.position, value))
917 this.position = value;
922 /////////// Coordinate changes ///////////
925 * Returns coordinate c in absolute coordinates. Equivalent to toComponent(c,null).
927 public Coordinate[] toAbsolute(Coordinate c) {
929 return toRelative(c, null);
934 * Return coordinate <code>c</code> described in the coordinate system of
935 * <code>dest</code>. If <code>dest</code> is <code>null</code> returns
936 * absolute coordinates.
938 * This method returns an array of coordinates, each of which represents a
939 * position of the coordinate in clustered cases. The array is guaranteed
940 * to contain at least one element.
942 * The current implementation does not support rotating components.
944 * @param c Coordinate in the component's coordinate system.
945 * @param dest Destination component coordinate system.
946 * @return an array of coordinates describing <code>c</code> in coordinates
947 * relative to <code>dest</code>.
949 public final Coordinate[] toRelative(Coordinate c, RocketComponent dest) {
951 mutex.lock("toRelative");
953 double absoluteX = Double.NaN;
954 RocketComponent search = dest;
955 Coordinate[] array = new Coordinate[1];
958 RocketComponent component = this;
959 while ((component != search) && (component.parent != null)) {
961 array = component.shiftCoordinates(array);
963 switch (component.relativePosition) {
965 for (int i = 0; i < array.length; i++) {
966 array[i] = array[i].add(component.position, 0, 0);
971 for (int i = 0; i < array.length; i++) {
972 array[i] = array[i].add(component.position +
973 (component.parent.length - component.length) / 2, 0, 0);
978 for (int i = 0; i < array.length; i++) {
979 array[i] = array[i].add(component.position +
980 (component.parent.length - component.length), 0, 0);
985 // Add length of all previous brother-components with POSITION_RELATIVE_AFTER
986 int index = component.parent.children.indexOf(component);
988 for (index--; index >= 0; index--) {
989 RocketComponent comp = component.parent.children.get(index);
990 double componentLength = comp.getTotalLength();
991 for (int i = 0; i < array.length; i++) {
992 array[i] = array[i].add(componentLength, 0, 0);
995 for (int i = 0; i < array.length; i++) {
996 array[i] = array[i].add(component.position + component.parent.length, 0, 0);
1001 search = null; // Requires back-search if dest!=null
1002 if (Double.isNaN(absoluteX)) {
1003 absoluteX = component.position;
1008 throw new BugException("Unknown relative positioning type of component" +
1009 component + ": " + component.relativePosition);
1012 component = component.parent; // parent != null
1015 if (!Double.isNaN(absoluteX)) {
1016 for (int i = 0; i < array.length; i++) {
1017 array[i] = array[i].setX(absoluteX + c.x);
1021 // Check whether destination has been found or whether to backtrack
1022 // TODO: LOW: Backtracking into clustered components uses only one component
1023 if ((dest != null) && (component != dest)) {
1024 Coordinate[] origin = dest.toAbsolute(Coordinate.NUL);
1025 for (int i = 0; i < array.length; i++) {
1026 array[i] = array[i].sub(origin[0]);
1032 mutex.unlock("toRelative");
1038 * Recursively sum the lengths of all subcomponents that have position
1041 * @return Sum of the lengths.
1043 private final double getTotalLength() {
1045 this.checkComponentStructure();
1046 mutex.lock("getTotalLength");
1049 if (relativePosition == Position.AFTER)
1051 for (int i = 0; i < children.size(); i++)
1052 l += children.get(i).getTotalLength();
1055 mutex.unlock("getTotalLength");
1061 /////////// Total mass and CG calculation ////////////
1064 * Return the (possibly overridden) mass of component.
1066 * @return The mass of the component or the given override mass.
1068 public final double getMass() {
1071 return overrideMass;
1072 return getComponentMass();
1076 * Return the (possibly overridden) center of gravity and mass.
1078 * Returns the CG with the weight of the coordinate set to the weight of the component.
1079 * Both CG and mass may be separately overridden.
1081 * @return The CG of the component or the given override CG.
1083 public final Coordinate getCG() {
1086 return getOverrideCG().setWeight(getMass());
1089 return getComponentCG().setWeight(getMass());
1091 return getComponentCG();
1096 * Return the longitudinal (around the y- or z-axis) moment of inertia of this component.
1097 * The moment of inertia is scaled in reference to the (possibly overridden) mass
1098 * and is relative to the non-overridden CG.
1100 * @return the longitudinal moment of inertia of this component.
1102 public final double getLongitudinalInertia() {
1104 return getLongitudinalUnitInertia() * getMass();
1108 * Return the rotational (around the y- or z-axis) moment of inertia of this component.
1109 * The moment of inertia is scaled in reference to the (possibly overridden) mass
1110 * and is relative to the non-overridden CG.
1112 * @return the rotational moment of inertia of this component.
1114 public final double getRotationalInertia() {
1116 return getRotationalUnitInertia() * getMass();
1121 /////////// Children handling ///////////
1125 * Adds a child to the rocket component tree. The component is added to the end
1126 * of the component's child list. This is a helper method that calls
1127 * {@link #addChild(RocketComponent,int)}.
1129 * @param component The component to add.
1130 * @throws IllegalArgumentException if the component is already part of some
1132 * @see #addChild(RocketComponent,int)
1134 public final void addChild(RocketComponent component) {
1136 addChild(component, children.size());
1141 * Adds a child to the rocket component tree. The component is added to
1142 * the given position of the component's child list.
1144 * This method may be overridden to enforce more strict component addition rules.
1145 * The tests should be performed first and then this method called.
1147 * @param component The component to add.
1148 * @param index Position to add component to.
1149 * @throws IllegalArgumentException If the component is already part of
1150 * some component tree.
1152 public void addChild(RocketComponent component, int index) {
1155 if (component.parent != null) {
1156 throw new IllegalArgumentException("component " + component.getComponentName() +
1157 " is already in a tree");
1160 // Ensure that the no loops are created in component tree [A -> X -> Y -> B, B.addChild(A)]
1161 if (this.getRoot().equals(component)) {
1162 throw new IllegalStateException("Component " + component.getComponentName() +
1163 " is a parent of " + this.getComponentName() + ", attempting to create cycle in tree.");
1166 if (!isCompatible(component)) {
1167 throw new IllegalStateException("Component " + component.getComponentName() +
1168 " not currently compatible with component " + getComponentName());
1171 children.add(index, component);
1172 component.parent = this;
1174 this.checkComponentStructure();
1175 component.checkComponentStructure();
1177 fireAddRemoveEvent(component);
1181 * Removes a child from the rocket component tree.
1183 * @param n remove the n'th child.
1184 * @throws IndexOutOfBoundsException if n is out of bounds
1186 public final void removeChild(int n) {
1188 RocketComponent component = children.remove(n);
1189 component.parent = null;
1191 this.checkComponentStructure();
1192 component.checkComponentStructure();
1194 fireAddRemoveEvent(component);
1198 * Removes a child from the rocket component tree. Does nothing if the component
1199 * is not present as a child.
1201 * @param component the component to remove
1202 * @return whether the component was a child
1204 public final boolean removeChild(RocketComponent component) {
1207 component.checkComponentStructure();
1209 if (children.remove(component)) {
1210 component.parent = null;
1212 this.checkComponentStructure();
1213 component.checkComponentStructure();
1215 fireAddRemoveEvent(component);
1225 * Move a child to another position.
1227 * @param component the component to move
1228 * @param index the component's new position
1229 * @throws IllegalArgumentException If an illegal placement was attempted.
1231 public final void moveChild(RocketComponent component, int index) {
1233 if (children.remove(component)) {
1234 children.add(index, component);
1236 this.checkComponentStructure();
1237 component.checkComponentStructure();
1239 fireAddRemoveEvent(component);
1245 * Fires an AERODYNAMIC_CHANGE, MASS_CHANGE or OTHER_CHANGE event depending on the
1246 * type of component removed.
1248 private void fireAddRemoveEvent(RocketComponent component) {
1249 Iterator<RocketComponent> iter = component.iterator(true);
1250 int type = ComponentChangeEvent.TREE_CHANGE;
1251 while (iter.hasNext()) {
1252 RocketComponent c = iter.next();
1253 if (c.isAerodynamic())
1254 type |= ComponentChangeEvent.AERODYNAMIC_CHANGE;
1256 type |= ComponentChangeEvent.MASS_CHANGE;
1259 fireComponentChangeEvent(type);
1263 public final int getChildCount() {
1265 this.checkComponentStructure();
1266 return children.size();
1269 public final RocketComponent getChild(int n) {
1271 this.checkComponentStructure();
1272 return children.get(n);
1275 public final List<RocketComponent> getChildren() {
1277 this.checkComponentStructure();
1278 return children.clone();
1283 * Returns the position of the child in this components child list, or -1 if the
1284 * component is not a child of this component.
1286 * @param child The child to search for.
1287 * @return Position in the list or -1 if not found.
1289 public final int getChildPosition(RocketComponent child) {
1291 this.checkComponentStructure();
1292 return children.indexOf(child);
1296 * Get the parent component of this component. Returns <code>null</code> if the component
1299 * @return The parent of this component or <code>null</code>.
1301 public final RocketComponent getParent() {
1307 * Get the root component of the component tree.
1309 * @return The root component of the component tree.
1311 public final RocketComponent getRoot() {
1313 RocketComponent gp = this;
1314 while (gp.parent != null)
1320 * Returns the root Rocket component of this component tree. Throws an
1321 * IllegalStateException if the root component is not a Rocket.
1323 * @return The root Rocket component of the component tree.
1324 * @throws IllegalStateException If the root component is not a Rocket.
1326 public final Rocket getRocket() {
1328 RocketComponent r = getRoot();
1329 if (r instanceof Rocket)
1331 throw new IllegalStateException("getRocket() called with root component "
1332 + r.getComponentName());
1337 * Return the Stage component that this component belongs to. Throws an
1338 * IllegalStateException if a Stage is not in the parentage of this component.
1340 * @return The Stage component this component belongs to.
1341 * @throws IllegalStateException if a Stage component is not in the parentage.
1343 public final Stage getStage() {
1345 RocketComponent c = this;
1347 if (c instanceof Stage)
1351 throw new IllegalStateException("getStage() called without Stage as a parent.");
1355 * Return the stage number of the stage this component belongs to. The stages
1356 * are numbered from zero upwards.
1358 * @return the stage number this component belongs to.
1360 public final int getStageNumber() {
1362 if (parent == null) {
1363 throw new IllegalArgumentException("getStageNumber() called for root component");
1366 RocketComponent stage = this;
1367 while (!(stage instanceof Stage)) {
1368 stage = stage.parent;
1369 if (stage == null || stage.parent == null) {
1370 throw new IllegalStateException("getStageNumber() could not find parent " +
1374 return stage.parent.getChildPosition(stage);
1379 * Find a component with the given ID. The component tree is searched from this component
1380 * down (including this component) for the ID and the corresponding component is returned,
1381 * or null if not found.
1383 * @param idToFind ID to search for.
1384 * @return The component with the ID, or null if not found.
1386 public final RocketComponent findComponent(String idToFind) {
1388 Iterator<RocketComponent> iter = this.iterator(true);
1389 while (iter.hasNext()) {
1390 RocketComponent c = iter.next();
1391 if (c.getID().equals(idToFind))
1398 // TODO: Move these methods elsewhere (used only in SymmetricComponent)
1399 public final RocketComponent getPreviousComponent() {
1401 this.checkComponentStructure();
1404 int pos = parent.getChildPosition(this);
1406 StringBuffer sb = new StringBuffer();
1407 sb.append("Inconsistent internal state: ");
1408 sb.append("this=").append(this).append('[')
1409 .append(System.identityHashCode(this)).append(']');
1410 sb.append(" parent.children=[");
1411 for (int i = 0; i < parent.children.size(); i++) {
1412 RocketComponent c = parent.children.get(i);
1413 sb.append(c).append('[').append(System.identityHashCode(c)).append(']');
1414 if (i < parent.children.size() - 1)
1418 throw new IllegalStateException(sb.toString());
1423 RocketComponent c = parent.getChild(pos - 1);
1424 while (c.getChildCount() > 0)
1425 c = c.getChild(c.getChildCount() - 1);
1429 // TODO: Move these methods elsewhere (used only in SymmetricComponent)
1430 public final RocketComponent getNextComponent() {
1432 if (getChildCount() > 0)
1435 RocketComponent current = this;
1436 RocketComponent nextParent = this.parent;
1438 while (nextParent != null) {
1439 int pos = nextParent.getChildPosition(current);
1440 if (pos < nextParent.getChildCount() - 1)
1441 return nextParent.getChild(pos + 1);
1443 current = nextParent;
1444 nextParent = current.parent;
1450 /////////// Event handling //////////
1452 // Listener lists are provided by the root Rocket component,
1453 // a single listener list for the whole rocket.
1457 * Adds a ComponentChangeListener to the rocket tree. The listener is added to the root
1458 * component, which must be of type Rocket (which overrides this method). Events of all
1459 * subcomponents are sent to all listeners.
1461 * @throws IllegalStateException - if the root component is not a Rocket
1463 public void addComponentChangeListener(ComponentChangeListener l) {
1465 getRocket().addComponentChangeListener(l);
1469 * Removes a ComponentChangeListener from the rocket tree. The listener is removed from
1470 * the root component, which must be of type Rocket (which overrides this method).
1471 * Does nothing if the root component is not a Rocket. (The asymmetry is so
1472 * that listeners can always be removed just in case.)
1474 * @param l Listener to remove
1476 public void removeComponentChangeListener(ComponentChangeListener l) {
1477 if (parent != null) {
1478 getRoot().removeComponentChangeListener(l);
1484 * Adds a <code>ChangeListener</code> to the rocket tree. This is identical to
1485 * <code>addComponentChangeListener()</code> except that it uses a
1486 * <code>ChangeListener</code>. The same events are dispatched to the
1487 * <code>ChangeListener</code>, as <code>ComponentChangeEvent</code> is a subclass
1488 * of <code>ChangeEvent</code>.
1490 * @throws IllegalStateException - if the root component is not a <code>Rocket</code>
1493 public void addChangeListener(EventListener l) {
1495 getRocket().addChangeListener(l);
1499 * Removes a ChangeListener from the rocket tree. This is identical to
1500 * removeComponentChangeListener() except it uses a ChangeListener.
1501 * Does nothing if the root component is not a Rocket. (The asymmetry is so
1502 * that listeners can always be removed just in case.)
1504 * @param l Listener to remove
1507 public void removeChangeListener(EventListener l) {
1508 if (this.parent != null) {
1509 getRoot().removeChangeListener(l);
1515 * Fires a ComponentChangeEvent on the rocket structure. The call is passed to the
1516 * root component, which must be of type Rocket (which overrides this method).
1517 * Events of all subcomponents are sent to all listeners.
1519 * If the component tree root is not a Rocket, the event is ignored. This is the
1520 * case when constructing components not in any Rocket tree. In this case it
1521 * would be impossible for the component to have listeners in any case.
1523 * @param e Event to send
1525 protected void fireComponentChangeEvent(ComponentChangeEvent e) {
1527 if (parent == null) {
1528 /* Ignore if root invalid. */
1529 log.debug("Attempted firing event " + e + " with root " + this.getComponentName() + ", ignoring event");
1532 getRoot().fireComponentChangeEvent(e);
1537 * Fires a ComponentChangeEvent of the given type. The source of the event is set to
1540 * @param type Type of event
1541 * @see #fireComponentChangeEvent(ComponentChangeEvent)
1543 protected void fireComponentChangeEvent(int type) {
1544 fireComponentChangeEvent(new ComponentChangeEvent(this, type));
1549 * Checks whether this component has been invalidated and should no longer be used.
1550 * This is a safety check that in-place replaced components are no longer used.
1551 * All non-trivial methods (with the exception of methods simply getting a property)
1552 * should call this method before changing or computing anything.
1554 * @throws BugException if this component has been invalidated by {@link #copyFrom(RocketComponent)}.
1556 protected void checkState() {
1557 invalidator.check(true);
1563 * Check that the local component structure is correct. This can be called after changing
1564 * the component structure in order to verify the integrity.
1566 * TODO: Remove this after the "inconsistent internal state" bug has been corrected
1568 public void checkComponentStructure() {
1569 if (this.parent != null) {
1570 // Test that this component is found in parent's children with == operator
1571 if (!containsExact(this.parent.children, this)) {
1572 throw new BugException("Inconsistent component structure detected, parent does not contain this " +
1573 "component as a child, parent=" + parent.toDebugString() + " this=" + this.toDebugString());
1576 for (RocketComponent child : this.children) {
1577 if (child.parent != this) {
1578 throw new BugException("Inconsistent component structure detected, child does not have this component " +
1579 "as the parent, this=" + this.toDebugString() + " child=" + child.toDebugString() +
1580 " child.parent=" + (child.parent == null ? "null" : child.parent.toDebugString()));
1585 // Check whether the list contains exactly the searched-for component (with == operator)
1586 private boolean containsExact(List<RocketComponent> haystack, RocketComponent needle) {
1587 for (RocketComponent c : haystack) {
1596 /////////// Iterators //////////
1599 * Returns an iterator that iterates over all children and sub-children.
1601 * The iterator iterates through all children below this object, including itself if
1602 * <code>returnSelf</code> is true. The order of the iteration is not specified
1603 * (it may be specified in the future).
1605 * If an iterator iterating over only the direct children of the component is required,
1606 * use <code>component.getChildren().iterator()</code>.
1608 * TODO: HIGH: Remove this after merges have been done
1610 * @param returnSelf boolean value specifying whether the component itself should be
1612 * @return An iterator for the children and sub-children.
1613 * @deprecated Use {@link #iterator(boolean)} instead
1616 public final Iterator<RocketComponent> deepIterator(boolean returnSelf) {
1617 return iterator(returnSelf);
1622 * Returns an iterator that iterates over all children and sub-children, including itself.
1624 * This method is equivalent to <code>deepIterator(true)</code>.
1626 * TODO: HIGH: Remove this after merges have been done
1628 * @return An iterator for this component, its children and sub-children.
1629 * @deprecated Use {@link #iterator()} instead
1632 public final Iterator<RocketComponent> deepIterator() {
1639 * Returns an iterator that iterates over all children and sub-children.
1641 * The iterator iterates through all children below this object, including itself if
1642 * <code>returnSelf</code> is true. The order of the iteration is not specified
1643 * (it may be specified in the future).
1645 * If an iterator iterating over only the direct children of the component is required,
1646 * use <code>component.getChildren().iterator()</code>.
1648 * @param returnSelf boolean value specifying whether the component itself should be
1650 * @return An iterator for the children and sub-children.
1652 public final Iterator<RocketComponent> iterator(boolean returnSelf) {
1654 return new RocketComponentIterator(this, returnSelf);
1659 * Returns an iterator that iterates over this component, its children and sub-children.
1661 * This method is equivalent to <code>iterator(true)</code>.
1663 * @return An iterator for this component, its children and sub-children.
1666 public final Iterator<RocketComponent> iterator() {
1667 return iterator(true);
1675 * Compare component equality based on the ID of this component. Only the
1676 * ID and class type is used for a basis of comparison.
1679 public boolean equals(Object obj) {
1684 if (this.getClass() != obj.getClass())
1686 RocketComponent other = (RocketComponent) obj;
1687 return this.id.equals(other.id);
1693 public int hashCode() {
1694 return id.hashCode();
1699 //////////// Helper methods for subclasses
1705 * Helper method to add rotationally symmetric bounds at the specified coordinates.
1706 * The X-axis value is <code>x</code> and the radius at the specified position is
1709 protected static final void addBound(Collection<Coordinate> bounds, double x, double r) {
1710 bounds.add(new Coordinate(x, -r, -r));
1711 bounds.add(new Coordinate(x, r, -r));
1712 bounds.add(new Coordinate(x, r, r));
1713 bounds.add(new Coordinate(x, -r, r));
1717 protected static final Coordinate ringCG(double outerRadius, double innerRadius,
1718 double x1, double x2, double density) {
1719 return new Coordinate((x1 + x2) / 2, 0, 0,
1720 ringMass(outerRadius, innerRadius, x2 - x1, density));
1723 protected static final double ringMass(double outerRadius, double innerRadius,
1724 double length, double density) {
1725 return Math.PI * (MathUtil.pow2(outerRadius) - MathUtil.pow2(innerRadius)) *
1729 protected static final double ringLongitudinalUnitInertia(double outerRadius,
1730 double innerRadius, double length) {
1731 // 1/12 * (3 * (r1^2 + r2^2) + h^2)
1732 return (3 * (MathUtil.pow2(innerRadius) + MathUtil.pow2(outerRadius)) + MathUtil.pow2(length)) / 12;
1735 protected static final double ringRotationalUnitInertia(double outerRadius,
1736 double innerRadius) {
1737 // 1/2 * (r1^2 + r2^2)
1738 return (MathUtil.pow2(innerRadius) + MathUtil.pow2(outerRadius)) / 2;
1747 * Loads the RocketComponent fields from the given component. This method is meant
1748 * for in-place replacement of a component. It is used with the undo/redo
1749 * mechanism and when converting a finset into a freeform fin set.
1750 * This component must not have a parent, otherwise this method will fail.
1752 * The child components in the source tree are copied into the current tree, however,
1753 * the original components should not be used since they represent old copies of the
1754 * components. It is recommended to invalidate them by calling {@link #invalidate()}.
1756 * This method returns a list of components that should be invalidated after references
1757 * to them have been removed (for example by firing appropriate events). The list contains
1758 * all children and sub-children of the current component and the entire component
1759 * tree of <code>src</code>.
1761 * @return a list of components that should not be used after this call.
1763 protected List<RocketComponent> copyFrom(RocketComponent src) {
1765 List<RocketComponent> toInvalidate = new ArrayList<RocketComponent>();
1767 if (this.parent != null) {
1768 throw new UnsupportedOperationException("copyFrom called for non-root component, parent=" +
1769 this.parent.toDebugString() + ", this=" + this.toDebugString());
1772 // Add current structure to be invalidated
1773 Iterator<RocketComponent> iterator = this.iterator(false);
1774 while (iterator.hasNext()) {
1775 toInvalidate.add(iterator.next());
1778 // Remove previous components
1779 for (RocketComponent child : this.children) {
1780 child.parent = null;
1782 this.children.clear();
1784 // Copy new children to this component
1785 for (RocketComponent c : src.children) {
1786 RocketComponent copy = c.copyWithOriginalID();
1787 this.children.add(copy);
1791 this.checkComponentStructure();
1792 src.checkComponentStructure();
1794 // Set all parameters
1795 this.length = src.length;
1796 this.relativePosition = src.relativePosition;
1797 this.position = src.position;
1798 this.color = src.color;
1799 this.lineStyle = src.lineStyle;
1800 this.overrideMass = src.overrideMass;
1801 this.massOverriden = src.massOverriden;
1802 this.overrideCGX = src.overrideCGX;
1803 this.cgOverriden = src.cgOverriden;
1804 this.overrideSubcomponents = src.overrideSubcomponents;
1805 this.name = src.name;
1806 this.comment = src.comment;
1809 // Add source components to invalidation tree
1810 for (RocketComponent c : src) {
1811 toInvalidate.add(c);
1814 return toInvalidate;
1817 protected void invalidate() {
1818 invalidator.invalidate();
1822 ////////// Iterator implementation ///////////
1825 * Private inner class to implement the Iterator.
1827 * This iterator is fail-fast if the root of the structure is a Rocket.
1829 private static class RocketComponentIterator implements Iterator<RocketComponent> {
1830 // Stack holds iterators which still have some components left.
1831 private final Deque<Iterator<RocketComponent>> iteratorStack = new ArrayDeque<Iterator<RocketComponent>>();
1833 private final Rocket root;
1834 private final int treeModID;
1836 private final RocketComponent original;
1837 private boolean returnSelf = false;
1839 // Construct iterator with component's child's iterator, if it has elements
1840 public RocketComponentIterator(RocketComponent c, boolean returnSelf) {
1842 RocketComponent gp = c.getRoot();
1843 if (gp instanceof Rocket) {
1845 treeModID = root.getTreeModID();
1851 Iterator<RocketComponent> i = c.children.iterator();
1853 iteratorStack.push(i);
1856 this.returnSelf = returnSelf;
1860 public boolean hasNext() {
1864 return !iteratorStack.isEmpty(); // Elements remain if stack is not empty
1868 public RocketComponent next() {
1869 Iterator<RocketComponent> i;
1873 // Return original component first
1879 // Peek first iterator from stack, throw exception if empty
1880 i = iteratorStack.peek();
1882 throw new NoSuchElementException("No further elements in RocketComponent iterator");
1885 // Retrieve next component of the iterator, remove iterator from stack if empty
1886 RocketComponent c = i.next();
1888 iteratorStack.pop();
1890 // Add iterator of component children to stack if it has children
1891 i = c.children.iterator();
1893 iteratorStack.push(i);
1898 private void checkID() {
1900 if (root.getTreeModID() != treeModID) {
1901 throw new IllegalStateException("Rocket modified while being iterated");
1907 public void remove() {
1908 throw new UnsupportedOperationException("remove() not supported by " +
1909 "RocketComponent iterator");