Merge pull request #1296 from hcraigmiller/Fin-marking-guide-tube-fins

Adds tube fin sets to fin marking guide.
This commit is contained in:
Joe Pfeiffer 2022-04-16 16:10:18 -06:00 committed by GitHub
commit bdcbb3cc99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -22,6 +22,7 @@ import net.sf.openrocket.l10n.Translator;
import net.sf.openrocket.rocketcomponent.BodyTube;
import net.sf.openrocket.rocketcomponent.ExternalComponent;
import net.sf.openrocket.rocketcomponent.FinSet;
import net.sf.openrocket.rocketcomponent.TubeFinSet;
import net.sf.openrocket.rocketcomponent.LaunchLug;
import net.sf.openrocket.rocketcomponent.RailButton;
import net.sf.openrocket.rocketcomponent.Rocket;
@ -29,12 +30,12 @@ import net.sf.openrocket.rocketcomponent.RocketComponent;
import net.sf.openrocket.startup.Application;
/**
* This is the core Swing representation of a fin marking guide. It can handle multiple fin sets on the same or
* different body tubes. One marking guide will be created for any body tube that has a fin set. If a tube has multiple
* fin sets, then they are combined onto one marking guide. It also includes launch lug and rail button marking line(s)
* if lugs and buttons are present. If (and only if) a launch lug or rail button exists, then the word 'Front' is
* affixed to the leading edge of the guide to give orientation.
* </p>
* This is the core Swing representation of a fin marking guide. It can handle multiple fin and/or tube fin sets
* on the same or different body tubes. One marking guide will be created for each body tube that has a fin set.
* If a tube has multiple fin and/or tube fin sets, then they are combined onto one marking guide. It also includes
* launch lugs and/or rail button marking line(s) if lugs or buttons are present. If (and only if) a launch lug and/or
* rail button exists, then the word 'Front' is affixed to the leading edge of the guide to give orientation.
* <p/>
*/
@SuppressWarnings("serial")
public class FinMarkingGuide extends JPanel {
@ -78,12 +79,13 @@ public class FinMarkingGuide extends JPanel {
private static final int MARGIN = (int) PrintUnit.INCHES.toPoints(0.25f);
/**
* The height (circumference) of the biggest body tube with a fin set.
* The height (circumference) of the biggest body tube with a fin and/or tube fin set.
*/
private int maxHeight = 0;
/**
* A map of body tubes, to a list of components that contain fin sets, and launch lugs and rail buttons.
* A map of body tubes, to a list of components that contain fin and/or tube fin sets and launch lugs and/or
* rail buttons.
*/
private Map<BodyTube, java.util.List<ExternalComponent>> markingGuideItems;
@ -101,12 +103,12 @@ public class FinMarkingGuide extends JPanel {
}
/**
* Initialize the marking guide class by iterating over a rocket and finding all fin sets.
* Initialize the marking guide class by iterating over a rocket and finding all fin and/or tube fin sets.
*
* @param component the root rocket component - this is iterated to find all fin sets, and launch lugs and
* rail buttons
* @param component the root rocket component - this is iterated to find all fin and/or tube fin sets and
* launch lugs and/or rail buttons.
*
* @return a map of body tubes to lists of fin sets, and launch lugs and rail buttons.
* @return a map of body tubes to lists of fin and/or tube fin sets and launch lugs and/or rail buttons.
*/
private Map<BodyTube, java.util.List<ExternalComponent>> init(Rocket component) {
Iterator<RocketComponent> iter = component.iterator(false);
@ -122,8 +124,8 @@ public class FinMarkingGuide extends JPanel {
current = (BodyTube) next;
}
// ACTION If Fin Set or Launch Lug or Rail Button
else if (next instanceof FinSet || next instanceof LaunchLug || next instanceof RailButton) {
// IF Existence of FinSet or TubeFinSet or LaunchLug or RailButton
else if (next instanceof FinSet || next instanceof TubeFinSet || next instanceof LaunchLug || next instanceof RailButton) {
java.util.List<ExternalComponent> list = results.get(current);
if (list == null && current != null) {
list = new ArrayList<ExternalComponent>();
@ -222,7 +224,7 @@ public class FinMarkingGuide extends JPanel {
* lug.
*
* Note: There is a current limitation that a tube with multiple launch lugs and/or rail buttons may not render
* the lug and/or rail button lines correctly.
* the lug and/or button lines correctly.
* </pre>
*
* @param g the Graphics context
@ -262,6 +264,8 @@ public class FinMarkingGuide extends JPanel {
//fin1: 42 fin2: 25
for (ExternalComponent externalComponent : componentList) {
// BEGIN If FinSet instance
if (externalComponent instanceof FinSet) {
FinSet fins = (FinSet) externalComponent;
int finCount = fins.getFinCount();
@ -289,8 +293,39 @@ public class FinMarkingGuide extends JPanel {
// }
}
}
// END If FinSet instance
//BEGIN Launch Lug
// BEGIN If TubeFinSet instance
if (externalComponent instanceof TubeFinSet) {
TubeFinSet fins = (TubeFinSet) externalComponent;
int finCount = fins.getFinCount();
double baseAngularSpacing = (TWO_PI / finCount);
double baseAngularOffset = fins.getBaseRotation();
//Draw the fin marking lines.
for (int fin = 0; fin < finCount; fin++) {
double angle = baseAngularOffset + fin * baseAngularSpacing - radialOrigin;
// Translate angle into pixels using a linear transformation:
// radialOrigin -> y
// radialOrigin + TWO_PI -> y + circumferenceInPoints
while (angle < 0) {
angle += TWO_PI;
}
while (angle > TWO_PI) {
angle -= TWO_PI;
}
int offset = (int) Math.round(y + angle / TWO_PI * circumferenceInPoints);
drawDoubleArrowLine(g2, x, offset, x + width, offset);
// if (hasMultipleComponents) {
g2.drawString(externalComponent.getName(), x + (width / 3), offset - 2);
// }
}
}
// END If TubeFinSet instance
// BEGIN If LaunchLug instance
else if (externalComponent instanceof LaunchLug) {
LaunchLug lug = (LaunchLug) externalComponent;
double angle = lug.getAngleOffset() - radialOrigin;
@ -302,9 +337,9 @@ public class FinMarkingGuide extends JPanel {
g2.drawString(lug.getName(), x + (width / 3), (int) yLLOffset - 2);
}
//END Launch Lug
// END If LaunchLug instance
//BEGIN Rail Button
// BEGIN If RailButton instance
else if (externalComponent instanceof RailButton) {
RailButton button = (RailButton) externalComponent;
double angle = button.getAngleOffset() - radialOrigin;
@ -316,11 +351,10 @@ public class FinMarkingGuide extends JPanel {
g2.drawString(button.getName(), x + (width / 3), (int) yLLOffset - 2);
}
//END Rail Button
// END If RailButton instance
}
/* Only if the tube has a lug or button multiple fin sets does the orientation of the marking guide
matter. So print 'Front'.
*/
// Only if the tube has a lug or button or multiple fin and/or tube fin sets does the orientation of
// the marking guide matter. So print 'Front'.
if (hasMultipleComponents) {
drawFrontIndication(g2, x, y, 0, (int) circumferenceInPoints, width);
}
@ -339,7 +373,7 @@ public class FinMarkingGuide extends JPanel {
}
/**
* This function finds a origin in radians for the template so no component is on the template seam.
* This function finds an origin in radians for the template so no component is on the template seam.
*
* If no fin, or launch lug or rail button is at 0.0 radians, then the origin is 0. If there is one, then half
* the distance between the two are taken.
@ -353,23 +387,17 @@ public class FinMarkingGuide extends JPanel {
for (ExternalComponent component : components) {
// BEGIN Launch Lug
if (component instanceof LaunchLug) {
if (component instanceof LaunchLug) { // Instance of LaunchLug
double componentPosition = ((LaunchLug) component).getAngleOffset();
positions.add(makeZeroTwoPi(componentPosition));
}
// END Launch Lug
// BEGIN Rail Button
if (component instanceof RailButton) {
if (component instanceof RailButton) { // Instance of RailButton
double componentPosition = ((RailButton) component).getAngleOffset();
positions.add(makeZeroTwoPi(componentPosition));
}
// END Rail Button
if (component instanceof FinSet) {
if (component instanceof FinSet) { // Instance of FinSet
FinSet fins = (FinSet) component;
double basePosition = fins.getBaseRotation();
double angle = TWO_PI / fins.getFinCount();
@ -378,6 +406,16 @@ public class FinMarkingGuide extends JPanel {
basePosition += angle;
}
}
if (component instanceof TubeFinSet) { // Instance of TubeFinSet
TubeFinSet fins = (TubeFinSet) component;
double basePosition = fins.getBaseRotation();
double angle = TWO_PI / fins.getFinCount();
for (int i = fins.getFinCount(); i > 0; i--) {
positions.add(makeZeroTwoPi(basePosition));
basePosition += angle;
}
}
}
Collections.sort(positions);
@ -419,15 +457,18 @@ public class FinMarkingGuide extends JPanel {
}
/**
* Determines if the list contains a FinSet.
* Determine if the list contains a FinSet or TubeFinSet.
*
* @param list a list of ExternalComponent
*
* @return true if the list contains at least one FinSet
* @return true if the list contains at least one FinSet or TubeFinSet
*/
private boolean hasFins(List<ExternalComponent> list) {
for (ExternalComponent externalComponent : list) {
if (externalComponent instanceof FinSet) {
if (externalComponent instanceof FinSet) { // ACTION Existence of FinSet
return true;
}
if (externalComponent instanceof TubeFinSet) { // ACTION Existence of TubeFinSet
return true;
}
}