The DtVrlinkElement class implements the common behavior of VR-Link simulation based elements added to the scene. More...

Inheritance diagram for makVrv::DtVrlinkElement:

[legend]

Public Member Functions
	DtVrlinkElement (DtBaseConnection &conn, DtElementID elementId)
	Construct an element with the base connection and the element id.
virtual	~DtVrlinkElement ()
virtual void	visualize (const DtSharedModelSetSettings::ModelSetVisualizedMap &sets)
	Visualize the element.
virtual void	setVisible (bool visible)
	Set the element to be visible.
bool	visible () const
	Get whether the element is visible.
DtElementID	elementID () const
	Get the element ID of the element.
const DtUnicode &	definition () const
	Accessor to get the visual definition.
virtual DtElementEntry::ObjectType	elementType () const =0
	Virtual function for getting the element type.
virtual void	changeElementAttribute (const DtElementAttribute *attr)
	Request a change to the value of one of this element's attributes.

Protected Member Functions
void	reportElementCreated ()
	Report that an element was created.
void	reportDisplayName ()
	Report that an element display name has changed.
void	reportConnectionObjectType ()
	Report an element's ID.
void	reportConnectionObjectID ()
	Report an element's type.
void	reportOverlayNameChanged ()
	Report that an element parent overlay name has changed.
void	reportVisibility ()
	Report that an element visibility has changed.
void	reportDamageStateChanged ()
	Report that an element damage state has changed.
void	updateEntityType (const DtEntityType &type)
void	slot_updateDisplayNameRaw (const char *text)
	Called when display name for the element has been changed - passed as raw.
void	slot_updateOverlayNameRaw (const char *text)
	Called when overlay name for the element has been changed - passed as raw.
void	slot_updateConnectionObjectID (const DtEntityIdentifier &id)
	Called when the entity identifier is discovered.
void	slot_updateDisplayName (const std::string &text)
	Called when display name for the element has been changed.
void	slot_updateOverlayName (const std::string &pname)
	Called when overlay name for the element has been changed.
void	slot_updateDamageState (const unsigned int state)
	Called when damage state for the element has been changed.
virtual void	getDefinitions (std::vector< DtUnicode > &definitions)=0
virtual void	setModelSetEnabled (int modelSet, bool enabled)=0

Protected Attributes
DtBaseConnection &	myBaseConnection
DtElementID	myElementId
DtUnicode	myElementDefinition
std::string	myConnectionObjectID
std::string	myConnectionObjectType
std::string	myDisplayName
std::string	myElementOverlayName
unsigned int	myDamageState
bool	myElementVisible
bool	myElementReported

Detailed Description

The DtVrlinkElement class implements the common behavior of VR-Link simulation based elements added to the scene.

Examples of specific elements include Entities, and Tactical Graphics.

Constructor & Destructor Documentation

makVrv::DtVrlinkElement::DtVrlinkElement	(	DtBaseConnection &	conn,
		DtElementID	elementId
	)

Construct an element with the base connection and the element id.

virtual makVrv::DtVrlinkElement::~DtVrlinkElement ( )

virtual

Member Function Documentation

virtual void makVrv::DtVrlinkElement::visualize ( const DtSharedModelSetSettings::ModelSetVisualizedMap & sets )

virtual

Visualize the element.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtDynamicTerrainElement, makVrv::DT_PROTOCOL_NAMESPACE::DtSmokeElement, makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement, makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtLaserDesignatorElement.

virtual void makVrv::DtVrlinkElement::setVisible ( bool visible )

virtual

Set the element to be visible.

Reimplemented in makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement, makVrv::DT_PROTOCOL_NAMESPACE::DtSmokeElement, makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtLaserDesignatorElement.

bool makVrv::DtVrlinkElement::visible ( ) const

Get whether the element is visible.

DtElementID makVrv::DtVrlinkElement::elementID ( ) const

inline

Get the element ID of the element.

Usually the element ID is the unique id of the listener.

const DtUnicode& makVrv::DtVrlinkElement::definition ( ) const

