4 package net.sf.openrocket.gui.print;
6 import java.awt.Graphics2D;
7 import java.io.IOException;
8 import java.text.DecimalFormat;
11 import net.sf.openrocket.document.OpenRocketDocument;
12 import net.sf.openrocket.document.Simulation;
13 import net.sf.openrocket.gui.figureelements.FigureElement;
14 import net.sf.openrocket.gui.figureelements.RocketInfo;
15 import net.sf.openrocket.gui.scalefigure.RocketPanel;
16 import net.sf.openrocket.logging.LogHelper;
17 import net.sf.openrocket.masscalc.BasicMassCalculator;
18 import net.sf.openrocket.masscalc.MassCalculator;
19 import net.sf.openrocket.masscalc.MassCalculator.MassCalcType;
20 import net.sf.openrocket.motor.Motor;
21 import net.sf.openrocket.rocketcomponent.Configuration;
22 import net.sf.openrocket.rocketcomponent.MotorMount;
23 import net.sf.openrocket.rocketcomponent.Rocket;
24 import net.sf.openrocket.rocketcomponent.RocketComponent;
25 import net.sf.openrocket.rocketcomponent.Stage;
26 import net.sf.openrocket.simulation.FlightData;
27 import net.sf.openrocket.simulation.exception.SimulationException;
28 import net.sf.openrocket.startup.Application;
29 import net.sf.openrocket.unit.Unit;
30 import net.sf.openrocket.unit.UnitGroup;
31 import net.sf.openrocket.util.Chars;
32 import net.sf.openrocket.util.Coordinate;
34 import com.itextpdf.text.Document;
35 import com.itextpdf.text.DocumentException;
36 import com.itextpdf.text.Element;
37 import com.itextpdf.text.Paragraph;
38 import com.itextpdf.text.Rectangle;
39 import com.itextpdf.text.pdf.BaseFont;
40 import com.itextpdf.text.pdf.DefaultFontMapper;
41 import com.itextpdf.text.pdf.PdfContentByte;
42 import com.itextpdf.text.pdf.PdfPCell;
43 import com.itextpdf.text.pdf.PdfPTable;
44 import com.itextpdf.text.pdf.PdfWriter;
48 * # Title # Section describing the rocket in general without motors
49 * # Section describing the rocket in general without motors
54 * CP position at 5 degree AOA (or similar)
56 * parachute/streamer sizes
57 * max. diameter (caliber)
58 * velocity at exit of rail/rod
59 * minimum safe velocity reached in x inches/cm
61 * # Section for each motor configuration
63 * a summary of the motors, e.g. 3xC6-0; B4-6
64 * a list of the motors including the manufacturer, designation (maybe also info like burn time, grams of propellant,
66 * total grams of propellant
69 * CG and CP position, stability margin
70 * predicted flight altitude, max. velocity and max. acceleration
71 * predicted velocity at chute deployment
72 * predicted descent rate
73 * Thrust to Weight Ratio of each stage
77 public class DesignReport {
82 private static final LogHelper log = Application.getLogger();
83 public static final double SCALE_FUDGE_FACTOR = 0.4d;
88 private OpenRocketDocument rocketDocument;
91 * A panel used for rendering of the design diagram.
93 final RocketPanel panel;
98 protected Document document;
101 * The figure rotation.
103 private double rotation = 0d;
105 /** The displayed strings. */
106 private static final String STAGES = "Stages: ";
107 private static final String MASS_WITH_MOTORS = "Mass (with motors): ";
108 private static final String MASS_WITH_MOTOR = "Mass (with motor): ";
109 private static final String MASS_EMPTY = "Mass (Empty): ";
110 private static final String STABILITY = "Stability: ";
111 private static final String CG = "CG: ";
112 private static final String CP = "CP: ";
113 private static final String MOTOR = "Motor";
114 private static final String AVG_THRUST = "Avg Thrust";
115 private static final String BURN_TIME = "Burn Time";
116 private static final String MAX_THRUST = "Max Thrust";
117 private static final String TOTAL_IMPULSE = "Total Impulse";
118 private static final String THRUST_TO_WT = "Thrust to Wt";
119 private static final String PROPELLANT_WT = "Propellant Wt";
120 private static final String SIZE = "Size";
121 private static final String ALTITUDE = "Altitude";
122 private static final String FLIGHT_TIME = "Flight Time";
123 private static final String TIME_TO_APOGEE = "Time to Apogee";
124 private static final String VELOCITY_OFF_PAD = "Velocity off Pad";
125 private static final String MAX_VELOCITY = "Max Velocity";
126 private static final String DEPLOYMENT_VELOCITY = "Velocity at Deployment";
127 private static final String LANDING_VELOCITY = "Landing Velocity";
128 private static final String ROCKET_DESIGN = "Rocket Design";
129 private static final double GRAVITY_CONSTANT = 9.80665d;
134 * @param theRocDoc the OR document
135 * @param theIDoc the iText document
136 * @param figureRotation the angle the figure is rotated on the screen; printed report will mimic
138 public DesignReport(OpenRocketDocument theRocDoc, Document theIDoc, Double figureRotation) {
140 rocketDocument = theRocDoc;
141 panel = new RocketPanel(rocketDocument);
142 rotation = figureRotation;
146 * Main entry point. Prints the rocket drawing and design data.
148 * @param writer a direct byte writer
150 public void writeToDocument(PdfWriter writer) {
151 if (writer == null) {
154 com.itextpdf.text.Rectangle pageSize = document.getPageSize();
155 int pageImageableWidth = (int) pageSize.getWidth() - (int) pageSize.getBorderWidth() * 2;
156 int pageImageableHeight = (int) pageSize.getHeight() / 2 - (int) pageSize.getBorderWidthTop();
158 PrintUtilities.addText(document, PrintUtilities.BIG_BOLD, ROCKET_DESIGN);
160 Rocket rocket = rocketDocument.getRocket();
161 final Configuration configuration = rocket.getDefaultConfiguration().clone();
162 configuration.setAllStages();
163 PdfContentByte canvas = writer.getDirectContent();
165 final PrintFigure figure = new PrintFigure(configuration);
166 figure.setRotation(rotation);
168 FigureElement cp = panel.getExtraCP();
169 FigureElement cg = panel.getExtraCG();
170 RocketInfo text = panel.getExtraText();
172 double scale = paintRocketDiagram(pageImageableWidth, pageImageableHeight, canvas, figure, cp, cg);
175 canvas.setFontAndSize(ITextHelper.getBaseFont(), PrintUtilities.NORMAL_FONT_SIZE);
176 int figHeightPts = (int) (PrintUnit.METERS.toPoints(figure.getFigureHeight()) * 0.4 * (scale / PrintUnit.METERS
178 final int diagramHeight = pageImageableHeight * 2 - 70 - (figHeightPts);
179 canvas.moveText(document.leftMargin() + pageSize.getBorderWidthLeft(), diagramHeight);
180 canvas.moveTextWithLeading(0, -16);
182 float initialY = canvas.getYTLM();
184 canvas.showText(rocketDocument.getRocket().getName());
186 canvas.newlineShowText(STAGES);
187 canvas.showText("" + rocket.getStageCount());
190 if (configuration.hasMotors()) {
191 if (configuration.getStageCount() > 1) {
192 canvas.newlineShowText(MASS_WITH_MOTORS);
194 canvas.newlineShowText(MASS_WITH_MOTOR);
197 canvas.newlineShowText(MASS_EMPTY);
199 canvas.showText(text.getMass(UnitGroup.UNITS_MASS.getDefaultUnit()));
201 canvas.newlineShowText(STABILITY);
202 canvas.showText(text.getStability());
204 canvas.newlineShowText(CG);
205 canvas.showText(text.getCg());
207 canvas.newlineShowText(CP);
208 canvas.showText(text.getCp());
212 //Move the internal pointer of the document below that of what was just written using the direct byte buffer.
213 Paragraph paragraph = new Paragraph();
214 float finalY = canvas.getYTLM();
215 int heightOfDiagramAndText = (int) (pageSize.getHeight() - (finalY - initialY + diagramHeight));
217 paragraph.setSpacingAfter(heightOfDiagramAndText);
218 document.add(paragraph);
220 String[] motorIds = rocket.getMotorConfigurationIDs();
221 List<Simulation> simulations = rocketDocument.getSimulations();
223 for (int j = 0; j < motorIds.length; j++) {
224 String motorId = motorIds[j];
225 if (motorId != null) {
226 PdfPTable parent = new PdfPTable(2);
227 parent.setWidthPercentage(100);
228 parent.setHorizontalAlignment(Element.ALIGN_LEFT);
229 parent.setSpacingBefore(0);
230 parent.setWidths(new int[] { 1, 3 });
232 //The first motor config is always null. Skip it and the top-most motor, then set the leading.
236 FlightData flight = findSimulation(motorId, simulations);
237 addFlightData(flight, rocket, motorId, parent, leading);
238 addMotorData(rocket, motorId, parent);
239 document.add(parent);
242 } catch (DocumentException e) {
243 log.error("Could not modify document.", e);
249 * Paint a diagram of the rocket into the PDF document.
251 * @param thePageImageableWidth the number of points in the width of the page available for drawing
252 * @param thePageImageableHeight the number of points in the height of the page available for drawing
253 * @param theCanvas the direct byte writer
254 * @param theFigure the print figure
255 * @param theCp the center of pressure figure element
256 * @param theCg the center of gravity figure element
258 * @return the scale of the diagram
260 private double paintRocketDiagram(final int thePageImageableWidth, final int thePageImageableHeight,
261 final PdfContentByte theCanvas, final PrintFigure theFigure,
262 final FigureElement theCp, final FigureElement theCg) {
263 theFigure.clearAbsoluteExtra();
264 theFigure.clearRelativeExtra();
265 theFigure.addRelativeExtra(theCp);
266 theFigure.addRelativeExtra(theCg);
267 theFigure.updateFigure();
270 (thePageImageableWidth * 2.2) / theFigure.getFigureWidth();
271 theFigure.setScale(scale);
273 * page dimensions are in points-per-inch, which, in Java2D, are the same as pixels-per-inch; thus we don't need any conversion
275 theFigure.setSize(thePageImageableWidth, thePageImageableHeight);
276 theFigure.updateFigure();
278 final DefaultFontMapper mapper = new DefaultFontMapper();
279 Graphics2D g2d = theCanvas.createGraphics(thePageImageableWidth, thePageImageableHeight * 2, mapper);
280 final double halfFigureHeight = SCALE_FUDGE_FACTOR * theFigure.getFigureHeightPx()/2;
281 int y = PrintUnit.POINTS_PER_INCH;
282 //If the y dimension is negative, then it will potentially be drawn off the top of the page. Move the origin
284 if (theFigure.getDimensions().getY() < 0.0d) {
285 y += (int)halfFigureHeight;
287 g2d.translate(20, y);
289 g2d.scale(SCALE_FUDGE_FACTOR, SCALE_FUDGE_FACTOR);
290 theFigure.paint(g2d);
296 * Add the motor data for a motor configuration to the table.
298 * @param rocket the rocket
299 * @param motorId the motor ID to output
300 * @param parent the parent to which the motor data will be added
302 private void addMotorData(Rocket rocket, String motorId, final PdfPTable parent) {
304 PdfPTable motorTable = new PdfPTable(8);
305 motorTable.setWidthPercentage(68);
306 motorTable.setHorizontalAlignment(Element.ALIGN_LEFT);
308 final PdfPCell motorCell = ITextHelper.createCell(MOTOR, PdfPCell.BOTTOM, PrintUtilities.SMALL);
310 motorCell.setPaddingLeft(mPad);
311 motorTable.addCell(motorCell);
312 motorTable.addCell(ITextHelper.createCell(AVG_THRUST, PdfPCell.BOTTOM, PrintUtilities.SMALL));
313 motorTable.addCell(ITextHelper.createCell(BURN_TIME, PdfPCell.BOTTOM, PrintUtilities.SMALL));
314 motorTable.addCell(ITextHelper.createCell(MAX_THRUST, PdfPCell.BOTTOM, PrintUtilities.SMALL));
315 motorTable.addCell(ITextHelper.createCell(TOTAL_IMPULSE, PdfPCell.BOTTOM, PrintUtilities.SMALL));
316 motorTable.addCell(ITextHelper.createCell(THRUST_TO_WT, PdfPCell.BOTTOM, PrintUtilities.SMALL));
317 motorTable.addCell(ITextHelper.createCell(PROPELLANT_WT, PdfPCell.BOTTOM, PrintUtilities.SMALL));
318 motorTable.addCell(ITextHelper.createCell(SIZE, PdfPCell.BOTTOM, PrintUtilities.SMALL));
320 DecimalFormat ttwFormat = new DecimalFormat("0.00");
322 MassCalculator massCalc = new BasicMassCalculator();
324 Configuration config = new Configuration(rocket);
325 config.setMotorConfigurationID(motorId);
327 int totalMotorCount = 0;
328 double totalPropMass = 0;
329 double totalImpulse = 0;
333 double stageMass = 0;
335 boolean topBorder = false;
336 for (RocketComponent c : rocket) {
338 if (c instanceof Stage) {
339 config.setToStage(stage);
341 stageMass = massCalc.getCG(config, MassCalcType.LAUNCH_MASS).weight;
342 // Calculate total thrust-to-weight from only lowest stage motors
347 if (c instanceof MotorMount && ((MotorMount) c).isMotorMount()) {
348 MotorMount mount = (MotorMount) c;
350 if (mount.isMotorMount() && mount.getMotor(motorId) != null) {
351 Motor motor = mount.getMotor(motorId);
352 int motorCount = c.toAbsolute(Coordinate.NUL).length;
355 int border = Rectangle.NO_BORDER;
357 border = Rectangle.TOP;
361 String name = motor.getDesignation();
362 if (motorCount > 1) {
363 name += " (" + Chars.TIMES + motorCount + ")";
366 final PdfPCell motorVCell = ITextHelper.createCell(name, border);
367 motorVCell.setPaddingLeft(mPad);
368 motorTable.addCell(motorVCell);
369 motorTable.addCell(ITextHelper.createCell(
370 UnitGroup.UNITS_FORCE.getDefaultUnit().toStringUnit(motor.getAverageThrustEstimate()), border));
371 motorTable.addCell(ITextHelper.createCell(
372 UnitGroup.UNITS_FLIGHT_TIME.getDefaultUnit().toStringUnit(motor.getBurnTimeEstimate()), border));
373 motorTable.addCell(ITextHelper.createCell(
374 UnitGroup.UNITS_FORCE.getDefaultUnit().toStringUnit(motor.getMaxThrustEstimate()), border));
375 motorTable.addCell(ITextHelper.createCell(
376 UnitGroup.UNITS_IMPULSE.getDefaultUnit().toStringUnit(motor.getTotalImpulseEstimate()), border));
378 double ttw = motor.getAverageThrustEstimate() / (stageMass * GRAVITY_CONSTANT);
379 motorTable.addCell(ITextHelper.createCell(
380 ttwFormat.format(ttw) + ":1", border));
382 double propMass = (motor.getLaunchCG().weight - motor.getEmptyCG().weight);
383 motorTable.addCell(ITextHelper.createCell(
384 UnitGroup.UNITS_MASS.getDefaultUnit().toStringUnit(propMass), border));
386 final Unit motorUnit = UnitGroup.UNITS_MOTOR_DIMENSIONS.getDefaultUnit();
387 motorTable.addCell(ITextHelper.createCell(motorUnit.toString(motor.getDiameter()) +
389 motorUnit.toString(motor.getLength()) + " " +
390 motorUnit.toString(), border));
392 // Sum up total count
393 totalMotorCount += motorCount;
394 totalPropMass += propMass * motorCount;
395 totalImpulse += motor.getTotalImpulseEstimate() * motorCount;
396 totalTTW += ttw * motorCount;
401 if (totalMotorCount > 1) {
402 int border = Rectangle.TOP;
403 final PdfPCell motorVCell = ITextHelper.createCell("Total:", border);
404 motorVCell.setPaddingLeft(mPad);
405 motorTable.addCell(motorVCell);
406 motorTable.addCell(ITextHelper.createCell("", border));
407 motorTable.addCell(ITextHelper.createCell("", border));
408 motorTable.addCell(ITextHelper.createCell("", border));
409 motorTable.addCell(ITextHelper.createCell(
410 UnitGroup.UNITS_IMPULSE.getDefaultUnit().toStringUnit(totalImpulse), border));
411 motorTable.addCell(ITextHelper.createCell(
412 ttwFormat.format(totalTTW) + ":1", border));
413 motorTable.addCell(ITextHelper.createCell(
414 UnitGroup.UNITS_MASS.getDefaultUnit().toStringUnit(totalPropMass), border));
415 motorTable.addCell(ITextHelper.createCell("", border));
419 PdfPCell c = new PdfPCell(motorTable);
420 c.setBorder(PdfPCell.LEFT);
421 c.setBorderWidthTop(0f);
427 * Add the flight data for a simulation configuration to the table.
429 * @param flight the flight data for a single simulation
430 * @param theRocket the rocket
431 * @param motorId a motor configuration id
432 * @param parent the parent to which the simulation flight data will be added
433 * @param leading the number of points for the leading
435 private void addFlightData(final FlightData flight, final Rocket theRocket, final String motorId, final PdfPTable parent, int leading) {
437 // Output the flight data
438 if (flight != null) {
440 final Unit distanceUnit = UnitGroup.UNITS_DISTANCE.getDefaultUnit();
441 final Unit velocityUnit = UnitGroup.UNITS_VELOCITY.getDefaultUnit();
442 final Unit flightTimeUnit = UnitGroup.UNITS_FLIGHT_TIME.getDefaultUnit();
444 PdfPTable labelTable = new PdfPTable(2);
445 labelTable.setWidths(new int[] { 3, 2 });
446 final Paragraph chunk = ITextHelper.createParagraph(stripBrackets(
447 theRocket.getMotorConfigurationNameOrDescription(motorId)), PrintUtilities.BOLD);
448 chunk.setLeading(leading);
449 chunk.setSpacingAfter(3f);
453 final PdfPCell cell = ITextHelper.createCell(ALTITUDE, 2, 2);
454 cell.setUseBorderPadding(false);
455 cell.setBorderWidthTop(0f);
456 labelTable.addCell(cell);
457 labelTable.addCell(ITextHelper.createCell(distanceUnit.toStringUnit(flight.getMaxAltitude()), 2, 2));
459 labelTable.addCell(ITextHelper.createCell(FLIGHT_TIME, 2, 2));
460 labelTable.addCell(ITextHelper.createCell(flightTimeUnit.toStringUnit(flight.getFlightTime()), 2, 2));
462 labelTable.addCell(ITextHelper.createCell(TIME_TO_APOGEE, 2, 2));
463 labelTable.addCell(ITextHelper.createCell(flightTimeUnit.toStringUnit(flight.getTimeToApogee()), 2, 2));
465 labelTable.addCell(ITextHelper.createCell(VELOCITY_OFF_PAD, 2, 2));
466 labelTable.addCell(ITextHelper.createCell(velocityUnit.toStringUnit(flight.getLaunchRodVelocity()), 2, 2));
468 labelTable.addCell(ITextHelper.createCell(MAX_VELOCITY, 2, 2));
469 labelTable.addCell(ITextHelper.createCell(velocityUnit.toStringUnit(flight.getMaxVelocity()), 2, 2));
471 labelTable.addCell(ITextHelper.createCell(DEPLOYMENT_VELOCITY, 2,2));
472 labelTable.addCell(ITextHelper.createCell(velocityUnit.toStringUnit(flight.getDeploymentVelocity()),2,2));
474 labelTable.addCell(ITextHelper.createCell(LANDING_VELOCITY, 2, 2));
475 labelTable.addCell(ITextHelper.createCell(velocityUnit.toStringUnit(flight.getGroundHitVelocity()), 2, 2));
477 //Add the table to the parent; have to wrap it in a cell
478 PdfPCell c = new PdfPCell(labelTable);
479 c.setBorder(PdfPCell.RIGHT);
480 c.setBorderWidthTop(0);
483 } catch (DocumentException e) {
484 log.error("Could not add flight data to document.", e);
490 * Locate the simulation based on the motor id. Copy the simulation and execute it, then return the resulting
493 * @param motorId the motor id corresponding to the simulation to find
494 * @param simulations the list of simulations currently associated with the rocket
496 * @return the flight data from the simulation for the specified motor id, or null if not found
498 private FlightData findSimulation(final String motorId, List<Simulation> simulations) {
499 // Perform flight simulation
500 FlightData flight = null;
502 for (int i = 0; i < simulations.size(); i++) {
503 Simulation simulation = simulations.get(i);
504 if (simulation.getOptions().getMotorConfigurationID().equals(motorId)) {
505 simulation = simulation.copy();
506 simulation.simulate();
507 flight = simulation.getSimulatedData();
511 } catch (SimulationException e1) {
518 * Strip [] brackets from a string.
520 * @param target the original string
522 * @return target with [] removed
524 private String stripBrackets(String target) {
525 return stripLeftBracket(stripRightBracket(target));
529 * Strip [ from a string.
531 * @param target the original string
533 * @return target with [ removed
535 private String stripLeftBracket(String target) {
536 return target.replace("[", "");
540 * Strip ] from a string.
542 * @param target the original string
544 * @return target with ] removed
546 private String stripRightBracket(String target) {
547 return target.replace("]", "");