VR-Forces 4.10 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
makVrv::DtElement Class Referenceabstract

The DtElement class implements the common behavior of simulation based elements added to the scene. More...

Inheritance diagram for makVrv::DtElement:
Inheritance graph
[legend]

Public Member Functions

 DtElement (DtBaseConnection &conn, DtElementID elementId)
 Construct an element with the base connection and the element id. More...
 
virtual ~DtElement ()
 DTOR. More...
 
 DtElement ()=delete
 not allowed - default constructor More...
 
 DtElement (const DtElement &)=delete
 not allowed - copy constructor More...
 
DtElementoperator= (const DtElement &)=delete
 not allowed - equals operator More...
 
virtual void visualize (const DtSharedModelSetSettings::ModelSetVisualizedMap &sets)
 Visualize the element. More...
 
virtual void setVisible (bool visible)
 Set the element to be visible. More...
 
virtual bool visible () const
 Get whether the element is visible. More...
 
DtElementID elementID () const
 Get the element ID of the element. More...
 
virtual const DtUnicodedefinition () const
 Accessor to get the visual definition. More...
 
virtual DtElementEntry::ObjectType elementType () const =0
 Virtual function for getting the element type. More...
 
virtual void changeElementAttribute (const DtElementAttribute *attr)
 Request a change to the value of one of this element's attributes. More...
 

Protected Member Functions

virtual void updateConnectionObjectType (const std::string &type)
 Called by derived types Calls reportConnectionObjectType. More...
 
virtual void setElementSubtype (DtElementAttributes::ElementSubtypes subtype)
 Set the member variable myElementSubtype. More...
 
void slot_updateOverlayNameRaw (const char *text)
 Called when overlay name for the element has been changed - passed as raw. More...
 
void slot_updateConnectionObjectID (const std::string &id)
 Called when the entity identifier is discovered. More...
 
void slot_updateDisplayName (const std::string &text)
 Called when display name for the element has been changed. More...
 
void slot_updateOverlayName (const std::string &pname)
 Called when overlay name for the element has been changed. More...
 
void slot_updateDamageState (DtEntityStateListener::DamageState state)
 Called when damage state for the element has been changed. More...
 
virtual void getDefinitions (std::vector< DtUnicode > &definitions)=0
 
virtual void setModelSetEnabled (int modelSet, bool enabled)=0
 
virtual void reportElementCreated ()
 Reporting Methods. More...
 
virtual void reportDisplayName ()
 Report that an element display name has changed. More...
 
virtual void reportConnectionObjectID ()
 Report an element's ID. More...
 
virtual void reportConnectionObjectType ()
 Report an element's type. More...
 
virtual void reportOverlayNameChanged ()
 Report that an element parent overlay name has changed. More...
 
virtual void reportVisibility ()
 Report that an element visibility has changed. More...
 
virtual void reportDamageStateChanged ()
 Report that an element damage state has changed. More...
 
virtual void reportDriverType ()=0
 Report that the element comes from a VR-Link connection. More...
 
virtual void reportElementSubtype ()
 Report the element's subtype. More...
 
virtual void reportElementDefinitionName ()
 Report the element's element definition. More...
 

Protected Attributes

DtBaseConnectionmyBaseConnection
 
DtElementID myElementId
 
DtUnicode myElementDefinition
 
std::string myConnectionObjectID
 
std::string myConnectionObjectType
 
std::string myDisplayName
 
std::string myElementOverlayName
 
DtElementAttributes::ElementSubtypes myElementSubtype
 
DtEntityStateListener::DamageState myDamageState
 
bool myElementVisible
 
bool myElementReported
 

Detailed Description

The DtElement class implements the common behavior of simulation based elements added to the scene.

Examples of specific elements include Entities, and Tactical Graphics.

Constructor & Destructor Documentation

makVrv::DtElement::DtElement ( DtBaseConnection conn,
DtElementID  elementId 
)

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

virtual makVrv::DtElement::~DtElement ( )
virtual

DTOR.

makVrv::DtElement::DtElement ( )
delete

not allowed - default constructor

makVrv::DtElement::DtElement ( const DtElement )
delete

not allowed - copy constructor

