1 package net.sf.openrocket.rocketcomponent;
3 import java.util.ArrayList;
4 import java.util.Collection;
5 import java.util.HashMap;
7 import net.sf.openrocket.l10n.Translator;
8 import net.sf.openrocket.motor.Motor;
9 import net.sf.openrocket.startup.Application;
10 import net.sf.openrocket.util.Coordinate;
11 import net.sf.openrocket.util.MathUtil;
15 * Rocket body tube component. Has only two parameters, a radius and length.
17 * @author Sampo Niskanen <sampo.niskanen@iki.fi>
20 public class BodyTube extends SymmetricComponent implements MotorMount, Coaxial {
21 private static final Translator trans = Application.getTranslator();
23 private double outerRadius = 0;
24 private boolean autoRadius = false; // Radius chosen automatically based on parent component
26 // When changing the inner radius, thickness is modified
28 private boolean motorMount = false;
29 private HashMap<String, Double> ejectionDelays = new HashMap<String, Double>();
30 private HashMap<String, Motor> motors = new HashMap<String, Motor>();
31 private IgnitionEvent ignitionEvent = IgnitionEvent.AUTOMATIC;
32 private double ignitionDelay = 0;
33 private double overhang = 0;
39 this.length = 8 * DEFAULT_RADIUS;
40 this.outerRadius = DEFAULT_RADIUS;
41 this.autoRadius = true;
44 public BodyTube(double length, double radius) {
46 this.outerRadius = Math.max(radius, 0);
47 this.length = Math.max(length, 0);
51 public BodyTube(double length, double radius, boolean filled) {
56 public BodyTube(double length, double radius, double thickness) {
59 this.thickness = thickness;
63 /************ Get/set component parameter methods ************/
66 * Return the outer radius of the body tube.
68 * @return the outside radius of the tube
71 public double getOuterRadius() {
73 // Return auto radius from front or rear
75 SymmetricComponent c = this.getPreviousSymmetricComponent();
77 r = c.getFrontAutoRadius();
80 c = this.getNextSymmetricComponent();
82 r = c.getRearAutoRadius();
94 * Set the outer radius of the body tube. If the radius is less than the wall thickness,
95 * the wall thickness is decreased accordingly of the value of the radius.
96 * This method sets the automatic radius off.
98 * @param radius the outside radius in standard units
101 public void setOuterRadius(double radius) {
102 if ((this.outerRadius == radius) && (autoRadius == false))
105 this.autoRadius = false;
106 this.outerRadius = Math.max(radius, 0);
108 if (this.thickness > this.outerRadius)
109 this.thickness = this.outerRadius;
110 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
116 * Returns whether the radius is selected automatically or not.
117 * Returns false also in case automatic radius selection is not possible.
119 public boolean isOuterRadiusAutomatic() {
124 * Sets whether the radius is selected automatically or not.
126 public void setOuterRadiusAutomatic(boolean auto) {
127 if (autoRadius == auto)
131 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
137 protected void loadFromPreset(RocketComponent preset) {
138 BodyTube c = (BodyTube) preset;
139 this.setOuterRadius(c.getOuterRadius());
141 super.loadFromPreset(preset);
146 public double getAftRadius() {
147 return getOuterRadius();
151 public double getForeRadius() {
152 return getOuterRadius();
156 public boolean isAftRadiusAutomatic() {
157 return isOuterRadiusAutomatic();
161 public boolean isForeRadiusAutomatic() {
162 return isOuterRadiusAutomatic();
168 protected double getFrontAutoRadius() {
169 if (isOuterRadiusAutomatic()) {
170 // Search for previous SymmetricComponent
171 SymmetricComponent c = this.getPreviousSymmetricComponent();
173 return c.getFrontAutoRadius();
178 return getOuterRadius();
182 protected double getRearAutoRadius() {
183 if (isOuterRadiusAutomatic()) {
184 // Search for next SymmetricComponent
185 SymmetricComponent c = this.getNextSymmetricComponent();
187 return c.getRearAutoRadius();
192 return getOuterRadius();
200 public double getInnerRadius() {
203 return Math.max(getOuterRadius() - thickness, 0);
207 public void setInnerRadius(double r) {
208 setThickness(getOuterRadius() - r);
215 * Return the component name.
218 public String getComponentName() {
220 return trans.get("BodyTube.BodyTube");
224 /************ Component calculations ***********/
226 // From SymmetricComponent
228 * Returns the outer radius at the position x. This returns the same value as getOuterRadius().
231 public double getRadius(double x) {
232 return getOuterRadius();
236 * Returns the inner radius at the position x. If the tube is filled, returns always zero.
239 public double getInnerRadius(double x) {
243 return Math.max(getOuterRadius() - thickness, 0);
248 * Returns the body tube's center of gravity.
251 public Coordinate getComponentCG() {
252 return new Coordinate(length / 2, 0, 0, getComponentMass());
256 * Returns the body tube's volume.
259 public double getComponentVolume() {
260 double r = getOuterRadius();
262 return getFilledVolume(r, length);
264 return getFilledVolume(r, length) - getFilledVolume(getInnerRadius(0), length);
269 public double getLongitudinalUnitInertia() {
270 // 1/12 * (3 * (r1^2 + r2^2) + h^2)
271 return (3 * (MathUtil.pow2(getInnerRadius())) + MathUtil.pow2(getOuterRadius()) + MathUtil.pow2(getLength())) / 12;
275 public double getRotationalUnitInertia() {
276 // 1/2 * (r1^2 + r2^2)
277 return (MathUtil.pow2(getInnerRadius()) + MathUtil.pow2(getOuterRadius())) / 2;
284 * Helper function for cylinder volume.
286 private static double getFilledVolume(double r, double l) {
287 return Math.PI * r * r * l;
292 * Adds bounding coordinates to the given set. The body tube will fit within the
293 * convex hull of the points.
295 * Currently the points are simply a rectangular box around the body tube.
298 public Collection<Coordinate> getComponentBounds() {
299 Collection<Coordinate> bounds = new ArrayList<Coordinate>(8);
300 double r = getOuterRadius();
301 addBound(bounds, 0, r);
302 addBound(bounds, length, r);
309 * Check whether the given type can be added to this component. BodyTubes allow any
310 * InternalComponents or ExternalComponents, excluding BodyComponents, to be added.
312 * @param type The RocketComponent class type to add.
313 * @return Whether such a component can be added.
316 public boolean isCompatible(Class<? extends RocketComponent> type) {
317 if (InternalComponent.class.isAssignableFrom(type))
319 if (ExternalComponent.class.isAssignableFrom(type) &&
320 !BodyComponent.class.isAssignableFrom(type))
325 //////////////// Motor mount /////////////////
328 public boolean isMotorMount() {
333 public void setMotorMount(boolean mount) {
334 if (motorMount == mount)
337 fireComponentChangeEvent(ComponentChangeEvent.MOTOR_CHANGE);
341 public Motor getMotor(String id) {
345 // Check whether the id is valid for the current rocket
346 RocketComponent root = this.getRoot();
347 if (!(root instanceof Rocket))
349 if (!((Rocket) root).isMotorConfigurationID(id))
352 return motors.get(id);
356 public void setMotor(String id, Motor motor) {
359 throw new IllegalArgumentException("Cannot set non-null motor for id null");
362 Motor current = motors.get(id);
363 if ((motor == null && current == null) ||
364 (motor != null && motor.equals(current)))
366 motors.put(id, motor);
367 fireComponentChangeEvent(ComponentChangeEvent.MOTOR_CHANGE);
371 public double getMotorDelay(String id) {
372 Double delay = ejectionDelays.get(id);
374 return Motor.PLUGGED;
379 public void setMotorDelay(String id, double delay) {
380 ejectionDelays.put(id, delay);
381 fireComponentChangeEvent(ComponentChangeEvent.MOTOR_CHANGE);
385 public int getMotorCount() {
390 public double getMotorMountDiameter() {
391 return getInnerRadius() * 2;
395 public IgnitionEvent getIgnitionEvent() {
396 return ignitionEvent;
400 public void setIgnitionEvent(IgnitionEvent event) {
401 if (ignitionEvent == event)
403 ignitionEvent = event;
404 fireComponentChangeEvent(ComponentChangeEvent.EVENT_CHANGE);
409 public double getIgnitionDelay() {
410 return ignitionDelay;
414 public void setIgnitionDelay(double delay) {
415 if (MathUtil.equals(delay, ignitionDelay))
417 ignitionDelay = delay;
418 fireComponentChangeEvent(ComponentChangeEvent.EVENT_CHANGE);
423 public double getMotorOverhang() {
428 public void setMotorOverhang(double overhang) {
429 if (MathUtil.equals(this.overhang, overhang))
431 this.overhang = overhang;
432 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
437 public Coordinate getMotorPosition(String id) {
438 Motor motor = motors.get(id);
440 throw new IllegalArgumentException("No motor with id " + id + " defined.");
443 return new Coordinate(this.getLength() - motor.getLength() + this.getMotorOverhang());
451 * Copy the motor and ejection delay HashMaps.
453 * @see rocketcomponent.RocketComponent#copy()
455 @SuppressWarnings("unchecked")
457 protected RocketComponent copyWithOriginalID() {
458 RocketComponent c = super.copyWithOriginalID();
459 ((BodyTube) c).motors = (HashMap<String, Motor>) motors.clone();
460 ((BodyTube) c).ejectionDelays = (HashMap<String, Double>) ejectionDelays.clone();