Class CircularRangeFan

    • Field Detail

      • LABEL_OFFSET

        protected static final Offset LABEL_OFFSET
      • position

        protected Position position
        Position of the center of the range fan.
      • rings

        protected java.util.List<SurfaceCircle> rings
        Rings that make up the range fan.
      • symbol

        protected TacticalSymbol symbol
        Symbol drawn at the center of the range fan.
    • Constructor Detail

      • CircularRangeFan

        public CircularRangeFan​(java.lang.String sidc)
        Create the range fan.
        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.
      • getPosition

        public Position getPosition()
        Indicates the center position of the range ran.
        Returns:
        The range fan center position.
      • setPosition

        public void setPosition​(Position position)
        Specifies the center position of the range ran.
        Parameters:
        position - The new center position.
      • setPositions

        public void setPositions​(java.lang.Iterable<? extends Position> positions)
        Specifies the positions of the control points that place and orient the graphic.
        Specified by:
        setPositions in interface TacticalGraphic
        Parameters:
        positions - Control points. This graphic uses only one control point, which determines the center of the circle.
      • setModifier

        public void setModifier​(java.lang.String modifier,
                                java.lang.Object value)
        Specifies the value of a text or graphic modifier.
        Specified by:
        setModifier in interface TacticalGraphic
        Overrides:
        setModifier in class AbstractMilStd2525TacticalGraphic
        Parameters:
        modifier - Key that identifies the modifier to set. The possible modifiers depends on the symbol set.
        value - New value for the modifier.
      • getModifier

        public java.lang.Object getModifier​(java.lang.String modifier)
        Indicates the current value of a text or graphic modifier.
        Specified by:
        getModifier in interface TacticalGraphic
        Overrides:
        getModifier in class AbstractMilStd2525TacticalGraphic
        Parameters:
        modifier - Key that identifies the modifier to retrieve. The possible modifiers depends on the symbol set.
        Returns:
        The value of the modifier, or null if the modifier is not set.
      • getRadii

        public java.util.List<java.lang.Double> getRadii()
        Indicates the radii of the rings that make up the range fan.
        Returns:
        List of radii, in meters. If there are no rings this returns an empty list.
      • setRadii

        public void setRadii​(java.lang.Iterable<java.lang.Double> radii)
        Specifies the radii of the rings that make up the range fan.
        Parameters:
        radii - List of radii, in meters. A circle will be created for each radius.
      • getSymbol

        public java.lang.String getSymbol()
        Indicates a symbol drawn at the center of the range fan.
        Returns:
        The symbol drawn at the center of the range fan. May be null.
      • setSymbol

        public void setSymbol​(java.lang.String sidc)
        Specifies a symbol to draw at the center of the range fan. Equivalent to setting the SymbologyConstants.SYMBOL_INDICATOR modifier. The symbol's position will be changed to match the range fan center position.
        Parameters:
        sidc - Identifier for a MIL-STD-2525C symbol to draw at the center of the range fan. May be null to indicate that no symbol is drawn.
      • getPositions

        public java.lang.Iterable<? extends Position> getPositions()
        Indicates the positions of the control points that place and orient the graphic.
        Specified by:
        getPositions in interface TacticalGraphic
        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.
        Specified by:
        getReferencePosition in interface Movable
        Returns:
        the object's reference position, or null if no reference position is available.
      • doRenderGraphicModifiers

        protected void doRenderGraphicModifiers​(DrawContext dc)
        Render the graphic modifiers. This base class does not render anything, but subclasses may override this method to draw graphic modifiers. Overridden to render symbol at the center of the range fan.
        Overrides:
        doRenderGraphicModifiers in class AbstractTacticalGraphic
        Parameters:
        dc - Current draw context.
      • 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.
      • createCircle

        protected SurfaceCircle createCircle()
        Create a circle for a range ring.
        Returns:
        New circle.