Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.symbology
Class Renderer.SceneProperties
java.lang.Object
com.esri.arcgisruntime.symbology.Renderer.SceneProperties
- Enclosing class:
Renderer
This represents renderer properties applicable only to an ArcGISScene. It includes the following properties:
- Extrusion mode, defines how to extrude a
GeoElement
- Extrusion expression, to calculate the extrusion of a
GeoElement
- Heading expression, to calculate the heading of a
GeoElement
- Pitch expression, to calculate the pitch of a
GeoElement
- Roll expression, to calculate the roll of a
GeoElement
The expressions can contain the name of the attribute of the GeoElement
. With the following example, the
renderer looks up the value of "heading" attribute of a GeoElement
and then adds 180 to it.
setHeadingExpression("heading + 180"); // "heading" is a attribute name
Notes:
- When extrusion is applied to points, they are always extruded as cylinders irrespective of
SimpleMarkerSymbol.Style
- Since:
- 100.0.0
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the extrusion expression.Returns the extrusion mode.Returns the heading expression.Returns the pitch expression.Returns the roll expression.void
setExtrusionExpression
(String extrusionExpression) Sets the expression to calculate extrusion.void
setExtrusionMode
(Renderer.SceneProperties.ExtrusionMode extrusionMode) Sets the extrusion mode to be applied.void
setHeadingExpression
(String headingExpression) Sets the expression to calculate heading.void
setPitchExpression
(String pitchExpression) Sets the expression to calculate pitch.void
setRollExpression
(String rollExpression) Sets the expression to calculate roll.
-
Method Details
-
setExtrusionExpression
Sets the expression to calculate extrusion.- Parameters:
extrusionExpression
- expression to calculate extrusion. If null or empty, no extrusion is applied. It is case-insensitive.- Since:
- 100.0.0
-
getExtrusionExpression
Returns the extrusion expression.- Returns:
- the extrusion expression. Returns an empty string by default. If the extrusion expression was set to null
using
setExtrusionExpression(String)
, this returns an empty string. - Since:
- 100.0.0
-
setExtrusionMode
Sets the extrusion mode to be applied.- Parameters:
extrusionMode
- the extrusion mode, can't be null- Throws:
IllegalArgumentException
- if extrusionMode is null- Since:
- 100.0.0
-
getExtrusionMode
Returns the extrusion mode.- Returns:
- the extrusion mode. Returns NONE by default.
- Since:
- 100.0.0
-
setHeadingExpression
Sets the expression to calculate heading.- Parameters:
headingExpression
- expression to calculate heading. If null or empty, no heading is applied. It is case-insensitive.- Since:
- 100.0.0
-
getHeadingExpression
Returns the heading expression.- Returns:
- the heading expression. Returns a empty string by default. If the heading expression was set to null
using
setHeadingExpression(String)
, this returns an empty string. - Since:
- 100.0.0
-
setPitchExpression
Sets the expression to calculate pitch.- Parameters:
pitchExpression
- expression to calculate pitch. If null or empty, no pitch is applied. If null, it is treated as a empty string. It is case-insensitive.- Since:
- 100.0.0
-
getPitchExpression
Returns the pitch expression.- Returns:
- the pitch expression. Returns a empty string by default. If the pitch expression was set to null using
setPitchExpression(String)
, this returns an empty string. - Since:
- 100.0.0
-
setRollExpression
Sets the expression to calculate roll.- Parameters:
rollExpression
- expression to calculate roll. If null or empty, no roll is applied. It is case-insensitive.- Since:
- 100.0.0
-
getRollExpression
Returns the roll expression.- Returns:
- the roll expression. Returns a empty string by default. If the roll expression was set to null using
setRollExpression(String)
, this returns an empty string. - Since:
- 100.0.0
-