#include <setViewMode.h>

Inheritance diagram for makVre::SetViewModeMessage:

Classes
struct	SetViewModeData

Public Types
enum	ViewMode { ViewMode_FIRST_PERSON , ViewMode_THIRD_PERSON , ViewMode_FIRST_PERSON , ViewMode_THIRD_PERSON }

enum	ViewMode { ViewMode_FIRST_PERSON , ViewMode_THIRD_PERSON , ViewMode_FIRST_PERSON , ViewMode_THIRD_PERSON }

Public Member Functions
virtual const std::string &	type () const override

virtual const makVre::DtVreMessageId &	messageId () const override

virtual	~SetViewModeMessage () override

virtual ViewMode	getMode () const

virtual void	setMode (ViewMode val)

virtual int	messageSize () const override

SetViewModeData	getData ()

SetViewModeData	getData () const

bool	operator== (const SetViewModeMessage &rhs) const

virtual const std::string &	type () const override

virtual const makVre::DtVreMessageId &	messageId () const override

virtual	~SetViewModeMessage () override

virtual ViewMode	getMode () const

virtual void	setMode (ViewMode val)

virtual int	messageSize () const override

SetViewModeData	getData ()

SetViewModeData	getData () const

bool	operator== (const SetViewModeMessage &rhs) const

Public Member Functions inherited from makVre::DtVreMessage
	DtVreMessage ()

virtual	~DtVreMessage ()

virtual char *	encode ()

virtual void	encode (char *buffer, int bufferSize)

virtual const UInt64	originatingApplicationId () const

virtual void	setOriginatingApplicationId (UInt64 appId)

virtual void	setDelay (double delay)

virtual bool	isDelayed ()

virtual void	reduceDelay (double dt)

virtual const UInt64	versionNumber () const

Static Public Member Functions
static SetViewModeMessage *	create ()

static SetViewModeMessage *	createFrom (SetViewModeMessage *)

static SetViewModeMessage *	createFromData (const SetViewModeData)

static const std::string &	theType ()

static const makVre::DtVreMessageId &	theId ()

static UInt64	theVersionNumber ()

static makVre::DtVreMessage *	decode (char *buffer, int length)

static SetViewModeMessage *	create ()

static SetViewModeMessage *	createFrom (SetViewModeMessage *)

static SetViewModeMessage *	createFromData (const SetViewModeData)

static const std::string &	theType ()

static const makVre::DtVreMessageId &	theId ()

static UInt64	theVersionNumber ()

static makVre::DtVreMessage *	decode (char *buffer, int length)

Protected Member Functions
	SetViewModeMessage ()

virtual void	serialize (DtStreamWriter &writer) const override

virtual void	deserialize (DtStreamReader &reader) override

	SetViewModeMessage ()

virtual void	serialize (DtStreamWriter &writer) const override

virtual void	deserialize (DtStreamReader &reader) override

Protected Attributes
SetViewModeData	myData

Protected Attributes inherited from makVre::DtVreMessage
double	myDelay

UInt64	myApplicationId

UInt64	myVersion

Static Protected Attributes
static makVre::DtVreMessageId	theMessageId

static UInt64	theVersion

Member Enumeration Documentation

◆ ViewMode [1/2]

enum makVre::SetViewModeMessage::ViewMode

Enumerator
ViewMode_FIRST_PERSON
ViewMode_THIRD_PERSON
ViewMode_FIRST_PERSON
ViewMode_THIRD_PERSON

◆ ViewMode [2/2]

enum makVre::SetViewModeMessage::ViewMode

Enumerator
ViewMode_FIRST_PERSON
ViewMode_THIRD_PERSON
ViewMode_FIRST_PERSON
ViewMode_THIRD_PERSON

Constructor & Destructor Documentation

◆ ~SetViewModeMessage() [1/2]

virtual makVre::SetViewModeMessage::~SetViewModeMessage ( )

overridevirtual

◆ SetViewModeMessage() [1/2]

makVre::SetViewModeMessage::SetViewModeMessage ( )

protected

Referenced by create(), createFrom(), createFromData(), and operator==().

◆ ~SetViewModeMessage() [2/2]

virtual makVre::SetViewModeMessage::~SetViewModeMessage ( )

overridevirtual

◆ SetViewModeMessage() [2/2]

makVre::SetViewModeMessage::SetViewModeMessage ( )

protected

Member Function Documentation

◆ create() [1/2]

