LuciadCPillar 2023.1.04
luciad::MilitarySymbologyCanvas::DrawCommand Class Referenceabstract

Allows to draw a military symbol on the MilitarySymbologyCanvas. More...

#include <luciad/symbology/military/MilitarySymbologyCanvas.h>

Public Member Functions

virtual ~DrawCommand ()=default
 
virtual DrawCommandgeometry (std::shared_ptr< Geometry > geometry)=0
 The geometry on which to draw the military symbol. More...
 
virtual DrawCommandstyle (std::shared_ptr< MilitarySymbolStyle > style)=0
 Configures the style the style to apply. More...
 
virtual void submit ()=0
 Submits this draw command. More...
 
virtual DrawCommandsymbol (std::shared_ptr< MilitarySymbol > symbol)=0
 Configures the symbol the symbol to draw. More...
 

Detailed Description

Allows to draw a military symbol on the MilitarySymbologyCanvas.

Constructor & Destructor Documentation

◆ ~DrawCommand()

virtual luciad::MilitarySymbologyCanvas::DrawCommand::~DrawCommand ( )
virtualdefault

Member Function Documentation

◆ geometry()

virtual DrawCommand & luciad::MilitarySymbologyCanvas::DrawCommand::geometry ( std::shared_ptr< Geometry geometry)
pure virtual

The geometry on which to draw the military symbol.

This property is mandatory.

Parameters
geometrythe geometry on which to draw the military symbol.
Returns
this DrawCommand.
Exceptions
luciad::NullArgumentExceptionwhen the geometry is nullptr.

◆ style()

virtual DrawCommand & luciad::MilitarySymbologyCanvas::DrawCommand::style ( std::shared_ptr< MilitarySymbolStyle style)
pure virtual

Configures the style the style to apply.

If not set, the default symbol style is used.

Parameters
stylethe style to apply.
Returns
this DrawCommand.
Exceptions
luciad::NullArgumentExceptionwhen the style is nullptr.

◆ submit()

virtual void luciad::MilitarySymbologyCanvas::DrawCommand::submit ( )
pure virtual

Submits this draw command.

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

Exceptions
luciad::LogicExceptionwhen not all mandatory parameters have been set.

◆ symbol()

virtual DrawCommand & luciad::MilitarySymbologyCanvas::DrawCommand::symbol ( std::shared_ptr< MilitarySymbol symbol)
pure virtual

Configures the symbol the symbol to draw.

This property is mandatory.

Parameters
symbolthe symbol to draw.
Returns
this DrawCommand.
Exceptions
luciad::NullArgumentExceptionwhen the symbol is nullptr.