Package com.esri.arcgisruntime.symbology
Class Renderer.SceneProperties
- java.lang.Object
-
- com.esri.arcgisruntime.symbology.Renderer.SceneProperties
-
- Enclosing class:
- Renderer
public static final class Renderer.SceneProperties extends Object
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 aGeoElementand then adds 180 to it.setHeadingExpression("heading + 180"); // "heading" is a attribute nameNotes:
- When extrusion is applied to points, they are always extruded as cylinders irrespective of
SimpleMarkerSymbol.Style
- Since:
- 100.0.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classRenderer.SceneProperties.ExtrusionModeExtrusion mode to be applied to aGeoElement.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetExtrusionExpression()Returns the extrusion expression.Renderer.SceneProperties.ExtrusionModegetExtrusionMode()Returns the extrusion mode.StringgetHeadingExpression()Returns the heading expression.StringgetPitchExpression()Returns the pitch expression.StringgetRollExpression()Returns the roll expression.voidsetExtrusionExpression(String extrusionExpression)Sets the expression to calculate extrusion.voidsetExtrusionMode(Renderer.SceneProperties.ExtrusionMode extrusionMode)Sets the extrusion mode to be applied.voidsetHeadingExpression(String headingExpression)Sets the expression to calculate heading.voidsetPitchExpression(String pitchExpression)Sets the expression to calculate pitch.voidsetRollExpression(String rollExpression)Sets the expression to calculate roll.
-
-
-
Method Detail
-
setExtrusionExpression
public void setExtrusionExpression(String extrusionExpression)
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
public String 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
public void setExtrusionMode(Renderer.SceneProperties.ExtrusionMode extrusionMode)
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
public Renderer.SceneProperties.ExtrusionMode getExtrusionMode()
Returns the extrusion mode.- Returns:
- the extrusion mode. Returns NONE by default.
- Since:
- 100.0.0
-
setHeadingExpression
public void setHeadingExpression(String headingExpression)
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
public String 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
public void setPitchExpression(String pitchExpression)
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
public String 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
public void setRollExpression(String rollExpression)
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
public String 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
-
-