Class PictureMarkerSymbolLayer
- java.lang.Object
-
- com.esri.arcgisruntime.symbology.SymbolLayer
-
- com.esri.arcgisruntime.symbology.MarkerSymbolLayer
-
- com.esri.arcgisruntime.symbology.PictureMarkerSymbolLayer
-
- All Implemented Interfaces:
RemoteResource
,Loadable
public final class PictureMarkerSymbolLayer extends MarkerSymbolLayer implements Loadable, RemoteResource
PictureMarkerSymbolLayers can be used to symbolize point geometries with an image.They can be created from files, URLs or Drawables.
Picture marker symbol layers are loadable as retrieving the image data may require a network request or take time to complete. They are auto-loaded when they are drawn in a MapView or SceneView.
- Since:
- 100.5.0
-
-
Constructor Summary
Constructors Constructor Description PictureMarkerSymbolLayer(java.lang.String uri)
Instantiates a PictureMarkerSymbolLayer with a URI to an image.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDoneLoadingListener(java.lang.Runnable listener)
Adds a listener to the loadable resource that is invoked when loading has completed.void
addLoadStatusChangedListener(LoadStatusChangedListener listener)
Adds aLoadStatusChangedListener
to the loadable resource that is invoked whenever the load status changes.void
cancelLoad()
Cancels loading metadata for the object.static ListenableFuture<PictureMarkerSymbolLayer>
createAsync(android.graphics.drawable.BitmapDrawable drawable)
Asynchronously creates a PictureMarkerSymbolLayer with a BitmapDrawable image.Credential
getCredential()
Gets theCredential
that is set on the network-enabled resource.android.graphics.drawable.BitmapDrawable
getImage(android.content.res.Resources resources)
Gets the image used to visualize this PictureMarkerSymbolLayer as a BitmapDrawable.ArcGISRuntimeException
getLoadError()
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.LoadStatus
getLoadStatus()
Returns theLoadStatus
of the loadable resource.RequestConfiguration
getRequestConfiguration()
Gets theRequestConfiguration
used to modify the parameters of network requests made by thisRemoteResource
.int
getTintColor()
Gets the tint color of a picture marker symbol layer.java.lang.String
getUri()
Gets the URI of thisRemoteResource
.void
loadAsync()
Loads the metadata of the loadable resource asynchronously.boolean
removeDoneLoadingListener(java.lang.Runnable listener)
Removes a done loading listener from the loadable resource.boolean
removeLoadStatusChangedListener(LoadStatusChangedListener listener)
Removes aLoadStatusChangedListener
from the loadable resource.void
retryLoadAsync()
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
setTintColor(int color)
Sets the tint color of a picture marker symbol layer.-
Methods inherited from class com.esri.arcgisruntime.symbology.MarkerSymbolLayer
getAnchor, getHeading, getOffsetX, getOffsetY, getSize, setAnchor, setHeading, setOffsetX, setOffsetY, setSize
-
Methods inherited from class com.esri.arcgisruntime.symbology.SymbolLayer
isColorLocked, isEnabled, setColorLocked, setEnabled
-
-
-
-
Constructor Detail
-
PictureMarkerSymbolLayer
public PictureMarkerSymbolLayer(java.lang.String uri)
Instantiates a PictureMarkerSymbolLayer with a URI to an image. This can either be a file path or a URL.- Parameters:
uri
- URI to be used for the symbol- Throws:
java.lang.IllegalArgumentException
- if uri is null or empty- Since:
- 100.5.0
-
-
Method Detail
-
createAsync
public static ListenableFuture<PictureMarkerSymbolLayer> createAsync(android.graphics.drawable.BitmapDrawable drawable)
Asynchronously creates a PictureMarkerSymbolLayer with a BitmapDrawable image. The PictureMarkerSymbolLayer will inherit the alpha property from the BitmapDrawable in cases where it is set prior to instantiation.- Parameters:
drawable
- drawable to be used for the symbol layer- Returns:
- a ListenableFuture that provides a PictureMarkerSymbolLayer upon successful completion of the async operation
- Throws:
java.lang.IllegalArgumentException
- if drawable is null- Since:
- 100.5.0
-
getImage
public android.graphics.drawable.BitmapDrawable getImage(android.content.res.Resources resources)
Gets the image used to visualize this PictureMarkerSymbolLayer as a BitmapDrawable.- Parameters:
resources
- the application Resources object- Returns:
- the image as a BitmapDrawable
- Since:
- 100.5.0
-
setTintColor
public void setTintColor(int color)
Sets the tint color of a picture marker symbol layer.The tint color is applied to the entire image by multiplying each RGB color channel in the image by the corresponding color channel of the tint color. The default tint color is white with 100% opacity, i.e. ARGB(255, 255, 255, 255), which leaves the image with its native colors. A white tint color with opacity less than 100% tints the image white, with the reduced opacity respected.
- Parameters:
color
- an integer representing the interior color as 0xAARRGGBB- Since:
- 100.6.0
-
getTintColor
public int getTintColor()
Gets the tint color of a picture marker symbol layer.The tint color is applied to the entire image by multiplying each RGB color channel in the image by the corresponding color channel of the tint color. The default tint color is white with 100% opacity, i.e. ARGB(255, 255, 255, 255), which leaves the image with its native colors. A white tint color with opacity less than 100% tints the image white, with the reduced opacity respected.
- Returns:
- an integer representing the interior color as 0xAARRGGBB
- Since:
- 100.6.0
-
getCredential
public Credential 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
public void setCredential(Credential credential)
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
public RequestConfiguration 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
public void setRequestConfiguration(RequestConfiguration requestConfiguration)
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
-
getUri
public java.lang.String getUri()
Description copied from interface:RemoteResource
Gets the URI of thisRemoteResource
. Typically this is the URI used to instantiate the object.- Specified by:
getUri
in interfaceRemoteResource
- Returns:
- the URI of this RemoteResource
-
getLoadStatus
public LoadStatus getLoadStatus()
Description copied from interface:Loadable
Returns theLoadStatus
of the loadable resource.- Specified by:
getLoadStatus
in interfaceLoadable
- Returns:
- the LoadStatus of the loadable resource
-
getLoadError
public ArcGISRuntimeException getLoadError()
Description copied from interface:Loadable
Returns the most recent error that was encountered when the loadable resource transitioned to theLoadStatus.FAILED_TO_LOAD
state, either due to calling theLoadable.loadAsync()
orLoadable.retryLoadAsync()
method.If the resource subsequently transitions to
LoadStatus.LOADED
(for example, if a call toretryLoadAsync
completes successfully) the error is cleared out.- Specified by:
getLoadError
in interfaceLoadable
- Returns:
- the most recent error that was encountered when the loadable resource transitioned to the
LoadStatus.FAILED_TO_LOAD
state.
-
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
-
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
-
addDoneLoadingListener
public void addDoneLoadingListener(java.lang.Runnable listener)
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, use the
Loadable.addLoadStatusChangedListener(LoadStatusChangedListener)
method instead.- Specified by:
addDoneLoadingListener
in interfaceLoadable
- Parameters:
listener
- a Runnable that is invoked upon completion of the load operation
-
removeDoneLoadingListener
public boolean removeDoneLoadingListener(java.lang.Runnable listener)
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
public void addLoadStatusChangedListener(LoadStatusChangedListener listener)
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
public boolean removeLoadStatusChangedListener(LoadStatusChangedListener listener)
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
-
-