Class MarkerSceneSymbol

  • All Implemented Interfaces:
    JsonSerializable
    Direct Known Subclasses:
    ModelSceneSymbol, SimpleMarkerSceneSymbol

    public abstract class MarkerSceneSymbol
    extends SceneSymbol
    Defines a MarkerSceneSymbol which is a SceneSymbol based on simple 3D geometries (e.g., sphere) or 3D models (e.g., COLLADA file format):
    • Color, color of the symbol.
    • Width, width of the symbol .
    • Height, height of the symbol .
    • Depth, depth of the symbol .
    • Pitch, pitch of the symbol.
    • Roll, roll of the symbol.
    • Heading, heading of the symbol.

    A MarkerSceneSymbol can be displayed using a Graphic and setting it to a GraphicsOverlay or setting the symbol as a Renderer.

    Since:
    100.0.0 for JavaSE and 100.1.0 for Android
    See Also:
    Graphic, GraphicsOverlay, MarkerSymbol, Symbol
    • Method Detail

      • setAnchorPosition

        public void setAnchorPosition​(SceneSymbol.AnchorPosition anchorPosition)
        Sets the anchor position.
        Parameters:
        anchorPosition - the anchor position
        Throws:
        java.lang.IllegalArgumentException - if anchorPosition is null
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getColor

        public int getColor()
        Gets the color of the symbol as a ARGB(alpha, red, green, blue) value.

        Default value is 0 (black).

        Returns:
        an integer representing the symbol color as 0xAARRGGBB
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setColor

        public void setColor​(int color)
        Sets the color of the symbol to a ARGB(alpha, red, green, blue) value.
        Parameters:
        color - an integer representing symbol color as 0xAARRGGBB
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getDepth

        public double getDepth()
        Gets the depth of the symbol, in meters.

        Default value is 0.

        Returns:
        the depth of the symbol, in meters
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setDepth

        public void setDepth​(double depth)
        Sets the depth of the symbol, in meters.
        Parameters:
        depth - depth of the symbol, in meters
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getHeading

        public double getHeading()
        Gets the heading of the symbol, in degrees.

        Default value is 0.

        Returns:
        the heading of the symbol, in degrees
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setHeading

        public void setHeading​(double heading)
        Sets the heading of the symbol, in degrees.
        Parameters:
        heading - heading of the symbol, in degrees
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getHeight

        public double getHeight()
        Gets the height of the symbol, in meters.

        Default value is 0.

        Returns:
        the height of the symbol, in meters
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setHeight

        public void setHeight​(double height)
        Sets the height of the symbol, in meters.
        Parameters:
        height - height of the symbol, in meters
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getPitch

        public double getPitch()
        Gets the pitch of the symbol, in degrees.

        Default value is 0.

        Returns:
        the pitch of the symbol, in degrees
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setPitch

        public void setPitch​(double pitch)
        Sets the pitch of the symbol, in degrees.
        Parameters:
        pitch - pitch of the symbol, in degrees
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getRoll

        public double getRoll()
        Gets the roll of the symbol, in degrees.

        Default value is 0.

        Returns:
        the roll of the symbol, in degrees
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setRoll

        public void setRoll​(double roll)
        Sets the roll of the symbol, in degrees.
        Parameters:
        roll - roll of the symbol, in degrees
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • getWidth

        public double getWidth()
        Gets the width of the symbol, in meters.

        Default value is 0.

        Returns:
        the width of the symbol, in meters
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android
      • setWidth

        public void setWidth​(double width)
        Sets the width of the symbol, in meters.
        Parameters:
        width - width of the symbol, in meters
        Since:
        100.0.0 for JavaSE and 100.1.0 for Android