Command to specify drawing an icon for a geometry. More...

Inheritance diagram for Luciad.Layers.Features.FeatureCanvas.IconDrawCommand:

Public Member Functions
Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Anchor (Luciad.Geometries.Geometry anchor)
	Sets the anchor of the icon. More...

void	Dispose ()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Draped (bool draped)
	Indicates whether or not the icon should be draped on top of the terrain. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Icon (Luciad.Drawing.IIcon icon)
	Specifies the icon to draw. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	InMeters ()
	Interpret the icon size and offset properties as meters instead of pixels. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	OcclusionMode (Luciad.Layers.Styles.OcclusionMode occlusionMode)
	Determines when this icon should be painted in 3D in relation to other 3D data. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Orientation (Luciad.Cartesian.Azimuth orientation)
	Sets the azimuth towards which the top side of the icon should be oriented. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Position (Luciad.Drawing.RelativePosition position)
	Determines the positioning of the icon, relative to the anchor. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Queryable (bool queryable)
	Indicates whether or not the icon should be considered when a Map::queryFeatures is requested. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Scale (double scaleFactor)
	Applies a scale factor to the icon's size and offsets. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	Size (double width, double height)
	This method overrides the size of the specified icon. More...

void	Submit ()
	Submits this draw command. More...

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand	ZOrder (int zOrder)
	The Z-order of the icon. More...

Detailed Description

Command to specify drawing an icon for a geometry.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand.

Member Function Documentation

◆ Anchor()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Anchor ( Luciad.Geometries.Geometry anchor )

inline

Sets the anchor of the icon.

This property is mandatory. the anchor must be a luciad::Point.

anchor

the anchor of the icon, cannot be nullptr.

this IconDrawCommand.

InvalidArgumentException

if another geometry than a Point is used as anchor.

NullArgumentException

if anchor is nullptr.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::anchor.

◆ Dispose()

void Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Dispose ( )

inline

◆ Draped()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Draped ( bool draped )

inline

Indicates whether or not the icon should be draped on top of the terrain.

Draping means that the icon is painted directly on top of the terrain’s surface relief. By default, an icon is draped if the geometry has a zero Z value. Otherwise it will not be draped. You can override the default behaviour by setting this flag true or false. If you explicitly drape for a 3D point with height, its height is discarded. This setting is only relevant for 3D maps and is ignored for 2D maps.

draped

true if the icon should be draped over terrain.

this IconDrawCommand.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::draped.

◆ Icon()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Icon ( Luciad.Drawing.IIcon icon )

inline

Specifies the icon to draw.

For the best performance, reuse the same IIcon instance when calling this function multiple times.

icon

the icon to draw, cannot be nullptr.

this IconDrawCommand.

luciad::NullArgumentException

when the icon is nullptr.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::icon.

◆ InMeters()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.InMeters ( )

inline

Interpret the icon size and offset properties as meters instead of pixels.

This method is optional. By default, the size and offsets are interpreted as device independent pixels. The icon size and position on the map is determined using the following methods: icon: the icon has a natural size position: contains offsets and alignments size: the icon's size can be overridden scale: the scale is applied on either the icon size, or the overridden size inMeters: the resulting size is interpreted as meters instead of pixels

this IconDrawCommand

2022.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::inMeters.

◆ OcclusionMode()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.OcclusionMode ( Luciad.Layers.Styles.OcclusionMode occlusionMode )

inline

Determines when this icon should be painted in 3D in relation to other 3D data.

Details and limitations:

Mode OcclusionMode::VisibleOnly shows only the part of the icon that is not obscured by other 3D data. This is the default.

Mode OcclusionMode::AlwaysVisible shows the entire icon even if behind other 3D data. The icon will appear in front of other objects.

Mode OcclusionMode::OccludedOnly shows only the part of the icon that is behind other 3D data. You typically use this to display obscured icons in combination with another style that uses OcclusionMode::VisibleOnly mode.

This parameter is only relevant in 3D. It is ignored on a 2D map.

