A 3D Line Stealth Draw Control Object. More...

Inheritance diagram for DtSdcLine3DObject:

Public Member Functions
	DtSdcLine3DObject (DtExerciseConn *exConn, unsigned id, const DtSdc3DAttachPoint &startAttachment, const DtSdc3DAttachPoint &endAttachment, int numSegments=1, const DtVector &offset=DtVector::zero(), DtSdcColor color=DtSdcColor::DtSdcWhite, DtSdcLineSegment::DtSdcSegmentStyle lineStyle=DtSdcLineSegment::DtSdcSegmentStyleStraight, DtSdcLineSegment::DtSdcSegmentArrowStyle arrowStyle=DtSdcLineSegment::DtSdcSegmentArrowStyleNoArrow, unsigned thickness=1, unsigned pattern=0xffffff, bool flashing=false, bool checkLos=false, bool projected=false)
	Construct the Line Draw Control Object.
virtual	~DtSdcLine3DObject ()
virtual const DtSdc3DAttachPoint &	startAttachment () const
	startAttachment accessor
virtual void	setStartAttachment (const DtSdc3DAttachPoint &startAttachment)
	startAttachment mutator
virtual const DtSdc3DAttachPoint &	endAttachment () const
	endAttachment accessor
virtual void	setEndAttachment (const DtSdc3DAttachPoint &endAttachment)
	endAttachment mutator
virtual const DtVector &	offset () const
	offset accessor
virtual void	setOffset (const DtVector &off)
	offset mutator
virtual int	numSegments () const
	numSegments accessor
virtual void	setNumSegments (int numSegments)
	numSegments mutator
virtual const DtSdcColor &	color (int segment) const
	color accessor
virtual const DtSdcColor &	color () const
virtual void	setColor (const DtSdcColor &color, int segment)
	color mutator
virtual void	setColor (const DtSdcColor &color)
virtual DtSdcLineSegment::DtSdcSegmentStyle	lineStyle (int segment=0) const
	lineStyle accessor
virtual void	setLineStyle (DtSdcLineSegment::DtSdcSegmentStyle lineStyle, int segment=0)
	lineStyle mutator
virtual DtSdcLineSegment::DtSdcSegmentArrowStyle	arrowStyle (int segment=0) const
	arrowStyle accessor
virtual void	setArrowStyle (DtSdcLineSegment::DtSdcSegmentArrowStyle arrowStyle, int segment=0)
	arrowStyle mutator
virtual unsigned	pattern (int segment=0) const
	pattern accessor
virtual void	setPattern (unsigned pattern, int segment=0)
	pattern mutator
virtual unsigned	thickness (int segment=0) const
	thickness accessor
virtual void	setThickness (unsigned thickness, int segment=0)
	thickness mutator
virtual double	percentage (int segment) const
	percentage accessor
virtual void	setPercentage (double percentage, int segment)
	percentage mutator
virtual bool	flashing () const
	flashing accessor
virtual void	setFlashing (bool flashing)
	flashing mutator
virtual bool	checkLos () const
	checkLos accessor
virtual void	setCheckLos (bool checkLos)
	checkLos mutator
virtual bool	projected () const
	projected accessor
virtual void	setProjected (bool projected)
	projected mutator
virtual void	setRemoteGraphicSet (const std::string &setName)
virtual void	update ()
	update the internal pdu
Public Member Functions inherited from DtSdc3DTwoPositionedObject
	DtSdc3DTwoPositionedObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
virtual	~DtSdc3DTwoPositionedObject ()
Public Member Functions inherited from DtSdcObject
	DtSdcObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
	Parameterized constructor.
virtual	~DtSdcObject ()
	Virtual destructor.
virtual unsigned	id () const
	id accessor
virtual void	setId (unsigned id)
	id mutator
virtual const DtGlobalObjectDesignator &	globalId () const
virtual void	setVisible (bool yesNo)
virtual bool	visible () const

Protected Member Functions
void	initRecords ()

