1 package net.sf.openrocket.rocketcomponent;
3 import net.sf.openrocket.l10n.Translator;
4 import net.sf.openrocket.logging.LogHelper;
5 import net.sf.openrocket.preset.ComponentPreset;
6 import net.sf.openrocket.startup.Application;
7 import net.sf.openrocket.util.ArrayList;
8 import net.sf.openrocket.util.BugException;
9 import net.sf.openrocket.util.ChangeSource;
10 import net.sf.openrocket.util.Coordinate;
11 import net.sf.openrocket.util.Invalidator;
12 import net.sf.openrocket.util.LineStyle;
13 import net.sf.openrocket.util.MathUtil;
14 import net.sf.openrocket.util.SafetyMutex;
15 import net.sf.openrocket.util.UniqueID;
17 import javax.swing.event.ChangeListener;
19 import java.util.ArrayDeque;
20 import java.util.Collection;
21 import java.util.Deque;
22 import java.util.Iterator;
23 import java.util.List;
24 import java.util.NoSuchElementException;
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 * Set the preset component this component is based upon and load all of the
679 * @param preset the preset component to load, or <code>null</code> to clear the preset.
681 public final void loadPreset(ComponentPreset preset) {
682 if (presetComponent == preset) {
686 if (preset == null) {
691 if (preset.getComponentClass() != this.getClass()) {
692 throw new IllegalArgumentException("Attempting to load preset of type " + preset.getComponentClass()
693 + " into component of type " + this.getClass());
696 RocketComponent root = getRoot();
698 if (root instanceof Rocket) {
699 rocket = (Rocket) root;
705 if (rocket != null) {
709 loadFromPreset(preset.getPrototype());
711 this.presetComponent = preset;
712 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
715 if (rocket != null) {
723 * Load component properties from the specified preset. The preset is guaranteed
724 * to be of the correct type.
726 * This method should fire the appropriate events related to the changes. The rocket
727 * is frozen by the caller, so the events will be automatically combined.
729 * This method must FIRST perform the preset loading and THEN call super.loadFromPreset().
730 * This is because mass setting requires the dimensions to be set beforehand.
732 * @param preset the preset to load from
734 protected void loadFromPreset(RocketComponent preset) {
740 * Clear the current component preset. This does not affect the component properties
743 public final void clearPreset() {
744 if (presetComponent == null)
746 presetComponent = null;
747 fireComponentChangeEvent(ComponentChangeEvent.NONFUNCTIONAL_CHANGE);
753 * Returns the unique ID of the component.
755 * @return the ID of the component.
757 public final String getID() {
762 * Generate a new ID for this component.
764 private final void newID() {
766 this.id = UniqueID.uuid();
773 * Get the characteristic length of the component, for example the length of a body tube
774 * of the length of the root chord of a fin. This is used in positioning the component
775 * relative to its parent.
777 * If the length of a component is settable, the class must define the setter method
780 public final double getLength() {
786 * Get the positioning of the component relative to its parent component.
787 * This is one of the enums of {@link Position}. A setter method is not provided,
788 * but can be provided by a subclass.
790 public final Position getRelativePosition() {
792 return relativePosition;
797 * Set the positioning of the component relative to its parent component.
798 * The actual position of the component is maintained to the best ability.
800 * The default implementation is of protected visibility, since many components
801 * do not support setting the relative position. A component that does support
802 * it should override this with a public method that simply calls this
803 * supermethod AND fire a suitable ComponentChangeEvent.
805 * @param position the relative positioning.
807 protected void setRelativePosition(RocketComponent.Position position) {
808 if (this.relativePosition == position)
812 // Update position so as not to move the component
813 if (this.parent != null) {
814 double thisPos = this.toRelative(Coordinate.NUL, this.parent)[0].x;
818 this.position = this.toAbsolute(Coordinate.NUL)[0].x;
822 this.position = thisPos;
826 this.position = thisPos - (this.parent.length - this.length) / 2;
830 this.position = thisPos - (this.parent.length - this.length);
834 throw new BugException("Unknown position type: " + position);
838 this.relativePosition = position;
839 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
844 * Determine position relative to given position argument. Note: This is a side-effect free method. No state
847 * @param thePosition the relative position to be used as the basis for the computation
848 * @param relativeTo the position is computed relative the the given component
850 * @return double position of the component relative to the parent, with respect to <code>position</code>
852 public double asPositionValue (Position thePosition, RocketComponent relativeTo) {
853 double result = this.position;
854 if (relativeTo != null) {
855 double thisPos = this.toRelative(Coordinate.NUL, relativeTo)[0].x;
857 switch (thePosition) {
859 result = this.toAbsolute(Coordinate.NUL)[0].x;
865 result = thisPos - (relativeTo.length - this.length) / 2;
868 result = thisPos - (relativeTo.length - this.length);
871 throw new BugException("Unknown position type: " + thePosition);
878 * Get the position value of the component. The exact meaning of the value is
879 * dependent on the current relative positioning.
881 * @return the positional value.
883 public final double getPositionValue() {
890 * Set the position value of the component. The exact meaning of the value
891 * depends on the current relative positioning.
893 * The default implementation is of protected visibility, since many components
894 * do not support setting the relative position. A component that does support
895 * it should override this with a public method that simply calls this
896 * supermethod AND fire a suitable ComponentChangeEvent.
898 * @param value the position value of the component.
900 public void setPositionValue(double value) {
901 if (MathUtil.equals(this.position, value))
904 this.position = value;
909 /////////// Coordinate changes ///////////
912 * Returns coordinate c in absolute coordinates. Equivalent to toComponent(c,null).
914 public Coordinate[] toAbsolute(Coordinate c) {
916 return toRelative(c, null);
921 * Return coordinate <code>c</code> described in the coordinate system of
922 * <code>dest</code>. If <code>dest</code> is <code>null</code> returns
923 * absolute coordinates.
925 * This method returns an array of coordinates, each of which represents a
926 * position of the coordinate in clustered cases. The array is guaranteed
927 * to contain at least one element.
929 * The current implementation does not support rotating components.
931 * @param c Coordinate in the component's coordinate system.
932 * @param dest Destination component coordinate system.
933 * @return an array of coordinates describing <code>c</code> in coordinates
934 * relative to <code>dest</code>.
936 public final Coordinate[] toRelative(Coordinate c, RocketComponent dest) {
938 mutex.lock("toRelative");
940 double absoluteX = Double.NaN;
941 RocketComponent search = dest;
942 Coordinate[] array = new Coordinate[1];
945 RocketComponent component = this;
946 while ((component != search) && (component.parent != null)) {
948 array = component.shiftCoordinates(array);
950 switch (component.relativePosition) {
952 for (int i = 0; i < array.length; i++) {
953 array[i] = array[i].add(component.position, 0, 0);
958 for (int i = 0; i < array.length; i++) {
959 array[i] = array[i].add(component.position +
960 (component.parent.length - component.length) / 2, 0, 0);
965 for (int i = 0; i < array.length; i++) {
966 array[i] = array[i].add(component.position +
967 (component.parent.length - component.length), 0, 0);
972 // Add length of all previous brother-components with POSITION_RELATIVE_AFTER
973 int index = component.parent.children.indexOf(component);
975 for (index--; index >= 0; index--) {
976 RocketComponent comp = component.parent.children.get(index);
977 double componentLength = comp.getTotalLength();
978 for (int i = 0; i < array.length; i++) {
979 array[i] = array[i].add(componentLength, 0, 0);
982 for (int i = 0; i < array.length; i++) {
983 array[i] = array[i].add(component.position + component.parent.length, 0, 0);
988 search = null; // Requires back-search if dest!=null
989 if (Double.isNaN(absoluteX)) {
990 absoluteX = component.position;
995 throw new BugException("Unknown relative positioning type of component" +
996 component + ": " + component.relativePosition);
999 component = component.parent; // parent != null
1002 if (!Double.isNaN(absoluteX)) {
1003 for (int i = 0; i < array.length; i++) {
1004 array[i] = array[i].setX(absoluteX + c.x);
1008 // Check whether destination has been found or whether to backtrack
1009 // TODO: LOW: Backtracking into clustered components uses only one component
1010 if ((dest != null) && (component != dest)) {
1011 Coordinate[] origin = dest.toAbsolute(Coordinate.NUL);
1012 for (int i = 0; i < array.length; i++) {
1013 array[i] = array[i].sub(origin[0]);
1019 mutex.unlock("toRelative");
1025 * Recursively sum the lengths of all subcomponents that have position
1028 * @return Sum of the lengths.
1030 private final double getTotalLength() {
1032 this.checkComponentStructure();
1033 mutex.lock("getTotalLength");
1036 if (relativePosition == Position.AFTER)
1038 for (int i = 0; i < children.size(); i++)
1039 l += children.get(i).getTotalLength();
1042 mutex.unlock("getTotalLength");
1048 /////////// Total mass and CG calculation ////////////
1051 * Return the (possibly overridden) mass of component.
1053 * @return The mass of the component or the given override mass.
1055 public final double getMass() {
1058 return overrideMass;
1059 return getComponentMass();
1063 * Return the (possibly overridden) center of gravity and mass.
1065 * Returns the CG with the weight of the coordinate set to the weight of the component.
1066 * Both CG and mass may be separately overridden.
1068 * @return The CG of the component or the given override CG.
1070 public final Coordinate getCG() {
1073 return getOverrideCG().setWeight(getMass());
1076 return getComponentCG().setWeight(getMass());
1078 return getComponentCG();
1083 * Return the longitudinal (around the y- or z-axis) moment of inertia of this component.
1084 * The moment of inertia is scaled in reference to the (possibly overridden) mass
1085 * and is relative to the non-overridden CG.
1087 * @return the longitudinal moment of inertia of this component.
1089 public final double getLongitudinalInertia() {
1091 return getLongitudinalUnitInertia() * getMass();
1095 * Return the rotational (around the y- or z-axis) moment of inertia of this component.
1096 * The moment of inertia is scaled in reference to the (possibly overridden) mass
1097 * and is relative to the non-overridden CG.
1099 * @return the rotational moment of inertia of this component.
1101 public final double getRotationalInertia() {
1103 return getRotationalUnitInertia() * getMass();
1108 /////////// Children handling ///////////
1112 * Adds a child to the rocket component tree. The component is added to the end
1113 * of the component's child list. This is a helper method that calls
1114 * {@link #addChild(RocketComponent,int)}.
1116 * @param component The component to add.
1117 * @throws IllegalArgumentException if the component is already part of some
1119 * @see #addChild(RocketComponent,int)
1121 public final void addChild(RocketComponent component) {
1123 addChild(component, children.size());
1128 * Adds a child to the rocket component tree. The component is added to
1129 * the given position of the component's child list.
1131 * This method may be overridden to enforce more strict component addition rules.
1132 * The tests should be performed first and then this method called.
1134 * @param component The component to add.
1135 * @param index Position to add component to.
1136 * @throws IllegalArgumentException If the component is already part of
1137 * some component tree.
1139 public void addChild(RocketComponent component, int index) {
1141 if (component.parent != null) {
1142 throw new IllegalArgumentException("component " + component.getComponentName() +
1143 " is already in a tree");
1145 if (!isCompatible(component)) {
1146 throw new IllegalStateException("Component " + component.getComponentName() +
1147 " not currently compatible with component " + getComponentName());
1150 children.add(index, component);
1151 component.parent = this;
1153 this.checkComponentStructure();
1154 component.checkComponentStructure();
1156 fireAddRemoveEvent(component);
1161 * Removes a child from the rocket component tree.
1163 * @param n remove the n'th child.
1164 * @throws IndexOutOfBoundsException if n is out of bounds
1166 public final void removeChild(int n) {
1168 RocketComponent component = children.remove(n);
1169 component.parent = null;
1171 this.checkComponentStructure();
1172 component.checkComponentStructure();
1174 fireAddRemoveEvent(component);
1178 * Removes a child from the rocket component tree. Does nothing if the component
1179 * is not present as a child.
1181 * @param component the component to remove
1182 * @return whether the component was a child
1184 public final boolean removeChild(RocketComponent component) {
1187 component.checkComponentStructure();
1189 if (children.remove(component)) {
1190 component.parent = null;
1192 this.checkComponentStructure();
1193 component.checkComponentStructure();
1195 fireAddRemoveEvent(component);
1205 * Move a child to another position.
1207 * @param component the component to move
1208 * @param index the component's new position
1209 * @throws IllegalArgumentException If an illegal placement was attempted.
1211 public final void moveChild(RocketComponent component, int index) {
1213 if (children.remove(component)) {
1214 children.add(index, component);
1216 this.checkComponentStructure();
1217 component.checkComponentStructure();
1219 fireAddRemoveEvent(component);
1225 * Fires an AERODYNAMIC_CHANGE, MASS_CHANGE or OTHER_CHANGE event depending on the
1226 * type of component removed.
1228 private void fireAddRemoveEvent(RocketComponent component) {
1229 Iterator<RocketComponent> iter = component.iterator(true);
1230 int type = ComponentChangeEvent.TREE_CHANGE;
1231 while (iter.hasNext()) {
1232 RocketComponent c = iter.next();
1233 if (c.isAerodynamic())
1234 type |= ComponentChangeEvent.AERODYNAMIC_CHANGE;
1236 type |= ComponentChangeEvent.MASS_CHANGE;
1239 fireComponentChangeEvent(type);
1243 public final int getChildCount() {
1245 this.checkComponentStructure();
1246 return children.size();
1249 public final RocketComponent getChild(int n) {
1251 this.checkComponentStructure();
1252 return children.get(n);
1255 public final List<RocketComponent> getChildren() {
1257 this.checkComponentStructure();
1258 return children.clone();
1263 * Returns the position of the child in this components child list, or -1 if the
1264 * component is not a child of this component.
1266 * @param child The child to search for.
1267 * @return Position in the list or -1 if not found.
1269 public final int getChildPosition(RocketComponent child) {
1271 this.checkComponentStructure();
1272 return children.indexOf(child);
1276 * Get the parent component of this component. Returns <code>null</code> if the component
1279 * @return The parent of this component or <code>null</code>.
1281 public final RocketComponent getParent() {
1287 * Get the root component of the component tree.
1289 * @return The root component of the component tree.
1291 public final RocketComponent getRoot() {
1293 RocketComponent gp = this;
1294 while (gp.parent != null)
1300 * Returns the root Rocket component of this component tree. Throws an
1301 * IllegalStateException if the root component is not a Rocket.
1303 * @return The root Rocket component of the component tree.
1304 * @throws IllegalStateException If the root component is not a Rocket.
1306 public final Rocket getRocket() {
1308 RocketComponent r = getRoot();
1309 if (r instanceof Rocket)
1311 throw new IllegalStateException("getRocket() called with root component "
1312 + r.getComponentName());
1317 * Return the Stage component that this component belongs to. Throws an
1318 * IllegalStateException if a Stage is not in the parentage of this component.
1320 * @return The Stage component this component belongs to.
1321 * @throws IllegalStateException if a Stage component is not in the parentage.
1323 public final Stage getStage() {
1325 RocketComponent c = this;
1327 if (c instanceof Stage)
1331 throw new IllegalStateException("getStage() called without Stage as a parent.");
1335 * Return the stage number of the stage this component belongs to. The stages
1336 * are numbered from zero upwards.
1338 * @return the stage number this component belongs to.
1340 public final int getStageNumber() {
1342 if (parent == null) {
1343 throw new IllegalArgumentException("getStageNumber() called for root component");
1346 RocketComponent stage = this;
1347 while (!(stage instanceof Stage)) {
1348 stage = stage.parent;
1349 if (stage == null || stage.parent == null) {
1350 throw new IllegalStateException("getStageNumber() could not find parent " +
1354 return stage.parent.getChildPosition(stage);
1359 * Find a component with the given ID. The component tree is searched from this component
1360 * down (including this component) for the ID and the corresponding component is returned,
1361 * or null if not found.
1363 * @param idToFind ID to search for.
1364 * @return The component with the ID, or null if not found.
1366 public final RocketComponent findComponent(String idToFind) {
1368 Iterator<RocketComponent> iter = this.iterator(true);
1369 while (iter.hasNext()) {
1370 RocketComponent c = iter.next();
1371 if (c.getID().equals(idToFind))
1378 // TODO: Move these methods elsewhere (used only in SymmetricComponent)
1379 public final RocketComponent getPreviousComponent() {
1381 this.checkComponentStructure();
1384 int pos = parent.getChildPosition(this);
1386 StringBuffer sb = new StringBuffer();
1387 sb.append("Inconsistent internal state: ");
1388 sb.append("this=").append(this).append('[')
1389 .append(System.identityHashCode(this)).append(']');
1390 sb.append(" parent.children=[");
1391 for (int i = 0; i < parent.children.size(); i++) {
1392 RocketComponent c = parent.children.get(i);
1393 sb.append(c).append('[').append(System.identityHashCode(c)).append(']');
1394 if (i < parent.children.size() - 1)
1398 throw new IllegalStateException(sb.toString());
1403 RocketComponent c = parent.getChild(pos - 1);
1404 while (c.getChildCount() > 0)
1405 c = c.getChild(c.getChildCount() - 1);
1409 // TODO: Move these methods elsewhere (used only in SymmetricComponent)
1410 public final RocketComponent getNextComponent() {
1412 if (getChildCount() > 0)
1415 RocketComponent current = this;
1416 RocketComponent nextParent = this.parent;
1418 while (nextParent != null) {
1419 int pos = nextParent.getChildPosition(current);
1420 if (pos < nextParent.getChildCount() - 1)
1421 return nextParent.getChild(pos + 1);
1423 current = nextParent;
1424 nextParent = current.parent;
1430 /////////// Event handling //////////
1432 // Listener lists are provided by the root Rocket component,
1433 // a single listener list for the whole rocket.
1437 * Adds a ComponentChangeListener to the rocket tree. The listener is added to the root
1438 * component, which must be of type Rocket (which overrides this method). Events of all
1439 * subcomponents are sent to all listeners.
1441 * @throws IllegalStateException - if the root component is not a Rocket
1443 public void addComponentChangeListener(ComponentChangeListener l) {
1445 getRocket().addComponentChangeListener(l);
1449 * Removes a ComponentChangeListener from the rocket tree. The listener is removed from
1450 * the root component, which must be of type Rocket (which overrides this method).
1451 * Does nothing if the root component is not a Rocket. (The asymmetry is so
1452 * that listeners can always be removed just in case.)
1454 * @param l Listener to remove
1456 public void removeComponentChangeListener(ComponentChangeListener l) {
1457 if (parent != null) {
1458 getRoot().removeComponentChangeListener(l);
1464 * Adds a <code>ChangeListener</code> to the rocket tree. This is identical to
1465 * <code>addComponentChangeListener()</code> except that it uses a
1466 * <code>ChangeListener</code>. The same events are dispatched to the
1467 * <code>ChangeListener</code>, as <code>ComponentChangeEvent</code> is a subclass
1468 * of <code>ChangeEvent</code>.
1470 * @throws IllegalStateException - if the root component is not a <code>Rocket</code>
1473 public void addChangeListener(ChangeListener l) {
1475 getRocket().addChangeListener(l);
1479 * Removes a ChangeListener from the rocket tree. This is identical to
1480 * removeComponentChangeListener() except it uses a ChangeListener.
1481 * Does nothing if the root component is not a Rocket. (The asymmetry is so
1482 * that listeners can always be removed just in case.)
1484 * @param l Listener to remove
1487 public void removeChangeListener(ChangeListener l) {
1488 if (this.parent != null) {
1489 getRoot().removeChangeListener(l);
1495 * Fires a ComponentChangeEvent on the rocket structure. The call is passed to the
1496 * root component, which must be of type Rocket (which overrides this method).
1497 * Events of all subcomponents are sent to all listeners.
1499 * If the component tree root is not a Rocket, the event is ignored. This is the
1500 * case when constructing components not in any Rocket tree. In this case it
1501 * would be impossible for the component to have listeners in any case.
1503 * @param e Event to send
1505 protected void fireComponentChangeEvent(ComponentChangeEvent e) {
1507 if (parent == null) {
1508 /* Ignore if root invalid. */
1509 log.debug("Attempted firing event " + e + " with root " + this.getComponentName() + ", ignoring event");
1512 getRoot().fireComponentChangeEvent(e);
1517 * Fires a ComponentChangeEvent of the given type. The source of the event is set to
1520 * @param type Type of event
1521 * @see #fireComponentChangeEvent(ComponentChangeEvent)
1523 protected void fireComponentChangeEvent(int type) {
1524 fireComponentChangeEvent(new ComponentChangeEvent(this, type));
1529 * Checks whether this component has been invalidated and should no longer be used.
1530 * This is a safety check that in-place replaced components are no longer used.
1531 * All non-trivial methods (with the exception of methods simply getting a property)
1532 * should call this method before changing or computing anything.
1534 * @throws BugException if this component has been invalidated by {@link #copyFrom(RocketComponent)}.
1536 protected void checkState() {
1537 invalidator.check(true);
1543 * Check that the local component structure is correct. This can be called after changing
1544 * the component structure in order to verify the integrity.
1546 * TODO: Remove this after the "inconsistent internal state" bug has been corrected
1548 public void checkComponentStructure() {
1549 if (this.parent != null) {
1550 // Test that this component is found in parent's children with == operator
1551 if (!containsExact(this.parent.children, this)) {
1552 throw new BugException("Inconsistent component structure detected, parent does not contain this " +
1553 "component as a child, parent=" + parent.toDebugString() + " this=" + this.toDebugString());
1556 for (RocketComponent child : this.children) {
1557 if (child.parent != this) {
1558 throw new BugException("Inconsistent component structure detected, child does not have this component " +
1559 "as the parent, this=" + this.toDebugString() + " child=" + child.toDebugString() +
1560 " child.parent=" + (child.parent == null ? "null" : child.parent.toDebugString()));
1565 // Check whether the list contains exactly the searched-for component (with == operator)
1566 private boolean containsExact(List<RocketComponent> haystack, RocketComponent needle) {
1567 for (RocketComponent c : haystack) {
1576 /////////// Iterators //////////
1579 * Returns an iterator that iterates over all children and sub-children.
1581 * The iterator iterates through all children below this object, including itself if
1582 * <code>returnSelf</code> is true. The order of the iteration is not specified
1583 * (it may be specified in the future).
1585 * If an iterator iterating over only the direct children of the component is required,
1586 * use <code>component.getChildren().iterator()</code>.
1588 * TODO: HIGH: Remove this after merges have been done
1590 * @param returnSelf boolean value specifying whether the component itself should be
1592 * @return An iterator for the children and sub-children.
1593 * @deprecated Use {@link #iterator(boolean)} instead
1596 public final Iterator<RocketComponent> deepIterator(boolean returnSelf) {
1597 return iterator(returnSelf);
1602 * Returns an iterator that iterates over all children and sub-children, including itself.
1604 * This method is equivalent to <code>deepIterator(true)</code>.
1606 * TODO: HIGH: Remove this after merges have been done
1608 * @return An iterator for this component, its children and sub-children.
1609 * @deprecated Use {@link #iterator()} instead
1612 public final Iterator<RocketComponent> deepIterator() {
1619 * Returns an iterator that iterates over all children and sub-children.
1621 * The iterator iterates through all children below this object, including itself if
1622 * <code>returnSelf</code> is true. The order of the iteration is not specified
1623 * (it may be specified in the future).
1625 * If an iterator iterating over only the direct children of the component is required,
1626 * use <code>component.getChildren().iterator()</code>.
1628 * @param returnSelf boolean value specifying whether the component itself should be
1630 * @return An iterator for the children and sub-children.
1632 public final Iterator<RocketComponent> iterator(boolean returnSelf) {
1634 return new RocketComponentIterator(this, returnSelf);
1639 * Returns an iterator that iterates over this component, its children and sub-children.
1641 * This method is equivalent to <code>iterator(true)</code>.
1643 * @return An iterator for this component, its children and sub-children.
1646 public final Iterator<RocketComponent> iterator() {
1647 return iterator(true);
1655 * Compare component equality based on the ID of this component. Only the
1656 * ID and class type is used for a basis of comparison.
1659 public boolean equals(Object obj) {
1664 if (this.getClass() != obj.getClass())
1666 RocketComponent other = (RocketComponent) obj;
1667 return this.id.equals(other.id);
1673 public int hashCode() {
1674 return id.hashCode();
1679 //////////// Helper methods for subclasses
1685 * Helper method to add rotationally symmetric bounds at the specified coordinates.
1686 * The X-axis value is <code>x</code> and the radius at the specified position is
1689 protected static final void addBound(Collection<Coordinate> bounds, double x, double r) {
1690 bounds.add(new Coordinate(x, -r, -r));
1691 bounds.add(new Coordinate(x, r, -r));
1692 bounds.add(new Coordinate(x, r, r));
1693 bounds.add(new Coordinate(x, -r, r));
1697 protected static final Coordinate ringCG(double outerRadius, double innerRadius,
1698 double x1, double x2, double density) {
1699 return new Coordinate((x1 + x2) / 2, 0, 0,
1700 ringMass(outerRadius, innerRadius, x2 - x1, density));
1703 protected static final double ringMass(double outerRadius, double innerRadius,
1704 double length, double density) {
1705 return Math.PI * (MathUtil.pow2(outerRadius) - MathUtil.pow2(innerRadius)) *
1709 protected static final double ringLongitudinalUnitInertia(double outerRadius,
1710 double innerRadius, double length) {
1711 // 1/12 * (3 * (r1^2 + r2^2) + h^2)
1712 return (3 * (MathUtil.pow2(innerRadius) + MathUtil.pow2(outerRadius)) + MathUtil.pow2(length)) / 12;
1715 protected static final double ringRotationalUnitInertia(double outerRadius,
1716 double innerRadius) {
1717 // 1/2 * (r1^2 + r2^2)
1718 return (MathUtil.pow2(innerRadius) + MathUtil.pow2(outerRadius)) / 2;
1727 * Loads the RocketComponent fields from the given component. This method is meant
1728 * for in-place replacement of a component. It is used with the undo/redo
1729 * mechanism and when converting a finset into a freeform fin set.
1730 * This component must not have a parent, otherwise this method will fail.
1732 * The child components in the source tree are copied into the current tree, however,
1733 * the original components should not be used since they represent old copies of the
1734 * components. It is recommended to invalidate them by calling {@link #invalidate()}.
1736 * This method returns a list of components that should be invalidated after references
1737 * to them have been removed (for example by firing appropriate events). The list contains
1738 * all children and sub-children of the current component and the entire component
1739 * tree of <code>src</code>.
1741 * @return a list of components that should not be used after this call.
1743 protected List<RocketComponent> copyFrom(RocketComponent src) {
1745 List<RocketComponent> toInvalidate = new ArrayList<RocketComponent>();
1747 if (this.parent != null) {
1748 throw new UnsupportedOperationException("copyFrom called for non-root component, parent=" +
1749 this.parent.toDebugString() + ", this=" + this.toDebugString());
1752 // Add current structure to be invalidated
1753 Iterator<RocketComponent> iterator = this.iterator(false);
1754 while (iterator.hasNext()) {
1755 toInvalidate.add(iterator.next());
1758 // Remove previous components
1759 for (RocketComponent child : this.children) {
1760 child.parent = null;
1762 this.children.clear();
1764 // Copy new children to this component
1765 for (RocketComponent c : src.children) {
1766 RocketComponent copy = c.copyWithOriginalID();
1767 this.children.add(copy);
1771 this.checkComponentStructure();
1772 src.checkComponentStructure();
1774 // Set all parameters
1775 this.length = src.length;
1776 this.relativePosition = src.relativePosition;
1777 this.position = src.position;
1778 this.color = src.color;
1779 this.lineStyle = src.lineStyle;
1780 this.overrideMass = src.overrideMass;
1781 this.massOverriden = src.massOverriden;
1782 this.overrideCGX = src.overrideCGX;
1783 this.cgOverriden = src.cgOverriden;
1784 this.overrideSubcomponents = src.overrideSubcomponents;
1785 this.name = src.name;
1786 this.comment = src.comment;
1789 // Add source components to invalidation tree
1790 for (RocketComponent c : src) {
1791 toInvalidate.add(c);
1794 return toInvalidate;
1797 protected void invalidate() {
1798 invalidator.invalidate();
1802 ////////// Iterator implementation ///////////
1805 * Private inner class to implement the Iterator.
1807 * This iterator is fail-fast if the root of the structure is a Rocket.
1809 private static class RocketComponentIterator implements Iterator<RocketComponent> {
1810 // Stack holds iterators which still have some components left.
1811 private final Deque<Iterator<RocketComponent>> iteratorStack = new ArrayDeque<Iterator<RocketComponent>>();
1813 private final Rocket root;
1814 private final int treeModID;
1816 private final RocketComponent original;
1817 private boolean returnSelf = false;
1819 // Construct iterator with component's child's iterator, if it has elements
1820 public RocketComponentIterator(RocketComponent c, boolean returnSelf) {
1822 RocketComponent gp = c.getRoot();
1823 if (gp instanceof Rocket) {
1825 treeModID = root.getTreeModID();
1831 Iterator<RocketComponent> i = c.children.iterator();
1833 iteratorStack.push(i);
1836 this.returnSelf = returnSelf;
1840 public boolean hasNext() {
1844 return !iteratorStack.isEmpty(); // Elements remain if stack is not empty
1848 public RocketComponent next() {
1849 Iterator<RocketComponent> i;
1853 // Return original component first
1859 // Peek first iterator from stack, throw exception if empty
1860 i = iteratorStack.peek();
1862 throw new NoSuchElementException("No further elements in RocketComponent iterator");
1865 // Retrieve next component of the iterator, remove iterator from stack if empty
1866 RocketComponent c = i.next();
1868 iteratorStack.pop();
1870 // Add iterator of component children to stack if it has children
1871 i = c.children.iterator();
1873 iteratorStack.push(i);
1878 private void checkID() {
1880 if (root.getTreeModID() != treeModID) {
1881 throw new IllegalStateException("Rocket modified while being iterated");
1887 public void remove() {
1888 throw new UnsupportedOperationException("remove() not supported by " +
1889 "RocketComponent iterator");