Implements the anchor of a symbol layer, including placement mode and x and y anchor values. More...
| Header | #include <Symbol |
| Since | Esri |
Public Functions
| Symbol | |
| Symbol | |
(since Esri | Symbol |
| Symbol | |
| Symbol | |
| ~ | |
| bool | is |
| Esri | placement |
| double | x() const |
| double | y() const |
(since Esri double | z() const |
| Esri | operator=( |
| Esri | operator=(const Esri |
Detailed Description
SymbolAnchor contains the properties necessary to define the anchor for a symbol layer. These anchor properties define both the anchor values (x, y, z) and the placement mode. This object can be passed to MarkerSymbolLayer objects to control marker anchor properties.
Member Function Documentation
SymbolAnchor::SymbolAnchor ()
Default constructor.
Warning: This is for convenience only and will construct an empty object.
SymbolAnchor::SymbolAnchor (double x, double y, Esri::ArcGISRuntime::SymbolAnchorPlacementMode placementMode )
Contructor that takes x, y, and placementMode properties.
[since Esri::ArcGISRuntime 300.0] SymbolAnchor::SymbolAnchor (double x, double y, double z, Esri::ArcGISRuntime::SymbolAnchorPlacementMode placementMode )
Creates a symbol anchor and sets up the properties.
- x - The x-component of the anchor point.
- y - The y-component of the anchor point.
- z - The z-component of the anchor point.
- placementMode - The anchor placement mode to use for the anchor values.
The function sets up the SymbolAnchor with the provided arguments.
This function was introduced in Esri::ArcGISRuntime 300.0.
SymbolAnchor::SymbolAnchor (const Esri::ArcGISRuntime::SymbolAnchor &other)
Copy constructor from other SymbolAnchor.
[noexcept] SymbolAnchor::SymbolAnchor (Esri::ArcGISRuntime::SymbolAnchor &&other)
Move constructor from other SymbolAnchor.
[noexcept] SymbolAnchor::~SymbolAnchor ()
Destructor.
bool SymbolAnchor::isEmpty () const
Returns true if this is an empty object.
A default constructed SymbolAnchor is considered empty.
Esri::ArcGISRuntime::SymbolAnchorPlacementMode SymbolAnchor::placementMode () const
Returns the anchor placement mode of the symbol anchor object.
The SymbolAnchorPlacementMode determines how this API interprets the SymbolAnchor anchor values. See the SymbolAnchorPlacementMode documentation for a description of the effects of each mode. The default mode is 'relative.'
double SymbolAnchor::x() const
Returns the x-component of the symbol anchor object.
The x-component of the SymbolAnchor can be any real number. The units of the value depend on the anchor placement mode of the SymbolAnchor. The default value is 0, regardless of placement mode.
double SymbolAnchor::y() const
Returns the y-component of the symbol anchor object.
The y-component of the SymbolAnchor can be any real number. The units of the value depend on the anchor placement mode of the SymbolAnchor. The default value is 0, regardless of placement mode.
[since Esri::ArcGISRuntime 300.0] double SymbolAnchor::z() const
Returns the z-component of the symbol anchor object.
The z-component of the SymbolAnchor can be any real number. The units of the value depend on the anchor placement mode of the SymbolAnchor. The default value is 0, regardless of placement mode. A positive z-component will adjust the anchor point of the symbol in the positive-z direction. This has the visual effect of pushing the marker in the negative-z direction, since the anchor remains on the location of the marker. The z-component of the anchor only has a rendering effect in a scene view.
This function was introduced in Esri::ArcGISRuntime 300.0.
[noexcept] Esri::ArcGISRuntime::SymbolAnchor &SymbolAnchor::operator=(Esri::ArcGISRuntime::SymbolAnchor &&other)
Move operator from other SymbolAnchor.
Esri::ArcGISRuntime::SymbolAnchor &SymbolAnchor::operator=(const Esri::ArcGISRuntime::SymbolAnchor &other)
Assignment operator from other SymbolAnchor.