DtSdcLinePdu Class Reference

Inheritance diagram for DtSdcLinePdu:

Public Types
enum	DtSdcLineArrowStyle {   DtSdcStyleNoArrow = 0x00, DtSdcStyleArrowEnd = 0x01, DtSdcStyleArrowStart = 0x02, DtSdcStyleArrowDouble = 0x03,   DtSdcLineArrowStyleEntry = 0x03 }
enum	DtSdcLineAppearance { DtSdcLineAppearanceStraight = 0x00, DtSdcLineAppearanceLightning = 0x08, DtSdcLineAppearanceEntry = 0x08 }
Public Types inherited from DtSdcAttachablePdu
enum	DtVcObjectAttachment {   DtVcObjectNoAttach = 0, DtVcObjectNoAttachNoAttach = 1, DtVcObjectAttachedToEntity = 2, DtVcObjectAttachedToObject = 3,   DtVcObjectAttachedToEntityNoAttach = 4, DtVcObjectAttachedToObjectNoAttach = 5, DtVcObjectAttachedToNoAttachEntity = 6, DtVcObjectAttachedToNoAttachObject = 7,   DtVcObjectAttachedToEntityObject = 8, DtVcObjectAttachedToObjectEntity = 9, DtVcObjectAttachedToEntityEntity = 10, DtVcObjectAttachedToObjectObject = 11 }
enum	DtVcDrawingStyle { DtVcStyleNoFlashing = 0x00, DtVcStyleFlashing = 0x04, DtVcDrawingStyleEntry = 0x04 }

