- All Implemented Interfaces:
JsonSerializable
,RemoteResource
,Loadable
SceneView
.
Model symbols are used to provide realistic three-dimensional visualizations to symbolize
scene features. Create a ModelSceneSymbol using a 3D model file, passing the URI of the file, and
a scale factor, to the constructor ModelSceneSymbol(String, double)
. The supported model
file types include Collada (.dae) and 3D Max (.3ds).
Depending on the model's default orientation, you may have to change the
heading
, pitch
,
and roll
of the symbol to display the model in the
desired orientation.
By default, the symbol will be positioned using the centroid of the model object. Note that this
may not be the same as the center of its bounding extent. Model scene symbols cannot be used with
a static graphics rendering mode (GraphicsOverlay.RenderingMode.STATIC
).
The supported model file types are:
- 3D Max (.3ds)
- Collada (.dae)
- Filmbox (.fbx)
- GL Transmission Format (.gltf, .glb)
- Wavefront (.obj)
Depending on the model's default orientation, you may have to change the heading, pitch, and roll of the symbol to display the model in the desired orientation.
Note that ModelSceneSymbol will not display using static rendering mode (rendering modes apply
to both feature layers
and graphics overlays
).
- Since:
- 100.0.0
- See Also:
-
Property Summary
TypePropertyDescriptionThe load error.The load status.Properties inherited from class com.esri.arcgisruntime.symbology.MarkerSceneSymbol
color
-
Nested Class Summary
Nested classes/interfaces inherited from class com.esri.arcgisruntime.symbology.SceneSymbol
SceneSymbol.AnchorPosition
-
Field Summary
Fields inherited from class com.esri.arcgisruntime.symbology.MarkerSceneSymbol
DEFAULT_ANCHOR_POSITION
-
Constructor Summary
ConstructorDescriptionModelSceneSymbol
(String uri) Creates a model scene symbol from a URI to a 3D model file.ModelSceneSymbol
(String uri, double scale) Creates a model scene symbol from a URI to a 3D model file along with a scale. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDoneLoadingListener
(Runnable listener) Adds a listener to the loadable resource that is invoked when loading has completed.void
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
Cancels loading metadata for the object.Gets theCredential
that is set on the network-enabled resource.Gets the value of theloadError
property.Gets the value of theloadStatus
property.Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.Gets the size unit of the model scene symbol.getUri()
Returns the URI of the model file used to display this symbol.void
Loads the metadata of the loadable resource asynchronously.The load error.The load status.boolean
removeDoneLoadingListener
(Runnable listener) Removes a done loading listener from the loadable resource.boolean
Removes aLoadStatusChangedListener
from the loadable resource.void
Loads or retries loading metadata for the object asynchronously.void
setCredential
(Credential credential) Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge.void
setRequestConfiguration
(RequestConfiguration requestConfiguration) Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.void
setSymbolSizeUnits
(SymbolSizeUnits symbolSizeUnits) Sets the size unit of the model scene symbol.Methods inherited from class com.esri.arcgisruntime.symbology.MarkerSceneSymbol
colorProperty, getAnchorPosition, getColor, getDepth, getHeading, getHeight, getPitch, getRoll, getWidth, setAnchorPosition, setColor, setColor, setDepth, setHeading, setHeight, setPitch, setRoll, setWidth
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
-
loadStatus
- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadError
- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
-
Constructor Details
-
ModelSceneSymbol
Creates a model scene symbol from a URI to a 3D model file.- Parameters:
uri
- URI of the 3D model file- Throws:
IllegalArgumentException
- if uri is null or empty- Since:
- 200.2.0
-
ModelSceneSymbol
Creates a model scene symbol from a URI to a 3D model file along with a scale.The supported model file types include Collada (.dae) and 3D Max (.3ds).
- Parameters:
uri
- URI of the 3D model filescale
- the scale factor to apply when displaying the model- Throws:
IllegalArgumentException
- if uri is null or emptyIllegalArgumentException
- if scale is less than or equal to zero- Since:
- 100.0.0
-
-
Method Details
-
getUri
Returns the URI of the model file used to display this symbol.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of the model file.
- Since:
- 100.0.0
-
getSymbolSizeUnits
Gets the size unit of the model scene symbol. The default value isSymbolSizeUnits.METERS
- Returns:
- the symbol size units
- Since:
- 100.5.0
-
setSymbolSizeUnits
Sets the size unit of the model scene symbol. The size unit affects how the symbols are scaled when the camera distance changes.- Parameters:
symbolSizeUnits
- the symbol size units- Throws:
IllegalArgumentException
- if symbolSizeUnits is null- Since:
- 100.5.0
-
getLoadStatus
Gets the value of theloadStatus
property.- Specified by:
getLoadStatus
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadStatus
property - See Also:
-
getLoadError
Gets the value of theloadError
property.- Specified by:
getLoadError
in interfaceLoadable
- Property description:
- Returns:
- the value of the
loadError
property - See Also:
-
loadAsync
public void loadAsync()Description copied from interface:Loadable
Loads the metadata of the loadable resource asynchronously.The load status changes from
LoadStatus.NOT_LOADED
toLoadStatus.LOADING
. A listener can be added viaLoadable.addDoneLoadingListener(java.lang.Runnable)
that is invoked upon completion of the asynchronous load operation.If the load operation completes successfully, the load status will be
LoadStatus.LOADED
, which means the resource has loaded its metadata.If the load operation failed, the load status will be
LoadStatus.FAILED_TO_LOAD
and the error can be retrieved by callingLoadable.getLoadError()
.This method can be called concurrently and repeatedly, but only one attempt is ever made to perform the load operation. If a load operation is already in progress (
LoadStatus.LOADING
state) whenloadAsync
is called, it simply piggy-backs on the outstanding operation and the done loading listener added to the loadable resource is enqueued to be invoked when that operation completes. If the operation has already completed (LoadStatus.LOADED
orLoadStatus.FAILED_TO_LOAD
state) whenloadAsync
is called, the done loading listener is immediately invoked when added to the loadable resource.If a loadable resource has failed to load, calling
loadAsync
on it subsequently will not change its state. The done loading listener will be invoked immediately when added to the loadable resource. In order to retry loading the resource,Loadable.retryLoadAsync()
needs to be used.A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by callingLoadable.cancelLoad()
. -
retryLoadAsync
public void retryLoadAsync()Description copied from interface:Loadable
Loads or retries loading metadata for the object asynchronously.Will retry loading the metadata if the object's load status is
LoadStatus.FAILED_TO_LOAD
. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded.For more details on the load process see
Loadable.loadAsync()
.- Specified by:
retryLoadAsync
in interfaceLoadable
-
cancelLoad
public void cancelLoad()Description copied from interface:Loadable
Cancels loading metadata for the object.Cancels loading the metadata if the object is loading, and always invokes the done loading listener.
A load operation that is in progress (
LoadStatus.LOADING
state) can be cancelled by calling this method and the resource will transition fromLoadStatus.LOADING
toLoadStatus.FAILED_TO_LOAD
state. If the load operation was successfully cancelled, a CancellationException will be returned fromLoadable.getLoadError()
.Cancellation should be used carefully because all enqueued done loading listeners for that resource instance will get invoked with an error stating that the operation was cancelled. Thus, one component in the application can cancel the load operation initiated by other components.
This method does nothing if the resource is not in
LoadStatus.LOADING
state.- Specified by:
cancelLoad
in interfaceLoadable
-
addDoneLoadingListener
Description copied from interface:Loadable
Adds a listener to the loadable resource that is invoked when loading has completed.The listener may be added at any point, whether the loadable resource has already completed loading or not.
- For resources that are not loaded when the listener is added (LoadStatus is NOT_LOADED or LOADING): When the resource completes loading, the listener will be invoked on the UI thread if it is added from the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
- For resources that are already loaded when the listener is added (LoadStatus is LOADED or FAILED_TO_LOAD): The listener will be called immediately, on the current thread.
Alternatively, to be notified when there is any change in the load status, add a listener to the
Loadable.loadStatusProperty()
instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
Description copied from interface:Loadable
Removes a done loading listener from the loadable resource.- Specified by:
removeDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- the listener to be removed- Returns:
- true if the listener was removed, otherwise false
-
addLoadStatusChangedListener
Description copied from interface:Loadable
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.Adding this listener on the UI thread will cause it to be invoked on the UI thread, otherwise it is not guaranteed on which thread the listener is invoked.
The listener will not be called if added to a loadable resource that has already completed loading. To be notified when a loadable resource has completed loading, including if the resource is already loaded when the listener is added, use the
Loadable.addDoneLoadingListener(Runnable)
method.- Specified by:
addLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be added
-
removeLoadStatusChangedListener
Description copied from interface:Loadable
Removes aLoadStatusChangedListener
from the loadable resource.- Specified by:
removeLoadStatusChangedListener
in interfaceLoadable
- Parameters:
listener
- theLoadStatusChangedListener
to be removed- Returns:
- true if the listener was removed, otherwise false
-
loadStatusProperty
Description copied from interface:Loadable
The load status.- Specified by:
loadStatusProperty
in interfaceLoadable
- Returns:
- the
loadStatus
property - See Also:
-
loadErrorProperty
Description copied from interface:Loadable
The load error.- Specified by:
loadErrorProperty
in interfaceLoadable
- Returns:
- the
loadError
property - See Also:
-
getCredential
Description copied from interface:RemoteResource
Gets theCredential
that is set on the network-enabled resource.Only applicable if the resource is secured.
- Specified by:
getCredential
in interfaceRemoteResource
- Returns:
- the Credential, or null if there is none
-
setCredential
Description copied from interface:RemoteResource
Sets aCredential
to be used by the network-enabled resource in the event of an authentication challenge. The default credential is null.Only applicable if the resource is secured.
- Specified by:
setCredential
in interfaceRemoteResource
- Parameters:
credential
- the Credential to be used for authentication
-
getRequestConfiguration
Description copied from interface:RemoteResource
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.- Specified by:
getRequestConfiguration
in interfaceRemoteResource
- Returns:
- the
RequestConfiguration
used to modify network requests
-
setRequestConfiguration
Description copied from interface:RemoteResource
Sets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
. If not set, the globalRequestConfiguration
will be used (seeRequestConfiguration.getGlobalRequestConfiguration()
).- Specified by:
setRequestConfiguration
in interfaceRemoteResource
- Parameters:
requestConfiguration
- the RequestConfiguration used to modify network requests
-