makVre::DtCommentConnector Class Reference

Detailed Description

DtCommentConnector registers a VR-Link callback for incoming DtCommentInteraction objects and forwards relevant messages into the VR-Engage message system. It also listens for internal CommentMessage instances originating from the local player and transmits them as Comment interactions on the exercise connection.

#include <commentConnector.h>

Inheritance diagram for makVre::DtCommentConnector:

Public Member Functions
	DtCommentConnector ()
virtual	~DtCommentConnector () override
virtual void	install (DtPlayerStationApp *app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection *connection) override
virtual void	tick () override
virtual void	shutdown () override
virtual void	handleCommentInteraction (DtCommentInteraction *comment)
virtual DtVreMessageResult	handleCommentMessage (DtVreMessage *msg)
Public Member Functions inherited from makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector
	DtSimEventConnector ()
virtual	~DtSimEventConnector () override
Public Member Functions inherited from makVre::DtConnector
	DtConnector ()
virtual	~DtConnector ()
virtual DtConnectorType	type ()
virtual std::string	name ()

Protected Attributes
DtEntityIdentifier	myEntityId
Protected Attributes inherited from makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector
DtPlayerStationApp *	myApp
makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection *	myConnection
Protected Attributes inherited from makVre::DtConnector
std::string	myName
DtConnectorType	myType

Additional Inherited Members
Public Types inherited from makVre::DtConnector
enum	DtConnectorType {   DIS , HLA13 , HLA1516 , HLA1516E ,   HLA4 }
Static Public Member Functions inherited from makVre::DtConnector
static std::string	extension (DtConnectorType type)

Constructor & Destructor Documentation

DtCommentConnector()

makVre::DtCommentConnector::DtCommentConnector

(

)

Constructs a connector with no associated player entity identifier.

~DtCommentConnector()

virtual makVre::DtCommentConnector::~DtCommentConnector ( )

overridevirtual

Virtual destructor to support polymorphic deletion.

Member Function Documentation

install()

virtual void makVre::DtCommentConnector::install ( DtPlayerStationApp * app, makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection * connection )

overridevirtual

Installs the connector with the given player station application and VR-Link connection, determines the local entity identifier, and registers network and message callbacks.

Reimplemented from makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector.

tick()

virtual void makVre::DtCommentConnector::tick ( )

overridevirtual

Per-frame update hook. The example does not require periodic work but keeps the standard connector interface.

Reimplemented from makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector.

shutdown()

virtual void makVre::DtCommentConnector::shutdown ( )

overridevirtual

Removes network and message callbacks and releases connector resources.

Reimplemented from makVre::DT_PROTOCOL_NAMESPACE::DtSimEventConnector.

handleCommentInteraction()

virtual void makVre::DtCommentConnector::handleCommentInteraction ( DtCommentInteraction * comment )

virtual

Handles an incoming Comment interaction from the exercise connection and, when addressed to the local entity, converts it into an internal CommentMessage queued on the message manager.

handleCommentMessage()

virtual DtVreMessageResult makVre::DtCommentConnector::handleCommentMessage ( DtVreMessage * msg )

virtual

Handles an internal CommentMessage and, when sent by the local entity, constructs and transmits a corresponding Comment interaction on the exercise connection.

Member Data Documentation

myEntityId

DtEntityIdentifier makVre::DtCommentConnector::myEntityId

protected

DIS/HLA entity identifier for the local player station entity.

---

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

• examples/customPdu/commentNet/commentConnector.h