Public Member Functions
	DtSdcLinePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	DtSdcLinePdu (const DtNetViewControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	DtSdcLinePdu (double doNothing)
virtual void	setNumSegments (DtNetU8 segments)
virtual const DtNetU8	numSegments () const
virtual void	setArrowStyle (DtSdcLineArrowStyle style)
virtual void	setArrowStyle (unsigned int segment, DtSdcLineArrowStyle style)
virtual const DtSdcLineArrowStyle	arrowStyle (unsigned int segment=0) const
virtual void	setAppearance (DtSdcLineAppearance app)
virtual void	setAppearance (unsigned int segment, DtSdcLineAppearance app)
virtual const DtSdcLineAppearance	appearance (unsigned int segment=0) const
virtual void	setThickness (DtNetU8 thickness)
virtual void	setThickness (unsigned int segment, DtNetU8 thickness)
virtual const DtNetU8	thickness (unsigned int segment=0) const
virtual void	setPattern (DtNetU32 patt)
virtual void	setPattern (unsigned int segment, DtNetU32 patt)
virtual const DtNetU32	pattern (unsigned int segment=0) const
virtual void	setColor (DtNetU8 color[4])
virtual void	setColor (unsigned int segment, DtNetU8 color[4])
virtual const DtNetU8 *	color () const
virtual const DtNetU8 *	color (unsigned int segment) const
virtual void	setPercentage (unsigned int segment, DtNetU8 percent)
virtual const DtNetU8	percentage (unsigned int segment=0) const
virtual void	setCheckLos (bool checkLos)
	Should lines be terminated by intersection with the terrain?
virtual bool	checkLos () const
virtual void	setProjected (bool projected)
	Should 3D lines be projected onto the 2D overlay? This flag only affects 3D lines, and will keep lines from being occluded by the terrain.
virtual bool	projected () const
virtual void	printData () const
Public Member Functions inherited from DtSdcAttachablePdu
virtual const DtVcObjectAttachment	attachmentType () const
	objects can be attach to 1 (text, sphere, cube, triangle, attribute group) or
virtual void	attachTo (const DtNetInt8 pos[2])
	2D placement of single position objects; uses a screen coordinate system of
virtual void	attachTo (const DtNetInt8 pos1[2], const DtNetInt8 pos2[2])
	2D placement of lines
virtual void	attachTo (const DtVector &pos)
	3D placement of single position objects
virtual void	attachTo (const DtNetU32 id)
virtual void	attachTo (const DtGlobalObjectDesignator &id)
virtual void	attachTo (const DtNetU32 id1, const DtNetU32 id2)
	3D placement of two position objects
virtual void	attachTo (const DtGlobalObjectDesignator &id1, const DtGlobalObjectDesignator &id2)
virtual void	attachTo (const DtVector &pos1, const DtVector &pos2)
virtual void	attachTo (const DtGlobalObjectDesignator &id1, const DtNetU32 id2)
virtual void	attachTo (const DtNetU32 id1, const DtGlobalObjectDesignator &id2)
virtual void	attachTo (const DtGlobalObjectDesignator &id, const DtVector &pos)
virtual void	attachTo (const DtVector &pos, const DtGlobalObjectDesignator &id)
virtual void	attachTo (const DtNetU32 id, const DtVector &pos)
virtual void	attachTo (const DtVector &pos, const DtNetU32 id)
virtual void	setRelativeLocation (DtNetU8 percentage, int index=0)
	relative location along the parent object if there is not parent object or the parent object is puntual this value is discarded The value is a percentage (0 - 100) messure from start point to end point Because a line or cylinder has two attachments, each of which could be another line or cylinder, the interface needs to support 2 relative locations.
virtual const DtNetU8	relativeLocation (int index=0) const
virtual void	setOffset (const DtVector &offsetVector)
	offset from final position.
virtual DtVector	offset () const
virtual const DtGlobalObjectDesignator	attachEntityId (int index) const
virtual const DtNetU32	attachObjectId (int index) const
virtual DtVector	position (int index) const
virtual void	setFlashing (bool onOff)
virtual const bool	flashing () const
virtual void	setFromString (const char *)
virtual const char *	string () const
Public Member Functions inherited from DtStealthDrawControlPdu
virtual const DtNetU32	objectId () const
virtual void	setObjectId (DtNetU32 lid)
virtual void	setType (DtNetU32 type)
virtual DtNetU32	type () const
virtual DtU32	paramVersion () const
Public Member Functions inherited from DtStealthControlPdu
const DtGlobalObjectDesignator &	viewerId () const
const DtGlobalObjectDesignator &	senderId () const
DtViewerCommand	viewerCommand () const
unsigned long	ignoreFlags () const
bool	statusCommand () const
void	setViewerId (const DtGlobalObjectDesignator &id)
void	setSenderId (const DtGlobalObjectDesignator &id)
void	setIgnoreFlags (unsigned long flags)
void	setStatusCommand (bool b)

Protected Member Functions
virtual const char *	typeString (DtSdcLinePdu::DtSdcLineArrowStyle param) const
virtual const char *	typeString (DtSdcLinePdu::DtSdcLineAppearance param) const
Protected Member Functions inherited from DtSdcAttachablePdu
virtual void	setAttachmentType (DtVcObjectAttachment attachmentType)
Protected Member Functions inherited from DtStealthDrawControlPdu
virtual int	setInternalText (DtString str, size_t structSize)
virtual const DtString	internalText (int size, size_t structSize) const
virtual void	setParamVersion (DtU32 paramVersion)
Protected Member Functions inherited from DtStealthControlPdu
bool	isNumber (const char *str)
DtPduKind	internalGetPduKind () const
void	setViewerCommand (DtViewerCommand com)
	DtStealthControlPdu ()

Additional Inherited Members
Static Public Member Functions inherited from DtSdcAttachablePdu
static const char *	typeString (DtVcObjectAttachment param)
Static Protected Member Functions inherited from DtStealthControlPdu
static DtStealthControlPdu *	createViewControl (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
static DtStealthControlPdu *	createDrawControl (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
static DtStealthControlPdu *	createDrawControlV0 (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
static DtStealthControlPdu *	createDrawControlCurrent (DtNetViewControlPdu *vc, DtBufferPtr buffer, DtPduFactory *)
Protected Attributes inherited from DtStealthDrawControlPdu
DtString	myTemporalText

Member Enumeration Documentation

enum DtSdcLinePdu::DtSdcLineArrowStyle

Enumerator:

DtSdcStyleNoArrow
DtSdcStyleArrowEnd
DtSdcStyleArrowStart
DtSdcStyleArrowDouble
DtSdcLineArrowStyleEntry

enum DtSdcLinePdu::DtSdcLineAppearance

Enumerator:

DtSdcLineAppearanceStraight
DtSdcLineAppearanceLightning
DtSdcLineAppearanceEntry

Constructor & Destructor Documentation

DtSdcLinePdu::DtSdcLinePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

References DtCURRENT_DRAW_CONTROL_VERSION, DtStealthDrawControlStaticSize, lineParams, setNumSegments(), DtStealthDrawControlPdu::setParamVersion(), setPercentage(), and DtStealthControlPdu::setViewerCommand().

DtSdcLinePdu::DtSdcLinePdu	(	const DtNetViewControlPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER,
		DtPduFactory *	pduFactory = 0
	)

References DtStealthControlPdu::setViewerCommand().

DtSdcLinePdu::DtSdcLinePdu

(

double

doNothing

)

Member Function Documentation

void DtSdcLinePdu::setNumSegments ( DtNetU8  segments )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtStealthDrawControlStaticSize, lineParams, DtStealthDrawControlPdu::paramVersion(), slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by DtSdcLinePdu().

const DtNetU8 DtSdcLinePdu::numSegments ( ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, DtStealthDrawControlPdu::paramVersion(), slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by printData().

void DtSdcLinePdu::setArrowStyle ( DtSdcLineArrowStyle  style )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtSdcLineArrowStyleEntry, lineParamsV0, DtNetSdcSegment::myFlags, DtNetSdcLineSegment::myFlags, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, and DtStealthDrawControlPdu::type().

void DtSdcLinePdu::setArrowStyle ( unsigned int  segment, DtSdcLineArrowStyle  style  )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtSdcLineArrowStyleEntry, lineParams, DtNetSdcSegment::myFlags, DtNetSdcLineSegment::myFlags, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

const DtSdcLinePdu::DtSdcLineArrowStyle DtSdcLinePdu::arrowStyle ( unsigned int  segment = 0 ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtSdcLineArrowStyleEntry, DtSdcStyleNoArrow, lineParams, lineParamsV0, DtNetSdcSegment::myFlags, DtNetSdcLineSegment::myFlags, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by printData().

void DtSdcLinePdu::setAppearance ( DtSdcLineAppearance  app )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtSdcLineAppearanceEntry, lineParamsV0, DtNetSdcSegment::myFlags, DtNetSdcLineSegment::myFlags, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, and DtStealthDrawControlPdu::type().

void DtSdcLinePdu::setAppearance ( unsigned int  segment, DtSdcLineAppearance  app  )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtSdcLineAppearanceEntry, lineParams, DtNetSdcSegment::myFlags, DtNetSdcLineSegment::myFlags, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

const DtSdcLinePdu::DtSdcLineAppearance DtSdcLinePdu::appearance ( unsigned int  segment = 0 ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, DtSdcLineAppearanceEntry, DtSdcLineAppearanceStraight, lineParams, lineParamsV0, DtNetSdcSegment::myFlags, DtNetSdcLineSegment::myFlags, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by printData().

void DtSdcLinePdu::setThickness ( DtNetU8  thickness )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParamsV0, DtNetSdcSegment::myThickness, DtNetSdcLineSegment::myThickness, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, thickness(), and DtStealthDrawControlPdu::type().

void DtSdcLinePdu::setThickness ( unsigned int  segment, DtNetU8  thickness  )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, DtNetSdcSegment::myThickness, DtNetSdcLineSegment::myThickness, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, thickness(), and DtStealthDrawControlPdu::type().

const DtNetU8 DtSdcLinePdu::thickness ( unsigned int  segment = 0 ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, lineParamsV0, DtNetSdcSegment::myThickness, DtNetSdcLineSegment::myThickness, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by printData(), and setThickness().

void DtSdcLinePdu::setPattern ( DtNetU32  patt )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParamsV0, DtNetSdcSegment::myPattern, DtNetSdcLineSegment::myPattern, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, and DtStealthDrawControlPdu::type().

void DtSdcLinePdu::setPattern ( unsigned int  segment, DtNetU32  patt  )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, DtNetSdcSegment::myPattern, DtNetSdcLineSegment::myPattern, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

const DtNetU32 DtSdcLinePdu::pattern ( unsigned int  segment = 0 ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, lineParamsV0, DtNetSdcSegment::myPattern, DtNetSdcLineSegment::myPattern, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by printData().

void DtSdcLinePdu::setColor ( DtNetU8  color[4] )

virtual

Reimplemented from DtSdcAttachablePdu.

References DtCURRENT_DRAW_CONTROL_VERSION, DtNetSdcLineSegment::myColor, DtStealthDrawControlPdu::paramVersion(), segArray, and DtStealthDrawControlPdu::type().

void DtSdcLinePdu::setColor ( unsigned int  segment, DtNetU8  color[4]  )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, DtNetSdcSegment::myColor, DtNetSdcLineSegment::myColor, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

const DtNetU8 * DtSdcLinePdu::color ( void  ) const

virtual

Reimplemented from DtSdcAttachablePdu.

References DtCURRENT_DRAW_CONTROL_VERSION, DtNetSdcLineSegment::myColor, DtStealthDrawControlPdu::paramVersion(), and segArray.

Referenced by printData().

const DtNetU8 * DtSdcLinePdu::color ( unsigned int  segment ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, lineParamsV0, DtNetSdcSegment::myColor, DtNetSdcLineSegment::myColor, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

void DtSdcLinePdu::setPercentage ( unsigned int  segment, DtNetU8  percent  )

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, DtNetSdcSegment::myPercentage, DtNetSdcLineSegment::myPercentage, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by DtSdcLinePdu().

const DtNetU8 DtSdcLinePdu::percentage ( unsigned int  segment = 0 ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, lineParamsV0, DtNetSdcSegment::myPercentage, DtNetSdcLineSegment::myPercentage, DtStealthDrawControlPdu::paramVersion(), segArray, segArrayV0, slineParamsV0, and DtStealthDrawControlPdu::type().

Referenced by printData().

void DtSdcLinePdu::setCheckLos ( bool  checkLos )

virtual

Should lines be terminated by intersection with the terrain?

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, and DtStealthDrawControlPdu::paramVersion().

bool DtSdcLinePdu::checkLos ( ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, and DtStealthDrawControlPdu::paramVersion().

void DtSdcLinePdu::setProjected ( bool  projected )

virtual

Should 3D lines be projected onto the 2D overlay? This flag only affects 3D lines, and will keep lines from being occluded by the terrain.

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, and DtStealthDrawControlPdu::paramVersion().

bool DtSdcLinePdu::projected ( ) const

virtual

References DtCURRENT_DRAW_CONTROL_VERSION, lineParams, and DtStealthDrawControlPdu::paramVersion().

void DtSdcLinePdu::printData ( ) const

virtual

Reimplemented from DtSdcAttachablePdu.

References appearance(), arrowStyle(), color(), numSegments(), pattern(), percentage(), thickness(), and typeString().

const char * DtSdcLinePdu::typeString ( DtSdcLinePdu::DtSdcLineArrowStyle  param ) const

protectedvirtual

References CASE_EVCSTRING, DtSdcStyleArrowDouble, DtSdcStyleArrowEnd, DtSdcStyleArrowStart, and DtSdcStyleNoArrow.

Referenced by printData().

const char * DtSdcLinePdu::typeString ( DtSdcLinePdu::DtSdcLineAppearance  param ) const

protectedvirtual

References CASE_EVCSTRING, DtSdcLineAppearanceLightning, and DtSdcLineAppearanceStraight.

---

The documentation for this class was generated from the following files:

• legacyStealthControl.h
• legacyStealthControl.inl