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

Inheritance diagram for makVrv::DtVrlinkElement:

[legend]

List of all members.

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.
Protected Member Functions
void	reportElementCreated ()
	Report that an element was created.
void	reportDisplayName ()
	Report that an element display name has changed.
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_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	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::DtTacticalGraphicElement, makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement.

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::DtEntityElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement.

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::DtAggregateElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement.

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::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_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 ) [protected, pure virtual]

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement.

virtual void makVrv::DtVrlinkElement::setModelSetEnabled	(	int	modelSet,
		bool	enabled
	)		`[protected, pure virtual]`

Implemented in makVrv::DT_PROTOCOL_NAMESPACE::DtAggregateElement, makVrv::DT_PROTOCOL_NAMESPACE::DtEntityElement, and makVrv::DT_PROTOCOL_NAMESPACE::DtTacticalGraphicElement.

Member Data Documentation

DtBaseConnection& makVrv::DtVrlinkElement::myBaseConnection [protected]

DtElementID makVrv::DtVrlinkElement::myElementId [protected]

DtUnicode makVrv::DtVrlinkElement::myElementDefinition [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:

include/vrvVrl/DtVrlinkElement.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation