Skip To Content ArcGIS for Developers Sign In Dashboard

ModelSceneSymbol Class

class Esri::ArcGISRuntime::ModelSceneSymbol

Used to display Point or Multipoint GeoElements in a scene using a 3D model. More...

Header: #include <ModelSceneSymbol>
Since: Esri::ArcGISRuntime 100.0
Inherits: Esri::ArcGISRuntime::MarkerSceneSymbol, Esri::ArcGISRuntime::Loadable, and Esri::ArcGISRuntime::RemoteResource

This class was introduced in Esri::ArcGISRuntime 100.0.

Public Functions

ModelSceneSymbol(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, float scale, QObject *parent = nullptr)
ModelSceneSymbol(const QUrl &url, float scale, QObject *parent = nullptr)
ModelSceneSymbol(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)
ModelSceneSymbol(const QUrl &url, QObject *parent = nullptr)
virtual ~ModelSceneSymbol() override
float scale() const
void setSymbolSizeUnits(Esri::ArcGISRuntime::SymbolSizeUnits sizeUnits)
Esri::ArcGISRuntime::SymbolSizeUnits symbolSizeUnits() const

Reimplemented Public Functions

virtual void cancelLoad() override
virtual Esri::ArcGISRuntime::Credential *credential() const override
virtual void load() override
virtual Esri::ArcGISRuntime::Error loadError() const override
virtual Esri::ArcGISRuntime::LoadStatus loadStatus() const override
virtual Esri::ArcGISRuntime::RequestConfiguration requestConfiguration() const override
virtual void retryLoad() override
virtual void setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration) override
virtual QUrl url() const override

Signals

void doneLoading(Esri::ArcGISRuntime::Error loadError)
void loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Detailed Description

A model symbol is used to provide a realistic three-dimensional visualization to symbolize scene features. Create a ModelSceneSymbol using a 3D model file, passing the URL of the file and a scale factor to the model symbol constructor. Depending on the model file's default orientation, you may have to rotate the symbol to get your model in the desired orientation. Note that ModelSceneSymbol will not display using static rendering mode. The symbol will be positioned using the centroid of the model object, and this may not be the same as the center of its bounding extent. Refer to the {https://developers.arcgis.com/qt/latest/qml/guide/symbol-types-described.htm}{Symbol types} topic in the developers guide for information about supported 3D model types.

Example:

Create a ModelSceneSymbol from a *.dae file:

constexpr float scale = 5.0f;
ModelSceneSymbol* mms = new ModelSceneSymbol(QUrl(dataPath), scale, this);
mms->setHeading(180);

Member Function Documentation

ModelSceneSymbol::ModelSceneSymbol(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, float scale, QObject *parent = nullptr)

Constructs a model scene symbol by providing a url, credential, scale factor, and an optional parent.

ModelSceneSymbol::ModelSceneSymbol(const QUrl &url, float scale, QObject *parent = nullptr)

Constructs a model scene symbol by providing a url, scale factor, and an optional parent.

ModelSceneSymbol::ModelSceneSymbol(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Constructs a model scene symbol by providing a url, credential, and an optional parent.

ModelSceneSymbol::ModelSceneSymbol(const QUrl &url, QObject *parent = nullptr)

Constructs a model scene symbol by providing a url and an optional parent.

[signal] void ModelSceneSymbol::doneLoading(Esri::ArcGISRuntime::Error loadError)

Signal emitted when this object is done loading.

  • loadError - Details about any error that may have occurred.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[signal] void ModelSceneSymbol::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the load status changes for this object.

See also Loadable.

[override virtual] ModelSceneSymbol::~ModelSceneSymbol()

Destructor.

[override virtual] void ModelSceneSymbol::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Credential *ModelSceneSymbol::credential() const

Reimplements: RemoteResource::credential() const.

Returns the credential of the symbol.

[override virtual] void ModelSceneSymbol::load()

Reimplements: Loadable::load().

See Loadable.

[override virtual] Esri::ArcGISRuntime::Error ModelSceneSymbol::loadError() const

Reimplements: Loadable::loadError() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::LoadStatus ModelSceneSymbol::loadStatus() const

Reimplements: Loadable::loadStatus() const.

See Loadable.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration ModelSceneSymbol::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this symbol.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setRequestConfiguration().

[override virtual] void ModelSceneSymbol::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

float ModelSceneSymbol::scale() const

Returns the scale factor of the symbol.

[override virtual] void ModelSceneSymbol::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this symbol to requestConfiguration.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also requestConfiguration().

void ModelSceneSymbol::setSymbolSizeUnits(Esri::ArcGISRuntime::SymbolSizeUnits sizeUnits)

Sets the symbol size units of the model symbol using the specified sizeUnits.

Default is SymbolSizeUnits::Meters

Renders the symbol by interpreting the size values as DIPs or Meters.

This function was introduced in Esri::ArcGISRuntime 100.5.

See also symbolSizeUnits().

Esri::ArcGISRuntime::SymbolSizeUnits ModelSceneSymbol::symbolSizeUnits() const

Returns the symbol size units of the model symbol.

This function was introduced in Esri::ArcGISRuntime 100.5.

See also setSymbolSizeUnits().

[override virtual] QUrl ModelSceneSymbol::url() const

Reimplements: RemoteResource::url() const.

Returns the url of the symbol.


Feedback on this topic?