Accessor to get the visual definition.

The definition changes when updateEntityType is called.

virtual DtElementEntry::ObjectType makVrv::DtVrlinkElement::elementType ( ) const

pure virtual

Virtual function for getting the element type.

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, makVrv::DT_PROTOCOL_NAMESPACE::DtDynamicTerrainElement, makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement, makVrv::DT_PROTOCOL_NAMESPACE::DtLaserDesignatorElement, makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtSmokeElement.

virtual void makVrv::DtVrlinkElement::changeElementAttribute ( const DtElementAttribute * attr )

virtual

Request a change to the value of one of this element's attributes.

Non-elements (inluding objects in the main thread) may request that the value of some attribute of an element be modifed; that is effected here.

void makVrv::DtVrlinkElement::reportElementCreated ( )

protected

Report that an element was created.

void makVrv::DtVrlinkElement::reportDisplayName ( )

protected

Report that an element display name has changed.

void makVrv::DtVrlinkElement::reportConnectionObjectType ( )

protected

Report an element's ID.

void makVrv::DtVrlinkElement::reportConnectionObjectID ( )

protected

Report an element's type.

void makVrv::DtVrlinkElement::reportOverlayNameChanged ( )

protected

Report that an element parent overlay name has changed.

void makVrv::DtVrlinkElement::reportVisibility ( )

protected

Report that an element visibility has changed.

void makVrv::DtVrlinkElement::reportDamageStateChanged ( )

protected

Report that an element damage state has changed.

void makVrv::DtVrlinkElement::updateEntityType ( const DtEntityType & type )

protected

void makVrv::DtVrlinkElement::slot_updateDisplayNameRaw ( const char * text )

protected

Called when display name for the element has been changed - passed as raw.

void makVrv::DtVrlinkElement::slot_updateOverlayNameRaw ( const char * text )

protected

Called when overlay name for the element has been changed - passed as raw.

void makVrv::DtVrlinkElement::slot_updateConnectionObjectID ( const DtEntityIdentifier & id )

protected

Called when the entity identifier is discovered.

void makVrv::DtVrlinkElement::slot_updateDisplayName ( const std::string & text )

protected

Called when display name for the element has been changed.

void makVrv::DtVrlinkElement::slot_updateOverlayName ( const std::string & pname )

protected

Called when overlay name for the element has been changed.

void makVrv::DtVrlinkElement::slot_updateDamageState ( const unsigned int state )

protected

Called when damage state for the element has been changed.

virtual void makVrv::DtVrlinkElement::getDefinitions ( std::vector< DtUnicode > & definitions )

protectedpure virtual

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement, makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement, makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, makVrv::DT_PROTOCOL_NAMESPACE::DtDynamicTerrainElement, makVrv::DT_PROTOCOL_NAMESPACE::DtLaserDesignatorElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtSmokeElement.

virtual void makVrv::DtVrlinkElement::setModelSetEnabled	(	int	modelSet,
		bool	enabled
	)

protectedpure virtual

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtDynamicTerrainElement, makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement, makVrv::DT_PROTOCOL_NAMESPACE::DtSmokeElement, makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement, makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtLaserDesignatorElement.

Member Data Documentation

DtBaseConnection& makVrv::DtVrlinkElement::myBaseConnection

protected

DtElementID makVrv::DtVrlinkElement::myElementId

protected

DtUnicode makVrv::DtVrlinkElement::myElementDefinition

protected

std::string makVrv::DtVrlinkElement::myConnectionObjectID

protected

std::string makVrv::DtVrlinkElement::myConnectionObjectType

protected

std::string makVrv::DtVrlinkElement::myDisplayName

protected

std::string makVrv::DtVrlinkElement::myElementOverlayName

protected

unsigned int makVrv::DtVrlinkElement::myDamageState

protected

bool makVrv::DtVrlinkElement::myElementVisible

protected

bool makVrv::DtVrlinkElement::myElementReported

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvVrl/DtVrlinkElement.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation