Inheritance diagram for vrvControlToolkit::DtArea3DObject:

Public Member Functions
	DtArea3DObject (DtExerciseConn *exConn, unsigned id, std::vector< DtVector > vertices, DtVector offset=DtVector::zero(), DtVdcColor color=DtVdcColor::DtVdcWhite, const DtString &textureDirectory="", const DtString &textureFilename=DtString::nullString(), int numTextureTiles=0, bool flashing=false)
	Construct the area Draw Control Object.
virtual	~DtArea3DObject ()
virtual const DtVector &	offset () const
	offset accessor
virtual void	setOffset (const DtVector &off)
	offset mutator
virtual const DtVdcColor &	color () const
	color accessor
virtual void	setColor (const DtVdcColor &color)
	color mutator
virtual bool	flashing () const
	flashing accessor
virtual void	setFlashing (bool flashing)
	flashing mutator
virtual const DtString &	textureDirectory () const
	Texture directory accessor.
virtual void	setTextureDirectory (const DtString &str)
	Texture directory mutator.
virtual const DtString &	textureFilename () const
	Texture file name accessor.
virtual void	setTextureFilename (const DtString &str)
	Texture file name mutator.
virtual int	numTextureTiles () const
	Texture tile repetitions accessor.
virtual void	setNumTextureTiles (int numTextureTiles)
	Texture tile repetitions mutator.
virtual void	update ()
	update the internal pdu
virtual const DtVector &	vertex (int index) const
	vertex accessor
virtual void	setVertex (int index, const DtVector &vertex)
	vertex mutator
virtual void	setRemoteGraphicSet (const std::string &setName)
Public Member Functions inherited from vrvControlToolkit::DtDrawControlObject
	DtDrawControlObject (DtExerciseConn *exConn, unsigned id, const DtString &objName)
	Parameterized constructor.
virtual	~DtDrawControlObject ()
	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
virtual void	calculateBoundingSphere ()
virtual void	setStateRecordUserData ()
void	initRecords ()

Protected Attributes
DtVector	myOffset
DtVdcColor	myColor
bool	myFlashing
int	myNumVertices
std::vector< DtVector >	myVertices
DtString	myTextureFilename
DtString	myTextureDirectory
int	myNumTextureTiles
std::vector < DtEnvironmentalPointRecord >	myPointRecords
DtEnvironmentalBoundingSphereRecord	myBoundingSphereRecord
Dt3DGraphicalObjectStateRecord	myStateRecord
DtVector	myEmptyVertex
Protected Attributes inherited from vrvControlToolkit::DtDrawControlObject
unsigned	myId
DtEnvironmentProcessPublisher	myPublisher
bool	myVisible
DtVdcColor	myEmptyColor

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

Constructor & Destructor Documentation

vrvControlToolkit::DtArea3DObject::DtArea3DObject	(	DtExerciseConn *	exConn,
		unsigned	id,
		std::vector< DtVector >	vertices,
		DtVector	offset = `DtVector::zero()`,
		DtVdcColor	color = `DtVdcColor::DtVdcWhite`,
		const DtString &	textureDirectory = `""`,
		const DtString &	textureFilename = `DtString::nullString()`,
		int	numTextureTiles = `0`,
		bool	flashing = `false`
	)

Construct the area Draw Control Object.

Parameters

id	Passed to DtDrawControlObject base (see)
vertices	A std::list of DtVector's containing the vertices The color to apply to all segments constructed
flashing	A boolean parameter indicating whether or not the area should be flashing

virtual vrvControlToolkit::DtArea3DObject::~DtArea3DObject ( )

virtual

vrvControlToolkit::DtArea3DObject::DtArea3DObject ( )

private

Default constructor.

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

vrvControlToolkit::DtArea3DObject::DtArea3DObject ( const DtArea3DObject & orig )

private

Copy constructor.

Private and unimplemented - not copyable.

Member Function Documentation

DtArea3DObject& vrvControlToolkit::DtArea3DObject::operator= ( const DtArea3DObject & rhs )

private

Assignment operator.

Private and unimplemented - not copyable.

virtual const DtVector& vrvControlToolkit::DtArea3DObject::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] enuOffset

virtual void vrvControlToolkit::DtArea3DObject::setOffset ( const DtVector & off )

virtual

offset mutator

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