Member Function Documentation

DtElement& makVrv::DtElement::operator= ( const DtElement )
delete

not allowed - equals operator

virtual void makVrv::DtElement::visualize ( const DtSharedModelSetSettings::ModelSetVisualizedMap sets)
virtual
virtual void makVrv::DtElement::setVisible ( bool  visible)
virtual
virtual bool makVrv::DtElement::visible ( ) const
virtual

Get whether the element is visible.

DtElementID makVrv::DtElement::elementID ( ) const
inline

Get the element ID of the element.

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

virtual const DtUnicode& makVrv::DtElement::definition ( ) const
virtual

Accessor to get the visual definition.

The definition changes when updateEntityType is called.

virtual DtElementEntry::ObjectType makVrv::DtElement::elementType ( ) const
pure virtual
virtual void makVrv::DtElement::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.

virtual void makVrv::DtElement::reportElementCreated ( )
protectedvirtual

Reporting Methods.

Report that an element was created.

virtual void makVrv::DtElement::reportDisplayName ( )
protectedvirtual

Report that an element display name has changed.

virtual void makVrv::DtElement::reportConnectionObjectID ( )
protectedvirtual

Report an element's ID.

virtual void makVrv::DtElement::reportConnectionObjectType ( )
protectedvirtual

Report an element's type.

virtual void makVrv::DtElement::reportOverlayNameChanged ( )
protectedvirtual

Report that an element parent overlay name has changed.

virtual void makVrv::DtElement::reportVisibility ( )
protectedvirtual

Report that an element visibility has changed.

virtual void makVrv::DtElement::reportDamageStateChanged ( )
protectedvirtual

Report that an element damage state has changed.

virtual void makVrv::DtElement::reportDriverType ( )
protectedpure virtual
virtual void makVrv::DtElement::reportElementSubtype ( )
protectedvirtual

Report the element's subtype.

Some element types (Entity and Aggregate currently) that are used to further categorized them for display

virtual void makVrv::DtElement::reportElementDefinitionName ( )
protectedvirtual

Report the element's element definition.

virtual void makVrv::DtElement::updateConnectionObjectType ( const std::string &  type)
protectedvirtual

Called by derived types Calls reportConnectionObjectType.

virtual void makVrv::DtElement::setElementSubtype ( DtElementAttributes::ElementSubtypes  subtype)
protectedvirtual

Set the member variable myElementSubtype.

void makVrv::DtElement::slot_updateOverlayNameRaw ( const char text)
protected

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

void makVrv::DtElement::slot_updateConnectionObjectID ( const std::string &  id)
protected

Called when the entity identifier is discovered.

void makVrv::DtElement::slot_updateDisplayName ( const std::string &  text)
protected

Called when display name for the element has been changed.

void makVrv::DtElement::slot_updateOverlayName ( const std::string &  pname)
protected

Called when overlay name for the element has been changed.

void makVrv::DtElement::slot_updateDamageState ( DtEntityStateListener::DamageState  state)
protected

Called when damage state for the element has been changed.

virtual void makVrv::DtElement::getDefinitions ( std::vector< DtUnicode > &  definitions)
protectedpure virtual
virtual void makVrv::DtElement::setModelSetEnabled ( int  modelSet,
bool  enabled 
)
protectedpure virtual

Member Data Documentation

DtBaseConnection& makVrv::DtElement::myBaseConnection
protected
DtElementID makVrv::DtElement::myElementId
protected
DtUnicode makVrv::DtElement::myElementDefinition
protected
std::string makVrv::DtElement::myConnectionObjectID
protected
std::string makVrv::DtElement::myConnectionObjectType
protected
std::string makVrv::DtElement::myDisplayName
protected
std::string makVrv::DtElement::myElementOverlayName
protected
DtElementAttributes::ElementSubtypes makVrv::DtElement::myElementSubtype
protected
DtEntityStateListener::DamageState makVrv::DtElement::myDamageState
protected
bool makVrv::DtElement::myElementVisible
protected
bool makVrv::DtElement::myElementReported
protected

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

Document ID: Generated on Tue Sep 21 17:42:52 EDT 2021 from SVN revision 234861
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)