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);
115 * Returns whether the radius is selected automatically or not.
116 * Returns false also in case automatic radius selection is not possible.
118 public boolean isOuterRadiusAutomatic() {
123 * Sets whether the radius is selected automatically or not.
125 public void setOuterRadiusAutomatic(boolean auto) {
126 if (autoRadius == auto)
130 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
135 public double getAftRadius() {
136 return getOuterRadius();
140 public double getForeRadius() {
141 return getOuterRadius();
145 public boolean isAftRadiusAutomatic() {
146 return isOuterRadiusAutomatic();
150 public boolean isForeRadiusAutomatic() {
151 return isOuterRadiusAutomatic();
157 protected double getFrontAutoRadius() {
158 if (isOuterRadiusAutomatic()) {
159 // Search for previous SymmetricComponent
160 SymmetricComponent c = this.getPreviousSymmetricComponent();
162 return c.getFrontAutoRadius();
167 return getOuterRadius();
171 protected double getRearAutoRadius() {
172 if (isOuterRadiusAutomatic()) {
173 // Search for next SymmetricComponent
174 SymmetricComponent c = this.getNextSymmetricComponent();
176 return c.getRearAutoRadius();
181 return getOuterRadius();
189 public double getInnerRadius() {
192 return Math.max(getOuterRadius() - thickness, 0);
196 public void setInnerRadius(double r) {
197 setThickness(getOuterRadius() - r);
204 * Return the component name.
207 public String getComponentName() {
209 return trans.get("BodyTube.BodyTube");
213 /************ Component calculations ***********/
215 // From SymmetricComponent
217 * Returns the outer radius at the position x. This returns the same value as getOuterRadius().
220 public double getRadius(double x) {
221 return getOuterRadius();
225 * Returns the inner radius at the position x. If the tube is filled, returns always zero.
228 public double getInnerRadius(double x) {
232 return Math.max(getOuterRadius() - thickness, 0);
237 * Returns the body tube's center of gravity.
240 public Coordinate getComponentCG() {
241 return new Coordinate(length / 2, 0, 0, getComponentMass());
245 * Returns the body tube's volume.
248 public double getComponentVolume() {
249 double r = getOuterRadius();
251 return getFilledVolume(r, length);
253 return getFilledVolume(r, length) - getFilledVolume(getInnerRadius(0), length);
258 public double getLongitudinalUnitInertia() {
259 // 1/12 * (3 * (r1^2 + r2^2) + h^2)
260 return (3 * (MathUtil.pow2(getInnerRadius())) + MathUtil.pow2(getOuterRadius()) + MathUtil.pow2(getLength())) / 12;
264 public double getRotationalUnitInertia() {
265 // 1/2 * (r1^2 + r2^2)
266 return (MathUtil.pow2(getInnerRadius()) + MathUtil.pow2(getOuterRadius())) / 2;
273 * Helper function for cylinder volume.
275 private static double getFilledVolume(double r, double l) {
276 return Math.PI * r * r * l;
281 * Adds bounding coordinates to the given set. The body tube will fit within the
282 * convex hull of the points.
284 * Currently the points are simply a rectangular box around the body tube.
287 public Collection<Coordinate> getComponentBounds() {
288 Collection<Coordinate> bounds = new ArrayList<Coordinate>(8);
289 double r = getOuterRadius();
290 addBound(bounds, 0, r);
291 addBound(bounds, length, r);
298 * Check whether the given type can be added to this component. BodyTubes allow any
299 * InternalComponents or ExternalComponents, excluding BodyComponents, to be added.
301 * @param type The RocketComponent class type to add.
302 * @return Whether such a component can be added.
305 public boolean isCompatible(Class<? extends RocketComponent> type) {
306 if (InternalComponent.class.isAssignableFrom(type))
308 if (ExternalComponent.class.isAssignableFrom(type) &&
309 !BodyComponent.class.isAssignableFrom(type))
314 //////////////// Motor mount /////////////////
317 public boolean isMotorMount() {
322 public void setMotorMount(boolean mount) {
323 if (motorMount == mount)
326 fireComponentChangeEvent(ComponentChangeEvent.MOTOR_CHANGE);
330 public Motor getMotor(String id) {
334 // Check whether the id is valid for the current rocket
335 RocketComponent root = this.getRoot();
336 if (!(root instanceof Rocket))
338 if (!((Rocket) root).isMotorConfigurationID(id))
341 return motors.get(id);
345 public void setMotor(String id, Motor motor) {
348 throw new IllegalArgumentException("Cannot set non-null motor for id null");
351 Motor current = motors.get(id);
352 if ((motor == null && current == null) ||
353 (motor != null && motor.equals(current)))
355 motors.put(id, motor);
356 fireComponentChangeEvent(ComponentChangeEvent.MOTOR_CHANGE);
360 public double getMotorDelay(String id) {
361 Double delay = ejectionDelays.get(id);
363 return Motor.PLUGGED;
368 public void setMotorDelay(String id, double delay) {
369 ejectionDelays.put(id, delay);
370 fireComponentChangeEvent(ComponentChangeEvent.MOTOR_CHANGE);
374 public int getMotorCount() {
379 public double getMotorMountDiameter() {
380 return getInnerRadius() * 2;
384 public IgnitionEvent getIgnitionEvent() {
385 return ignitionEvent;
389 public void setIgnitionEvent(IgnitionEvent event) {
390 if (ignitionEvent == event)
392 ignitionEvent = event;
393 fireComponentChangeEvent(ComponentChangeEvent.EVENT_CHANGE);
398 public double getIgnitionDelay() {
399 return ignitionDelay;
403 public void setIgnitionDelay(double delay) {
404 if (MathUtil.equals(delay, ignitionDelay))
406 ignitionDelay = delay;
407 fireComponentChangeEvent(ComponentChangeEvent.EVENT_CHANGE);
412 public double getMotorOverhang() {
417 public void setMotorOverhang(double overhang) {
418 if (MathUtil.equals(this.overhang, overhang))
420 this.overhang = overhang;
421 fireComponentChangeEvent(ComponentChangeEvent.BOTH_CHANGE);
426 public Coordinate getMotorPosition(String id) {
427 Motor motor = motors.get(id);
429 throw new IllegalArgumentException("No motor with id " + id + " defined.");
432 return new Coordinate(this.getLength() - motor.getLength() + this.getMotorOverhang());
440 * Copy the motor and ejection delay HashMaps.
442 * @see rocketcomponent.RocketComponent#copy()
444 @SuppressWarnings("unchecked")
446 protected RocketComponent copyWithOriginalID() {
447 RocketComponent c = super.copyWithOriginalID();
448 ((BodyTube) c).motors = (HashMap<String, Motor>) motors.clone();
449 ((BodyTube) c).ejectionDelays = (HashMap<String, Double>) ejectionDelays.clone();