Protected Attributes
DtSdc3DAttachPoint	myStartAttachment
DtSdc3DAttachPoint	myEndAttachment
DtVector	myOffset
bool	myFlashing
bool	myCheckLos
bool	myProjected
std::vector< DtSdcLineSegment >	myLineSegments
DtEnvironmentalLineRecord	myLineRecord
Dt3DGraphicalObjectLineStateRecord	myLineStateRecord

Private Member Functions
	DtSdcLine3DObject ()
	Default constructor.
	DtSdcLine3DObject (const DtSdcLine3DObject &orig)
	Copy constructor.
DtSdcLine3DObject &	operator= (const DtSdcLine3DObject &rhs)
	Assignment operator.

Detailed Description

A 3D Line Stealth Draw Control Object.

DtSdcLine3DObject represents a line that can be positioned and displayed in the scene. The line may be divided into multiple segments of varying relative lengths. A color, line style, arrow style, pattern and thickness may be specified for each segment; and the line can flash, if desired.

Constructor & Destructor Documentation

DtSdcLine3DObject::DtSdcLine3DObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		const DtSdc3DAttachPoint &	startAttachment,
		const DtSdc3DAttachPoint &	endAttachment,
		int	numSegments = `1`,
		const DtVector &	offset = `DtVector::zero()`,
		DtSdcColor	color = `DtSdcColor::DtSdcWhite`,
		DtSdcLineSegment::DtSdcSegmentStyle	lineStyle = `DtSdcLineSegment::DtSdcSegmentStyleStraight`,
		DtSdcLineSegment::DtSdcSegmentArrowStyle	arrowStyle = `DtSdcLineSegment::DtSdcSegmentArrowStyleNoArrow`,
		unsigned	thickness = `1`,
		unsigned	pattern = `0xffffff`,
		bool	flashing = `false`,
		bool	checkLos = `false`,
		bool	projected = `false`
	)

Construct the Line Draw Control Object.

Note that the color and subsequent default parameters are applied to all segments; multi-segmented lines are constructed with all segments being equally proportioned. The segment proportions and individual stylistic elements may all be modified after construction.

Parameters

id	Passed to DtSdcObject base (see)
startAttachment	Starting attachment of the line
endAttachment	Ending attachment of the line
numSegments	The number of segments the line should be divided into. Note that this can be changed at any time
enuOffset	a 3D vector indicating an east/north/up offset (in meters) from the base attachment that is applied to both start and end positions
color	The color to apply to all segments constructed
lineStyle	A style enumeration from DtSdcLineSegment applied to all segments constructed
arrowStyle	An arrow style enumeration from DtSdcLineSegment applied to all segments constructed
thickness	The number of pixels thick to draw all segments constructed
pattern	A stipple pattern used to draw all segments constructed
flashing	A boolean parameter indicating whether or not the line should be flashing
checkLos	A boolean parameter indicating whether or not the line should be terminated upon collision with the terrain. A check is made going from the starting attachment point to the end attachment point. If any terrain is intersected, that point of intersection becomes the new (temporary) end attach point. This is re-evaluated each frame, so may become CPU intensive for long lines or complex terrains
projected	A boolean parameter indicating whether or not the line should be projected onto the overlay. This prevents terrain occlusion

References Dt3DGraphicalObjectCategoryLine, Dt3DGraphicalObjectKind, DtSdcObject::id(), initRecords(), DtSdcObject::myPublisher, numSegments(), setArrowStyle(), setColor(), setLineStyle(), setNumSegments(), setPattern(), setPercentage(), and setThickness().

DtSdcLine3DObject::~DtSdcLine3DObject ( )

virtual

DtSdcLine3DObject::DtSdcLine3DObject ( )

private

Default constructor.

Private and not implemented - you must supply an id and basic geometric parameters to construct the line

DtSdcLine3DObject::DtSdcLine3DObject ( const DtSdcLine3DObject & orig )

private

Copy constructor.

Private and unimplemented - not copyable.

Member Function Documentation

DtSdcLine3DObject& DtSdcLine3DObject::operator= ( const DtSdcLine3DObject & rhs )

private

Assignment operator.

Private and unimplemented - not copyable.

const DtSdc3DAttachPoint & DtSdcLine3DObject::startAttachment ( ) const

virtual

startAttachment accessor

Get the line's start position

Returns: attach point type and data

