LuciadCPillar C# 2023.1.02
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Class Reference

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

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

Public Member Functions

void Dispose ()
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Draped (bool draped)
 Indicates whether or not the geometry should be draped on top of the terrain. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Fill (Luciad.Layers.Styles.FillStyle fillStyle)
 Specifies the fill styling for the geometry, cannot be nullptr. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Geometry (Luciad.Geometries.Geometry geometry)
 Specifies the geometry to draw. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand OcclusionMode (Luciad.Layers.Styles.OcclusionMode occlusionMode)
 Determines when this geometry should be painted in 3D in relation to other 3D data. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Queryable (bool queryable)
 Indicates whether or not the geometry should be considered when a Map::queryFeatures is requested. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Stroke (Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle lineStyle)
 Specifies the line styling of the geometry. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Stroke (Luciad.Layers.Styles.LineStyle lineStyle)
 Specifies the line styling of the geometry. More...
 
void Submit ()
 Submits this draw command. More...
 
Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand ZOrder (int zOrder)
 The Z-order of the geometry. More...
 

Detailed Description

Command to specify drawing options for a geometry.

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

Member Function Documentation

◆ Dispose()

void Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Dispose ( )
inline

◆ Draped()

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Draped ( bool  draped)
inline

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

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

draped

true if the geometry should be draped over terrain.

this GeometryDrawCommand.

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

◆ Fill()

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Fill ( Luciad.Layers.Styles.FillStyle  fillStyle)
inline

Specifies the fill styling for the geometry, cannot be nullptr.

When the given geometry does not have a surface, this style is ignored.

fillStyle

the fill styling to apply.

this GeometryDrawCommand.

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

◆ Geometry()

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Geometry ( Luciad.Geometries.Geometry  geometry)
inline

Specifies the geometry to draw.

This property is mandatory.

geometry

the geometry to draw, cannot be nullptr.

this GeometryDrawCommand.

luciad::NullArgumentException

when the geometry is nullptr.

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

◆ OcclusionMode()

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.OcclusionMode ( Luciad.Layers.Styles.OcclusionMode  occlusionMode)
inline

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

Details and limitations:

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

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

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

The default is OcclusionMode::VisibleOnly.

occlusionMode

the occlusion mode to use

this GeometryDrawCommand

2023.1.01

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

◆ Queryable()

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Queryable ( bool  queryable)
inline

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

The default is true.

queryable

true if the geometry should be considered.

this GeometryDrawCommand.

2020.1

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

◆ Stroke() [1/2]

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Stroke ( Luciad.Layers.Styles.ComplexStrokes.ComplexStrokeLineStyle  lineStyle)
inline

Specifies the line styling of the geometry.

This is the geometry's outline if it's a surface. Only one stroke style can be set, if this function is called when a lineStyle stroke has already been set, it will be overwritten.

lineStyle

the complex stroke styling to apply.

this GeometryDrawCommand.

2023.1

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

◆ Stroke() [2/2]

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Stroke ( Luciad.Layers.Styles.LineStyle  lineStyle)
inline

Specifies the line styling of the geometry.

This is the geometry's outline if it's a surface. Only one stroke style can be set, if this function is called when a ComplexStrokeLineStyle stroke has already been set, it will be overwritten.

lineStyle

the stroke styling to apply.

this GeometryDrawCommand.

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

◆ Submit()

void Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.Submit ( )
inline

Submits this draw command.

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

luciad::LogicException

when there are missing geometry 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::GeometryDrawCommand::submit.

◆ ZOrder()

Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand Luciad.Layers.Features.FeatureCanvas.GeometryDrawCommand.ZOrder ( int  zOrder)
inline

The Z-order of the geometry.

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

this GeometryDrawCommand.

2020.1

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