- All Implemented Interfaces:
JsonSerializable
- Direct Known Subclasses:
ModelSceneSymbol
,SimpleMarkerSceneSymbol
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 Summary
-
Nested Class Summary
Nested classes/interfaces inherited from class com.esri.arcgisruntime.symbology.SceneSymbol
SceneSymbol.AnchorPosition
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe color of the symbol.Returns the anchor position.getColor()
Gets the value of thecolor
property.double
getDepth()
Gets the depth of the symbol, in meters.double
Gets the heading of the symbol, in degrees.double
Gets the height of the symbol, in meters.double
getPitch()
Gets the pitch of the symbol, in degrees.double
getRoll()
Gets the roll of the symbol, in degrees.double
getWidth()
Gets the width of the symbol, in meters.void
setAnchorPosition
(SceneSymbol.AnchorPosition anchorPosition) Sets the anchor position.void
setColor
(int color) Deprecated, for removal: This API element is subject to removal in a future version.void
Sets the value of thecolor
property.void
setDepth
(double depth) Sets the depth of the symbol, in meters.void
setHeading
(double heading) Sets the heading of the symbol, in degrees.void
setHeight
(double height) Sets the height of the symbol, in meters.void
setPitch
(double pitch) Sets the pitch of the symbol, in degrees.void
setRoll
(double roll) Sets the roll of the symbol, in degrees.void
setWidth
(double width) Sets the width of the symbol, in meters.Methods inherited from class com.esri.arcgisruntime.symbology.Symbol
createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, createSwatchAsync, fromJson, getUnknownJson, getUnsupportedJson, toJson
-
Property Details
-
color
The color of the symbol.Default value is
Color.BLACK
.Attempting to set the color to null will throw a NullPointerException exception.
- Since:
- 200.0.0
- See Also:
-
-
Field Details
-
DEFAULT_ANCHOR_POSITION
-
-
Method Details
-
getAnchorPosition
Returns the anchor position. Defaults:-
SceneSymbol.AnchorPosition.BOTTOM
for MarkerSceneSymbols -
SceneSymbol.AnchorPosition.CENTER
for ModelSceneSymbols
- Returns:
- the anchor position
- Since:
- 100.0.0
-
-
setAnchorPosition
Sets the anchor position.- Parameters:
anchorPosition
- the anchor position- Throws:
IllegalArgumentException
- if anchorPosition is null- Since:
- 100.0.0
-
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
Gets the value of thecolor
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
Sets the value of thecolor
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 thecolor
property- Since:
- 200.0.0
- See Also:
-
setColor
Deprecated, for removal: This API element is subject to removal in a future version.as of 200.0.0, replaced bysetColor(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
-
setColor(Color)