Implements DtSdc3DTwoPositionedObject.

References myStartAttachment.

Referenced by setStartAttachment().

void DtSdcLine3DObject::setStartAttachment ( const DtSdc3DAttachPoint & startAttachment )

virtual

startAttachment mutator

Set the line's start position

Parameters

startAttachment attach point type and data

Implements DtSdc3DTwoPositionedObject.

References DtSdc3DAttachPoint::attachedId(), DtSdc3DAttachPoint::attachmentType(), DtSdc3DAttachPoint::attachmentTypeScene, DtSdc3DAttachPoint::isAttached(), DtSdc3DAttachPoint::location(), myEndAttachment, myLineRecord, myLineStateRecord, myStartAttachment, DtSdc3DAttachPoint::relativePosition(), Dt3DGraphicalObjectStateRecord::setAttachment(), setEndAttachment(), Dt3DGraphicalObjectStateRecord::setNumberOfAttachments(), and startAttachment().

Referenced by setEndAttachment().

const DtSdc3DAttachPoint & DtSdcLine3DObject::endAttachment ( ) const

virtual

endAttachment accessor

Get the line's end position

Returns: attach point type and data

Implements DtSdc3DTwoPositionedObject.

References myEndAttachment.

Referenced by setEndAttachment().

void DtSdcLine3DObject::setEndAttachment ( const DtSdc3DAttachPoint & endAttachment )

virtual

endAttachment mutator

Set the line's end position

Parameters

endAttachment attach point type and data

Implements DtSdc3DTwoPositionedObject.

References DtSdc3DAttachPoint::attachedId(), DtSdc3DAttachPoint::attachmentType(), DtSdc3DAttachPoint::attachmentTypeScene, endAttachment(), DtSdc3DAttachPoint::isAttached(), DtSdc3DAttachPoint::location(), myEndAttachment, myLineRecord, myLineStateRecord, myStartAttachment, DtSdc3DAttachPoint::relativePosition(), Dt3DGraphicalObjectStateRecord::setAttachment(), Dt3DGraphicalObjectStateRecord::setNumberOfAttachments(), and setStartAttachment().

Referenced by setStartAttachment().

const DtVector & DtSdcLine3DObject::offset ( ) const

virtual

offset accessor

Get the object's offset from the attach point, in entity coordinates if attached, geocentric otherwise

Returns: [X, Y, Z] offset

References myOffset.

void DtSdcLine3DObject::setOffset ( const DtVector & off )

virtual

offset mutator

Set the object's offset from the attach point, in entity coordinates if attached, geocentric otherwise

Parameters

offset [X, Y, Z]

References myLineStateRecord, myOffset, and Dt3DGraphicalObjectStateRecord::setOffset().

int DtSdcLine3DObject::numSegments ( ) const

virtual

numSegments accessor

Get the number of segments in this line

Returns: 0 to N

Implements DtSdcLineObjectInterface.

References myLineSegments.

Referenced by DtSdcLine3DObject().

void DtSdcLine3DObject::setNumSegments ( int numSegments )

virtual

numSegments mutator

Set the number of individual segments that make up this line

Parameters

numSegments 0 to N

Implements DtSdcLineObjectInterface.

References myLineSegments, myLineStateRecord, and Dt3DGraphicalObjectLineStateRecord::setNumberOfSegments().

Referenced by DtSdcLine3DObject().

const DtSdcColor & DtSdcLine3DObject::color ( int segment ) const

virtual

color accessor

Get the color assigned to the indicated segment

Parameters

segment The segment to retrieve the color from

Returns: The segment's color

References myLineSegments.

const DtSdcColor & DtSdcLine3DObject::color ( ) const

virtual

Reimplemented from DtSdcObject.

void DtSdcLine3DObject::setColor	(	const DtSdcColor &	color,
		int	segment
	)

virtual

color mutator

Set the color to use when drawing the indicated segment

Parameters

color	The DtSdcColor to use
segment	The segment to apply the color to

References DtSdcColor::alpha(), DtSdcColor::blue(), Dt3DGraphicalObjectLineStateRecord::getSegment(), DtSdcColor::green(), myLineSegments, myLineStateRecord, DtSdcColor::red(), DtLineSegmentDescriptor::setColor(), and Dt3DGraphicalObjectLineStateRecord::setSegment().

