Class MarkerSceneSymbol

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

public abstract class MarkerSceneSymbol extends SceneSymbol
A base class for 3D marker scene symbols used to display graphics and features (collectively referred to as geoelements) that have points or multipoint geometry.

Symbols describe how graphics and features look on a scene. Different symbols are used with different geometry types. Marker scene symbols are used to display graphics and features that are based on point or multipoint geometries on a 3D surface (a scene). Subclasses of this class represent specific types of marker scene symbols, such as simple symbols (SimpleMarkerSceneSymbol) or 3D models (ModelSceneSymbol).

Since:
100.0.0
See Also:
  • Property Details

  • Field Details

  • Method Details

    • getAnchorPosition

      public SceneSymbol.AnchorPosition getAnchorPosition()
      Returns the anchor position. Defaults:
      Returns:
      the anchor position
      Since:
      100.0.0
    • setAnchorPosition

      public void setAnchorPosition(SceneSymbol.AnchorPosition anchorPosition)
      Sets the anchor position.
      Parameters:
      anchorPosition - the anchor position
      Throws:
      IllegalArgumentException - if anchorPosition is null
      Since:
      100.0.0
    • colorProperty

      public ObjectProperty<Color> colorProperty()
      The color of the symbol.

      Default value is Color.BLACK.

      Attempting to set the color to null will throw a NullPointerException exception.

      Returns:
      the color property
      Since:
      200.0.0
      See Also:
    • getColor

      public Color getColor()
      Gets the value of the color property.
      Property description:
      The color of the symbol.

      Default value is Color.BLACK.

      Attempting to set the color to null will throw a NullPointerException exception.

      Returns:
      the value of the color property
      Since:
      200.0.0
      See Also:
    • setColor

      public void setColor(Color color)
      Sets the value of the color property.
      Property description:
      The color of the symbol.

      Default value is Color.BLACK.

      Attempting to set the color to null will throw a NullPointerException exception.

      Parameters:
      color - the value for the color property
      Since:
      200.0.0
      See Also:
    • setColor

      @Deprecated(since="200.0.0", forRemoval=true) public void setColor(int color)
      Deprecated, for removal: This API element is subject to removal in a future version.
      as of 200.0.0, replaced by setColor(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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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
    • 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