static SetViewModeMessage * makVre::SetViewModeMessage::create ( )

static

References SetViewModeMessage().

◆ createFrom() [1/2]

static SetViewModeMessage * makVre::SetViewModeMessage::createFrom ( SetViewModeMessage * )

static

References SetViewModeMessage().

◆ createFromData() [1/2]

static SetViewModeMessage * makVre::SetViewModeMessage::createFromData ( const SetViewModeData )

static

References SetViewModeMessage().

◆ theType() [1/2]

static const std::string & makVre::SetViewModeMessage::theType ( )

static

static message identity functions

◆ theId() [1/2]

static const makVre::DtVreMessageId & makVre::SetViewModeMessage::theId ( )

static

◆ theVersionNumber() [1/2]

static UInt64 makVre::SetViewModeMessage::theVersionNumber ( )

static

◆ type() [1/2]

virtual const std::string & makVre::SetViewModeMessage::type ( ) const

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId() [1/2]

virtual const makVre::DtVreMessageId & makVre::SetViewModeMessage::messageId ( ) const

overridevirtual

Gets the message ID object.

Returns: Reference to the message ID object

This pure virtual method must be implemented by derived classes to return a unique identifier object for the message. The message ID contains both the type name and a hash value for efficient routing.

Implements makVre::DtVreMessage.

◆ getMode() [1/2]

virtual ViewMode makVre::SetViewModeMessage::getMode ( ) const

virtual

◆ setMode() [1/2]

virtual void makVre::SetViewModeMessage::setMode ( ViewMode val )

virtual

◆ messageSize() [1/2]

virtual int makVre::SetViewModeMessage::messageSize ( ) const

overridevirtual

Static decode function pattern for derived classes.

Note: Each derived class must implement a static decode function with the signature:
static DtVreMessage* decode(unsigned char* buffer, int length);

makVre::DtVreMessage::DtVreMessage
DtVreMessage()
Default constructor.

makVre::SetViewModeMessage::decode
static makVre::DtVreMessage * decode(char *buffer, int length)

This function is used by the message factory to create messages from raw data.

Gets the total size of the serialized message in bytes

Returns: Size of the message in bytes

This method calculates the total size of the message when serialized, including the base message header (message size, type hash, application ID, version, and delay) and any data added by derived classes.

Derived classes should override this method to include their own data size while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ decode() [1/2]

static makVre::DtVreMessage * makVre::SetViewModeMessage::decode	(	char *	buffer,
		int	length )

static

◆ getData() [1/4]

SetViewModeData makVre::SetViewModeMessage::getData ( )

◆ getData() [2/4]

SetViewModeData makVre::SetViewModeMessage::getData ( ) const

◆ operator==() [1/2]

bool makVre::SetViewModeMessage::operator== ( const SetViewModeMessage & rhs ) const

References SetViewModeMessage().

◆ serialize() [1/2]

virtual void makVre::SetViewModeMessage::serialize ( DtStreamWriter & writer ) const

overrideprotectedvirtual

Serializes the message to a stream writer.

Parameters

writer Reference to the stream writer

This method writes the message header fields to the stream writer. Derived classes should override this method to add their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ deserialize() [1/2]

virtual void makVre::SetViewModeMessage::deserialize ( DtStreamReader & reader )

overrideprotectedvirtual

Deserializes the message from a stream reader.

Parameters

reader Reference to the stream reader

This method reads the message header fields from the stream reader. Derived classes should override this method to read their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ create() [2/2]

static SetViewModeMessage * makVre::SetViewModeMessage::create ( )

static

References SetViewModeMessage().

◆ createFrom() [2/2]

static SetViewModeMessage * makVre::SetViewModeMessage::createFrom ( SetViewModeMessage * )

static

References SetViewModeMessage().

◆ createFromData() [2/2]

static SetViewModeMessage * makVre::SetViewModeMessage::createFromData ( const SetViewModeData )

static

References SetViewModeMessage().

◆ theType() [2/2]

static const std::string & makVre::SetViewModeMessage::theType ( )

static

static message identity functions

◆ theId() [2/2]

static const makVre::DtVreMessageId & makVre::SetViewModeMessage::theId ( )

static

◆ theVersionNumber() [2/2]

static UInt64 makVre::SetViewModeMessage::theVersionNumber ( )

static

◆ type() [2/2]

virtual const std::string & makVre::SetViewModeMessage::type ( ) const

overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId() [2/2]

