Class FireSupportLine

    • Field Detail

      • CFL_OUTLINE_STIPPLE_FACTOR

        protected static final int CFL_OUTLINE_STIPPLE_FACTOR
        Factor applied to the stipple pattern used to draw the dashed line for a Coordinated Fire Line.
        See Also:
        Constant Field Values
      • TOP_LABEL_OFFSET

        protected static final Offset TOP_LABEL_OFFSET
        Offset applied to the graphic's upper label. This offset aligns the bottom edge of the label with the geographic position, in order to keep the label above the graphic as the zoom changes.
      • BOTTOM_LABEL_OFFSET

        protected static final Offset BOTTOM_LABEL_OFFSET
        Offset applied to the graphic's lower label. This offset aligns the top edge of the label with the geographic position, in order to keep the label above the graphic as the zoom changes.
      • path

        protected Path path
        Paths used to render the graphic.
    • Constructor Detail

      • FireSupportLine

        public FireSupportLine​(java.lang.String sidc)
        Create a new target graphic.
        Parameters:
        sidc - Symbol code the identifies the graphic.
    • Method Detail

      • getSupportedGraphics

        public static java.util.List<java.lang.String> getSupportedGraphics()
        Indicates the graphics supported by this class.
        Returns:
        List of masked SIDC strings that identify graphics that this class supports.
      • getAdditionalText

        public java.lang.String getAdditionalText()
        Indicates an additional text identification for this graphic. This value is equivalent to the "T1" modifier in MIL-STD-2525C (a second Unique Designation modifier).
        Returns:
        The additional text. May be null.
      • setAdditionalText

        public void setAdditionalText​(java.lang.String text)
        Indicates an additional text identification for this graphic. Setting this value is equivalent to setting the "T1" modifier in MIL-STD-2525C (a second Unique Designation modifier).
        Parameters:
        text - The additional text. May be null.
      • setPositions

        public void setPositions​(java.lang.Iterable<? extends Position> positions)
        Specifies the positions of the control points that place and orient the graphic.
        Parameters:
        positions - Control points that orient the graphic. Must provide at least three points.
      • getPositions

        public java.lang.Iterable<? extends Position> getPositions()
        Indicates the positions of the control points that place and orient the graphic.
        Returns:
        positions that orient the graphic. How many positions are returned depends on the type of graphic. Some graphics require only a single position, others require many.
      • getReferencePosition

        public Position getReferencePosition()
        A position associated with the object that indicates its aggregate geographic position. The chosen position varies among implementers of this interface. For objects defined by a list of positions, the reference position is typically the first position in the list. For symmetric objects the reference position is often the center of the object. In many cases the object's reference position may be explicitly specified by the application.
        Returns:
        the object's reference position, or null if no reference position is available.
      • applyDelegateOwner

        protected void applyDelegateOwner​(java.lang.Object owner)
        Invoked each frame to apply to the current delegate owner to all renderable objects used to draw the graphic. This base class will apply the delegate owner to Label objects. Subclasses must implement this method to apply the delegate owner to any Renderables that they will draw in order to render the graphic.
        Specified by:
        applyDelegateOwner in class AbstractTacticalGraphic
        Parameters:
        owner - Current delegate owner.
      • isDrawDoubleLabel

        protected boolean isDrawDoubleLabel()
        Indicates whether or not the graphic includes double pairs of top and bottom labels. The Final Support Coordination Line (FSCL) and Restrictive Fire Lines (RFL) include double labels, but the Coordination Fire Line (CFL) does not.
        Returns:
        true if the graphic includes two pairs of top/bottom labels. Both pairs contain the same text content.
      • getEndOfLineText

        protected java.lang.String getEndOfLineText()
        /** Determine text for the labels at the start and end of the line.
        Returns:
        Text for the end of line labels.
      • getTopLabelText

        protected java.lang.String getTopLabelText()
        Determine text for the graphic's top label.
        Returns:
        Text for the top label. May return null if there is no top label.
      • getBottomLabelText

        protected java.lang.String getBottomLabelText()
        Determine text for the graphic's bottom label.
        Returns:
        Text for the bottom label. May return null if there is no bottom label.
      • computePathLength

        protected java.lang.Object[] computePathLength​(DrawContext dc)
        Compute the length of the path, and determine the start and end positions.
        Parameters:
        dc - Current draw context.
        Returns:
        Returns the path's start position, end position, and length (non-terrain following) as a three element array: [Position start, Position end, Double length].
      • getDefaultLabelOffset

        protected Offset getDefaultLabelOffset()
        Indicates the default offset applied to the graphic's main label. This offset may be overridden by the graphic attributes.
        Overrides:
        getDefaultLabelOffset in class AbstractTacticalGraphic
        Returns:
        Offset to apply to the main label.
      • getTopLabelOffset

        protected Offset getTopLabelOffset()
        Indicates the offset applied to the upper label.
        Returns:
        Offset applied to the upper label.
      • getBottomLabelOffset

        protected Offset getBottomLabelOffset()
        Indicates the offset applied to the lower label.
        Returns:
        Offset applied to the bottom label.
      • applyDefaultAttributes

        protected void applyDefaultAttributes​(ShapeAttributes attributes)
        Apply defaults to the active attributes bundle. The default attributes are determined by the type of graphic. This method is called each frame to reset the active shape attributes to the appropriate default state. Override attributes specified by the application may be applied after the defaults have been set. Overridden to draw Coordinated Fire Line with dashed pattern.
        Overrides:
        applyDefaultAttributes in class AbstractMilStd2525TacticalGraphic
        Parameters:
        attributes - Attributes bundle to receive defaults.
      • createPath

        protected Path createPath()
        Create and configure the Path used to render this graphic.
        Returns:
        New path configured with defaults appropriate for this type of graphic.