Referenced by DtSdcLine3DObject(), and setColor().

void DtSdcLine3DObject::setColor ( const DtSdcColor & color )

virtual

Reimplemented from DtSdcObject.

References setColor().

DtSdcLineSegment::DtSdcSegmentStyle DtSdcLine3DObject::lineStyle ( int segment = 0 ) const

virtual

lineStyle accessor

Get the lineStyle assigned to the indicated segment

Parameters

segment The segment to retrieve the lineStyle from

Returns: A DtSdcLineSegment::DtSdcSegmentStyle indicating the segment's style

Implements DtSdcLineObjectInterface.

References myLineSegments.

void DtSdcLine3DObject::setLineStyle	(	DtSdcLineSegment::DtSdcSegmentStyle	lineStyle,
		int	segment = `0`
	)

virtual

lineStyle mutator

Set the lineStyle to use when drawing the indicated segment

Parameters

lineStyle	The lineStyle to use for the indicated segment
segment	The segment to apply the lineStyle to

Implements DtSdcLineObjectInterface.

References Dt3DGraphicalObjectLineStateRecord::getSegment(), myLineSegments, myLineStateRecord, DtLineSegmentDescriptor::setLineStyle(), and Dt3DGraphicalObjectLineStateRecord::setSegment().

Referenced by DtSdcLine3DObject().

DtSdcLineSegment::DtSdcSegmentArrowStyle DtSdcLine3DObject::arrowStyle ( int segment = 0 ) const

virtual

arrowStyle accessor

Get the arrowStyle assigned to the indicated segment

Parameters

segment The segment to retrieve the arrowStyle from

Returns: A DtSdcLineSegment::DtSdcSegmentArrowStyle indicating the segment's arrow style

Implements DtSdcLineObjectInterface.

References myLineSegments.

void DtSdcLine3DObject::setArrowStyle	(	DtSdcLineSegment::DtSdcSegmentArrowStyle	arrowStyle,
		int	segment = `0`
	)

virtual

arrowStyle mutator

Set the arrowStyle to use when drawing the indicated segment

Parameters

arrowStyle	The arrowStyle to use for the indicated segment
segment	The segment to apply the arrowStyle to

Implements DtSdcLineObjectInterface.

References Dt3DGraphicalObjectLineStateRecord::getSegment(), myLineSegments, myLineStateRecord, DtLineSegmentDescriptor::setArrowStyle(), and Dt3DGraphicalObjectLineStateRecord::setSegment().

Referenced by DtSdcLine3DObject().

unsigned DtSdcLine3DObject::pattern ( int segment = 0 ) const

virtual

pattern accessor

Get the stipple pattern used when drawing the indicated segment

Parameters

segment The segment to retrieve the pattern from

Returns: The stipple pattern, 0x00000000 to 0xFFFFFFFF

Implements DtSdcLineObjectInterface.

References myLineSegments.

void DtSdcLine3DObject::setPattern	(	unsigned	pattern,
		int	segment = `0`
	)

virtual

pattern mutator

Set the stipple pattern to use when drawing the indicated segment

Parameters

pattern	The stipple pattern, 0x00000000 to 0xFFFFFFFF.
segment	The segment to apply the pattern to

Implements DtSdcLineObjectInterface.

References Dt3DGraphicalObjectLineStateRecord::getSegment(), myLineSegments, myLineStateRecord, DtLineSegmentDescriptor::setLinePattern(), and Dt3DGraphicalObjectLineStateRecord::setSegment().

Referenced by DtSdcLine3DObject().

unsigned DtSdcLine3DObject::thickness ( int segment = 0 ) const

virtual

thickness accessor

Get the thickness assigned to the indicated segment

Parameters

segment The segment to retrieve the thickness from

Returns: The segments's thickness, in pixels (0-255)

Implements DtSdcLineObjectInterface.

References myLineSegments.

void DtSdcLine3DObject::setThickness	(	unsigned	thickness,
		int	segment = `0`
	)

virtual

thickness mutator