Parameters

enuOffset [X, Y, Z]

virtual const DtVdcColor& vrvControlToolkit::DtArea3DObject::color ( ) 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

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtArea3DObject::setColor ( const DtVdcColor & color )

virtual

color mutator

Set the color to use when drawing the indicated segment

Parameters

color	The DtVdcColor to use
segment	The segment to apply the color to

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual bool vrvControlToolkit::DtArea3DObject::flashing ( ) const

virtual

flashing accessor

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

Returns: true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtArea3DObject::setFlashing ( bool flashing )

virtual

flashing mutator

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

Parameters

flashing true or false

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual const DtString& vrvControlToolkit::DtArea3DObject::textureDirectory ( ) const

virtual

Texture directory accessor.

Get the directory for texture access

Returns: directory name

virtual void vrvControlToolkit::DtArea3DObject::setTextureDirectory ( const DtString & str )

virtual

Texture directory mutator.

Set the directory for texture access

Parameters

str	directory name

virtual const DtString& vrvControlToolkit::DtArea3DObject::textureFilename ( ) const

virtual

Texture file name accessor.

Get the area's texture file name

Returns: name (without directory) of texture file

virtual void vrvControlToolkit::DtArea3DObject::setTextureFilename ( const DtString & str )

virtual

Texture file name mutator.

Set the area's texture file name

Parameters

str	name (without directory) of texture file

virtual int vrvControlToolkit::DtArea3DObject::numTextureTiles ( ) const

virtual

Texture tile repetitions accessor.

Get the number of times texture repeats

Returns: int level

virtual void vrvControlToolkit::DtArea3DObject::setNumTextureTiles ( int numTextureTiles )

virtual

Texture tile repetitions mutator.

Set the int that indicates how many times texture repeats

Parameters

numTextureTiles number of times texture repeats

virtual void vrvControlToolkit::DtArea3DObject::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 vrvControlToolkit::DtDrawControlObject.

virtual const DtVector& vrvControlToolkit::DtArea3DObject::vertex ( int index ) const

virtual

vertex accessor

Get the vertex at index (0-indexed) Vertices should be specified in counterclockwise order and should define a convex polygon.

Parameters

index,from 0 to 15

Returns: vertex at index (in geocentric coordinates)

virtual void vrvControlToolkit::DtArea3DObject::setVertex	(	int	index,
		const DtVector &	vertex
	)

virtual

vertex mutator

Set the area's vertex at index (0-indexed) Vertices should be specified in counterclockwise order and should define a convex polygon.

Parameters

index (from 0 to 15) vertex (in geocentric coordinates)

virtual void vrvControlToolkit::DtArea3DObject::setRemoteGraphicSet ( const std::string & setName )

virtual

Reimplemented from vrvControlToolkit::DtDrawControlObject.

virtual void vrvControlToolkit::DtArea3DObject::calculateBoundingSphere ( )

protectedvirtual

virtual void vrvControlToolkit::DtArea3DObject::setStateRecordUserData ( )

protectedvirtual

void vrvControlToolkit::DtArea3DObject::initRecords ( )

protected

Member Data Documentation

DtVector vrvControlToolkit::DtArea3DObject::myOffset

protected

DtVdcColor vrvControlToolkit::DtArea3DObject::myColor

protected

bool vrvControlToolkit::DtArea3DObject::myFlashing

protected

int vrvControlToolkit::DtArea3DObject::myNumVertices

protected

std::vector<DtVector> vrvControlToolkit::DtArea3DObject::myVertices

protected

DtString vrvControlToolkit::DtArea3DObject::myTextureFilename

protected

DtString vrvControlToolkit::DtArea3DObject::myTextureDirectory

protected

int vrvControlToolkit::DtArea3DObject::myNumTextureTiles

protected

std::vector<DtEnvironmentalPointRecord> vrvControlToolkit::DtArea3DObject::myPointRecords

protected

DtEnvironmentalBoundingSphereRecord vrvControlToolkit::DtArea3DObject::myBoundingSphereRecord

protected

Dt3DGraphicalObjectStateRecord vrvControlToolkit::DtArea3DObject::myStateRecord

protected

DtVector vrvControlToolkit::DtArea3DObject::myEmptyVertex

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrvDrawControl/DtArea3DObject.h

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation