Skip To Content ArcGIS for Developers Sign In Dashboard

RendererSceneProperties Class

class Esri::ArcGISRuntime::RendererSceneProperties

3D rendering properties for features or graphics in a Scene. More...

Header: #include <RendererSceneProperties>
Since: Esri::ArcGISRuntime 100.0

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

RendererSceneProperties(Esri::ArcGISRuntime::RendererSceneProperties &&other)
RendererSceneProperties(const Esri::ArcGISRuntime::RendererSceneProperties &other)
RendererSceneProperties(const QString &headingExpression, const QString &pitchExpression, const QString &rollExpression)
RendererSceneProperties(const QString &extrusionExpression, Esri::ArcGISRuntime::ExtrusionMode extrusionMode)
Esri::ArcGISRuntime::RendererSceneProperties &operator=(Esri::ArcGISRuntime::RendererSceneProperties &&other)
Esri::ArcGISRuntime::RendererSceneProperties &operator=(const Esri::ArcGISRuntime::RendererSceneProperties &other)
~RendererSceneProperties()
QString extrusionExpression() const
Esri::ArcGISRuntime::ExtrusionMode extrusionMode() const
QString headingExpression() const
bool isEmpty() const
QString pitchExpression() const
QString rollExpression() const
void setExtrusionExpression(const QString &extrusionExpression)
void setExtrusionMode(Esri::ArcGISRuntime::ExtrusionMode extrusionMode)
void setHeadingExpression(const QString &headingExpression)
void setPitchExpression(const QString &pitchExpression)
void setRollExpression(const QString &rollExpression)

Detailed Description

This class represents a group of renderer properties that only apply to features or graphics in an Scene.

Member Function Documentation

RendererSceneProperties::RendererSceneProperties(Esri::ArcGISRuntime::RendererSceneProperties &&other)

Move constructor from other RendererSceneProperties.

RendererSceneProperties::RendererSceneProperties(const Esri::ArcGISRuntime::RendererSceneProperties &other)

Copy constructor from other RendererSceneProperties.

RendererSceneProperties::RendererSceneProperties(const QString &headingExpression, const QString &pitchExpression, const QString &rollExpression)

Constructor with a headingExpression, a pitchExpression, and a rollExpression.

RendererSceneProperties::RendererSceneProperties(const QString &extrusionExpression, Esri::ArcGISRuntime::ExtrusionMode extrusionMode)

Constructor with an extrusionExpression and an extrusionMode.

Esri::ArcGISRuntime::RendererSceneProperties &RendererSceneProperties::operator=(Esri::ArcGISRuntime::RendererSceneProperties &&other)

Move operator from other RendererSceneProperties.

Esri::ArcGISRuntime::RendererSceneProperties &RendererSceneProperties::operator=(const Esri::ArcGISRuntime::RendererSceneProperties &other)

Assignment operator from other RendererSceneProperties.

RendererSceneProperties::~RendererSceneProperties()

Destructor.

QString RendererSceneProperties::extrusionExpression() const

Gets the extrusion expression.

See also setExtrusionExpression().

Esri::ArcGISRuntime::ExtrusionMode RendererSceneProperties::extrusionMode() const

Gets the extrusion mode.

See also setExtrusionMode().

QString RendererSceneProperties::headingExpression() const

Gets the heading expression.

See also setHeadingExpression().

bool RendererSceneProperties::isEmpty() const

Returns whether the class is empty.

A RendererSceneProperties is considered empty when it contains no set properties.

QString RendererSceneProperties::pitchExpression() const

Gets the pitch expression.

See also setPitchExpression().

QString RendererSceneProperties::rollExpression() const

Gets the roll expression.

See also setRollExpression().

void RendererSceneProperties::setExtrusionExpression(const QString &extrusionExpression)

Sets the extrusion expression to extrusionExpression.

An extrusion expression specifies the z-direction extrusion distance for the feature or graphic. The expression often contains the name of the attribute of the feature or graphic.

For example, the expression "[storeys] * 3.5" indicates that the renderer will look up the value of the "storeys" attribute and multiplies it by 3.5.

Note: This type of expression only works for extrusion, not for 3D rotations.

When extrusion is applied to points, they are always extruded as cylinders irrespective of the style.

See also extrusionExpression().

void RendererSceneProperties::setExtrusionMode(Esri::ArcGISRuntime::ExtrusionMode extrusionMode)

Sets the extrusion mode to extrusionMode.

See also extrusionMode().

void RendererSceneProperties::setHeadingExpression(const QString &headingExpression)

Sets the heading expression to headingExpression.

A heading expression specifies the value or attribute the renderer will use for the heading of the feature or graphic. For attributes, the name of the attribute should be in square brackets, such as "[heading]".

See also headingExpression().

void RendererSceneProperties::setPitchExpression(const QString &pitchExpression)

Sets the pitch expression to pitchExpression.

A pitch expression specifies the value or attribute the renderer will use for the pitch of the feature or graphic. For attributes, the name of the attribute should be in square brackets, such as "[pitch]".

See also pitchExpression().

void RendererSceneProperties::setRollExpression(const QString &rollExpression)

Sets the roll expression to rollExpression.

A roll expression specifies the value or attribute the renderer will use for the roll of the feature or graphic. For attributes, the name of the attribute should be in square brackets, such as "[roll]".

See also rollExpression().


Feedback on this topic?