Luciad.Layers.Features.FeatureCanvas.TextDrawCommand Class Reference

Command to specify drawing text for a geometry. More...

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

Public Member Functions
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Anchor (Luciad.Geometries.Geometry anchor)
	Sets the anchor of the text. More...
void	Dispose ()
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Draped (bool draped)
	Indicates whether or not the text should be draped on top of the terrain. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	InMeters ()
	Interpret the text size and offset properties as meters instead of pixels. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	OcclusionMode (Luciad.Layers.Styles.OcclusionMode occlusionMode)
	Determines when this text should be painted in 3D in relation to other 3D data. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Orientation (Luciad.Cartesian.Azimuth orientation)
	Sets the azimuth towards which the top side of the text should be oriented. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Position (Luciad.Drawing.RelativePosition position)
	Determines the positioning of the text, relative to the anchor. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Queryable (bool queryable)
	Indicates whether or not the text should be considered when a Map::queryFeatures is requested. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Scale (double scaleFactor)
	Applies a scale factor to the text size and offsets. More...
void	Submit ()
	Submits this draw command. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Text (string text)
	Sets the text to draw. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	Text (System.Collections.Generic.IList< string > text, Luciad.Drawing.HorizontalAlignment alignment=Luciad.Drawing.HorizontalAlignment.Left)
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	TextStyle (Luciad.Text.TextStyle textStyle)
	Sets the styling for the text. More...
Luciad.Layers.Features.FeatureCanvas.TextDrawCommand	ZOrder (int zOrder)
	The Z-order of the text. More...

Detailed Description

Command to specify drawing text for a geometry.

Warning

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

Member Function Documentation

Anchor()

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

inline

Sets the anchor of the text.

This property is mandatory.

anchor

the anchor of the text, cannot be nullptr. The anchor must be a luciad::Point.

this TextDrawCommand.

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::TextDrawCommand::anchor.

Dispose()

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

inline

Draped()

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

inline

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

Draping means that the text is painted directly on top of the terrain’s surface relief. By default, text is not draped. This setting is only relevant for 3D maps and is ignored for 2D maps.

draped

true if the text should be draped over terrain.

this TextDrawCommand.

2022.1.04

Warning

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

InMeters()

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

inline

Interpret the text 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 text size and position on the map is determined using the following methods: textStyle: the font size. position: contains offsets and alignments. inMeters: the resulting size is interpreted as meters instead of pixels.

this TextDrawCommand

2022.1

Warning

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

OcclusionMode()

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

inline

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

Details and limitations:

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

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

Mode OcclusionMode::OccludedOnly shows only the part of the text that is behind other 3D data. You typically use this to display obscured text 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 text.

The default is OcclusionMode::VisibleOnly.

occlusionMode

the occlusion mode to use

this TextDrawCommand

2023.1.01

Warning

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

Orientation()

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

inline

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

For example, an azimuth of 0 means that the text will be painted upright when the North arrow points upwards, but the text will rotate along when the map is rotated. The anchor point serves as the center of this rotation. If no orientation is specified, the text 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 text's rotation in view space, use position.

orientation

the orientation of the text.

this TextDrawCommand.

2020.1

Warning

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

Position()

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

inline

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

The offset properties will be interpreted as device independent 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::TextDrawCommand::position.

Queryable()

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

inline

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

The default is true.

queryable

true if the text should be considered.

this TextDrawCommand.

2020.1

Warning

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

Scale()

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

inline

Applies a scale factor to the text 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 text size and position on the map is determined using the following methods: textStyle: the font size. position: contains offsets and alignments. inMeters: the resulting size is interpreted as meters instead of pixels.

scaleFactor

the scale factor to apply to the text size and offset properties.

this TextDrawCommand

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::TextDrawCommand::scale.

Submit()

void Luciad.Layers.Features.FeatureCanvas.TextDrawCommand.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::TextDrawCommand::submit.

Text() [1/2]

Luciad.Layers.Features.FeatureCanvas.TextDrawCommand Luciad.Layers.Features.FeatureCanvas.TextDrawCommand.Text ( string  text )

inline

Sets the text to draw.

This property is mandatory.

text

the text to draw.

this TextDrawCommand.

Warning

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

Text() [2/2]

Luciad.Layers.Features.FeatureCanvas.TextDrawCommand Luciad.Layers.Features.FeatureCanvas.TextDrawCommand.Text ( System.Collections.Generic.IList< string >  text, Luciad.Drawing.HorizontalAlignment  alignment = Luciad.Drawing.HorizontalAlignment.Left  )

inline

TextStyle()

Luciad.Layers.Features.FeatureCanvas.TextDrawCommand Luciad.Layers.Features.FeatureCanvas.TextDrawCommand.TextStyle ( Luciad.Text.TextStyle  textStyle )

inline

Sets the styling for the text.

This property is optional. See the text style builder for the default values.

textStyle

the styling for the text, cannot be nullptr.

this

Warning

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

ZOrder()

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

inline

The Z-order of the text.

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 text.

this TextDrawCommand.

2020.1

Warning

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