This parameter is only applied on non-draped icons.

The default is OcclusionMode::VisibleOnly.

occlusionMode

the occlusion mode to use

this IconDrawCommand

2023.1.01

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::occlusionMode.

◆ Orientation()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Orientation ( Luciad.Cartesian.Azimuth orientation )

inline

Sets the azimuth towards which the top side of the icon should be oriented.

For example, an azimuth of 0 means that the icon will be painted upright when the North arrow points upwards, but the icon will rotate along when the map is rotated. The anchor point serves as the center of this rotation. If no orientation is specified, the icon will not be oriented and always be displayed with the same angle in view space, independent of how the map is oriented. In order to set the icon's rotation in view space, use position.

orientation

the orientation of the icon.

this IconDrawCommand.

2020.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::orientation.

◆ Position()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Position ( Luciad.Drawing.RelativePosition position )

inline

Determines the positioning of the icon, relative to the anchor.

The offset properties will be interpreted as pixels, or meters. This method is optional: if not specified, the default position as defined in RelativePosition will be used.

position

the positioning of the icon, relative to the anchor.

this IconDrawCommand.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::position.

◆ Queryable()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Queryable ( bool queryable )

inline

Indicates whether or not the icon should be considered when a Map::queryFeatures is requested.

The default is true.

queryable

true if the icon should be considered.

this IconDrawCommand.

2020.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::queryable.

◆ Scale()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Scale ( double scaleFactor )

inline

Applies a scale factor to the icon's size and offsets.

This method is optional. If it is not called, no scaling will be performed (i.e. a scale of 1.0 is used). The icon size and position on the map is determined using the following methods: icon: the icon has a natural size position: contains offsets and alignments size: the icon's size can be overridden scale: the scale is applied on either the icon size, or the overridden size inMeters: the resulting size is interpreted as meters instead of pixels

scaleFactor

the scale factor to apply to the icon's size and offset properties.

this IconDrawCommand

InvalidArgumentException

if a value equal to or smaller than 0 is provided

2022.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::scale.

◆ Size()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Size	(	double	width,
		double	height
	)

inline

This method overrides the size of the specified icon.

This method is optional. If it is not called, the icon's natural size is used. The icon size and position on the map is determined using the following methods: icon: the icon has a natural size position: contains offsets and alignments size: the icon's size can be overridden scale: the scale is applied on either the icon size, or the overridden size inMeters: the resulting size is interpreted as meters instead of pixels

width

the width of the icon, defined in device independent pixels or meters.

height

the height of the icon, defined in device independent pixels or meters.

this IconDrawCommand

InvalidArgumentException

if a value equal to or smaller than 0 is provided

2022.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::size.

◆ Submit()

void Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.Submit ( )

inline

Submits this draw command.

Nothing will be painted if the draw command is not submitted.

luciad::LogicException

when there are missing icon command calls or the command is already submitted.

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::submit.

◆ ZOrder()

Luciad.Layers.Features.FeatureCanvas.IconDrawCommand Luciad.Layers.Features.FeatureCanvas.IconDrawCommand.ZOrder ( int zOrder )

inline

The Z-order of the icon.

DrawCommands are painted from lowest to highest Z-order, so DrawCommands with a higher Z-order are painted on top of DrawCommands with a lower Z-order. Note that the Z-order only affects the ordering of features within the same layer. A feature from a certain layer will always get painted above any other feature from a layer that comes lower in the map's layer order, regardless of what Z-order they may have. The default value is 0.

zOrder

the Z-order of this icon.

this IconDrawCommand.

2020.1

Warning: C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::FeatureCanvas::IconDrawCommand::zOrder.

Public Member Functions

Detailed Description

Member Function Documentation

◆ Anchor()

◆ Dispose()

◆ Draped()

◆ Icon()

◆ InMeters()

◆ OcclusionMode()

◆ Orientation()

◆ Position()

◆ Queryable()

◆ Scale()

◆ Size()

◆ Submit()

◆ ZOrder()