Set the thickness to use when drawing the indicated segment

Parameters

thickness	The thickness in pixels, (0-255). Note that GL may not actually be willing or able to draw a line 255 pixels wide. It's implementation dependent.
segment	The segment to apply the thickness to

Implements DtSdcLineObjectInterface.

References Dt3DGraphicalObjectLineStateRecord::getSegment(), myLineSegments, myLineStateRecord, DtLineSegmentDescriptor::setLineWidth(), and Dt3DGraphicalObjectLineStateRecord::setSegment().

Referenced by DtSdcLine3DObject().

double DtSdcLine3DObject::percentage ( int segment ) const

virtual

percentage accessor

Get the percentage of the line that the indicated segment occupies

Parameters

segment The segment to retrieve the percentage from

Returns: The line's thickness, in pixels (0-255)

Implements DtSdcLineObjectInterface.

References myLineSegments.

void DtSdcLine3DObject::setPercentage	(	double	percentage,
		int	segment
	)

virtual

percentage mutator

Set the percentage of the line that the indicated segment should occupy. Note that it's the responsibility of the user to ensure that the sum of the individual segment's percentages is 1.

Parameters

percentage	The percentage (0. to 1.)
segment	The segment to apply the precentage to

Implements DtSdcLineObjectInterface.

References Dt3DGraphicalObjectLineStateRecord::getSegment(), myLineSegments, myLineStateRecord, DtLineSegmentDescriptor::setPercentage(), and Dt3DGraphicalObjectLineStateRecord::setSegment().

Referenced by DtSdcLine3DObject().

bool DtSdcLine3DObject::flashing ( ) const

virtual

flashing accessor

Get the boolean that indicates whether or not the line should flash

Returns: true or false

Reimplemented from DtSdcObject.

References myFlashing.

Referenced by setFlashing().

void DtSdcLine3DObject::setFlashing ( bool flashing )

virtual

flashing mutator

Set the boolean that indicates whether or not the line should flash

Parameters

flashing true or false

Reimplemented from DtSdcObject.

References flashing(), myFlashing, myLineStateRecord, and Dt3DGraphicalObjectStateRecord::setFlashing().

bool DtSdcLine3DObject::checkLos ( ) const

virtual

checkLos accessor

Get the boolean that indicates whether or not the line is checked for terrain collisions

Returns: true or false

References myCheckLos.

Referenced by setCheckLos().

void DtSdcLine3DObject::setCheckLos ( bool checkLos )

virtual

checkLos mutator

Set the boolean that indicates whether or not the line is checked for terrain collisions

Parameters

checkLos true or false

References checkLos(), myCheckLos, myLineStateRecord, and Dt3DGraphicalObjectLineStateRecord::setCheckLos().

bool DtSdcLine3DObject::projected ( ) const

virtual

projected accessor

Get the boolean that indicates whether or not the line (if it is a 3D line) should be projected onto the overlay (preventing terrain occlusion)

Returns: true or false

References myProjected.

Referenced by setProjected().

void DtSdcLine3DObject::setProjected ( bool projected )

virtual

projected mutator

Set the boolean that indicates whether or not the line (if it is a 3D line) should be projected onto the overlay (preventing terrain occlusion)

Parameters

projected true or false

References myLineStateRecord, myProjected, projected(), and Dt3DGraphicalObjectStateRecord::setProjected().

void DtSdcLine3DObject::setRemoteGraphicSet ( const std::string & setName )

virtual

Reimplemented from DtSdcObject.

References myLineStateRecord, Dt3DGraphicalObjectStateRecord::setNumberOfParentOverlays(), and Dt3DGraphicalObjectStateRecord::setParentOverlay().

void DtSdcLine3DObject::update ( )

virtual

update the internal pdu

Make sure the internal pdu reflects the actual state of the draw control object's members. This is necessary because some members can be modified directly (which make the interface easier to use). DtStealthRemoteDrawer::update() calls this, so the user doesn't need to; but if the user is accessing the pdu directly (via the pdu() accessor) this should be called before using the pdu.

Implements DtSdcObject.

References myLineRecord, myLineStateRecord, and DtSdcObject::myPublisher.