virtual const makVre::DtVreMessageId & makVre::SetViewModeMessage::messageId ( ) const

overridevirtual

Gets the message ID object.

Returns: Reference to the message ID object

This pure virtual method must be implemented by derived classes to return a unique identifier object for the message. The message ID contains both the type name and a hash value for efficient routing.

Implements makVre::DtVreMessage.

◆ getMode() [2/2]

virtual ViewMode makVre::SetViewModeMessage::getMode ( ) const

virtual

◆ setMode() [2/2]

virtual void makVre::SetViewModeMessage::setMode ( ViewMode val )

virtual

◆ messageSize() [2/2]

virtual int makVre::SetViewModeMessage::messageSize ( ) const

overridevirtual

Static decode function pattern for derived classes.

Note: Each derived class must implement a static decode function with the signature:
static DtVreMessage* decode(unsigned char* buffer, int length);

This function is used by the message factory to create messages from raw data.

Gets the total size of the serialized message in bytes

Returns: Size of the message in bytes

This method calculates the total size of the message when serialized, including the base message header (message size, type hash, application ID, version, and delay) and any data added by derived classes.

Derived classes should override this method to include their own data size while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ decode() [2/2]

static makVre::DtVreMessage * makVre::SetViewModeMessage::decode	(	char *	buffer,
		int	length )

static

◆ getData() [3/4]

SetViewModeData makVre::SetViewModeMessage::getData ( )

◆ getData() [4/4]

SetViewModeData makVre::SetViewModeMessage::getData ( ) const

◆ operator==() [2/2]

bool makVre::SetViewModeMessage::operator== ( const SetViewModeMessage & rhs ) const

References SetViewModeMessage().

◆ serialize() [2/2]

virtual void makVre::SetViewModeMessage::serialize ( DtStreamWriter & writer ) const

overrideprotectedvirtual

Serializes the message to a stream writer.

Parameters

writer Reference to the stream writer

This method writes the message header fields to the stream writer. Derived classes should override this method to add their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

◆ deserialize() [2/2]

virtual void makVre::SetViewModeMessage::deserialize ( DtStreamReader & reader )

overrideprotectedvirtual

Deserializes the message from a stream reader.

Parameters

reader Reference to the stream reader

This method reads the message header fields from the stream reader. Derived classes should override this method to read their own fields while calling the base class implementation.

Reimplemented from makVre::DtVreMessage.

References myData, theMessageId, and theVersion.

Member Data Documentation

◆ theMessageId

static makVre::DtVreMessageId makVre::SetViewModeMessage::theMessageId

staticprotected

Referenced by deserialize().

◆ theVersion

static UInt64 makVre::SetViewModeMessage::theVersion

staticprotected

Referenced by deserialize().

◆ myData

SetViewModeData makVre::SetViewModeMessage::myData

protected

Referenced by deserialize().

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

include/framework/vreMessages/setViewMode.h
include/roles/human/setViewMode.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Enumeration Documentation

◆ ViewMode [1/2]

◆ ViewMode [2/2]

Constructor & Destructor Documentation

◆ ~SetViewModeMessage() [1/2]

◆ SetViewModeMessage() [1/2]

◆ ~SetViewModeMessage() [2/2]

◆ SetViewModeMessage() [2/2]

Member Function Documentation

◆ create() [1/2]

◆ createFrom() [1/2]

◆ createFromData() [1/2]

◆ theType() [1/2]

◆ theId() [1/2]

◆ theVersionNumber() [1/2]

◆ type() [1/2]

◆ messageId() [1/2]

◆ getMode() [1/2]

◆ setMode() [1/2]

◆ messageSize() [1/2]

◆ decode() [1/2]

◆ getData() [1/4]

◆ getData() [2/4]

◆ operator==() [1/2]

◆ serialize() [1/2]

◆ deserialize() [1/2]

◆ create() [2/2]

◆ createFrom() [2/2]

◆ createFromData() [2/2]

◆ theType() [2/2]

◆ theId() [2/2]

◆ theVersionNumber() [2/2]

◆ type() [2/2]

◆ messageId() [2/2]

◆ getMode() [2/2]

◆ setMode() [2/2]

◆ messageSize() [2/2]

◆ decode() [2/2]

◆ getData() [3/4]

◆ getData() [4/4]

◆ operator==() [2/2]

◆ serialize() [2/2]

◆ deserialize() [2/2]

Member Data Documentation

◆ theMessageId

◆ theVersion

◆ myData