VR-Engage  2.2
Loading...
Searching...
No Matches
makVre::RenderTextureInitializedMessage Class Reference

#include <renderTextureInitialized.h>

Inheritance diagram for makVre::RenderTextureInitializedMessage:
[legend]

Classes

struct  RenderTextureInitializedData
 

Public Types

enum  WindowType { WindowType_Gimbal , WindowType_PVD , WindowType_Stealth , WindowType_InstrumentPanel }
 

Public Member Functions

virtual const std::string & type () const override
 
virtual const makVre::DtVreMessageIdmessageId () const override
 
virtual ~RenderTextureInitializedMessage () override
 
virtual WindowType getWindowType () const
 
virtual void setWindowType (WindowType val)
 
virtual int getTextureIndex () const
 
virtual void setTextureIndex (int val)
 
virtual const DtEntityIdentifier & getHostId () const
 
virtual void setHostId (const DtEntityIdentifier &val)
 
virtual const std::string & getCameraStructName () const
 
virtual void setCameraStructName (const std::string &val)
 
virtual const std::string & getChannelName () const
 
virtual void setChannelName (const std::string &val)
 
virtual const std::string & getWindowName () const
 
virtual void setWindowName (const std::string &val)
 
virtual int messageSize () const override
 
RenderTextureInitializedData getData ()
 
RenderTextureInitializedData getData () const
 
bool operator== (const RenderTextureInitializedMessage &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 RenderTextureInitializedMessagecreate ()
 
static RenderTextureInitializedMessagecreateFrom (RenderTextureInitializedMessage *)
 
static RenderTextureInitializedMessagecreateFromData (const RenderTextureInitializedData)
 
static const std::string & theType ()
 
static const makVre::DtVreMessageIdtheId ()
 
static UInt64 theVersionNumber ()
 
static makVre::DtVreMessagedecode (char *buffer, int length)
 

Protected Member Functions

 RenderTextureInitializedMessage ()
 
virtual void serialize (DtStreamWriter &writer) const override
 
virtual void deserialize (DtStreamReader &reader) override
 

Protected Attributes

RenderTextureInitializedData 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

◆ WindowType

Enumerator
WindowType_Gimbal 
WindowType_PVD 
WindowType_Stealth 
WindowType_InstrumentPanel 

Constructor & Destructor Documentation

◆ ~RenderTextureInitializedMessage()

virtual makVre::RenderTextureInitializedMessage::~RenderTextureInitializedMessage ( )
overridevirtual

◆ RenderTextureInitializedMessage()

makVre::RenderTextureInitializedMessage::RenderTextureInitializedMessage ( )
protected

Member Function Documentation

◆ create()

static RenderTextureInitializedMessage * makVre::RenderTextureInitializedMessage::create ( )
static

◆ createFrom()

static RenderTextureInitializedMessage * makVre::RenderTextureInitializedMessage::createFrom ( RenderTextureInitializedMessage * )
static

◆ createFromData()

static RenderTextureInitializedMessage * makVre::RenderTextureInitializedMessage::createFromData ( const RenderTextureInitializedData )
static

◆ theType()

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

static message identity functions

◆ theId()

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

◆ theVersionNumber()

static UInt64 makVre::RenderTextureInitializedMessage::theVersionNumber ( )
static

◆ type()

virtual const std::string & makVre::RenderTextureInitializedMessage::type ( ) const
overridevirtual

Get the name of the message type.

Implements makVre::DtVreMessage.

◆ messageId()

virtual const makVre::DtVreMessageId & makVre::RenderTextureInitializedMessage::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.

◆ getWindowType()

virtual WindowType makVre::RenderTextureInitializedMessage::getWindowType ( ) const
virtual

◆ setWindowType()

virtual void makVre::RenderTextureInitializedMessage::setWindowType ( WindowType val)
virtual

◆ getTextureIndex()

virtual int makVre::RenderTextureInitializedMessage::getTextureIndex ( ) const
virtual

◆ setTextureIndex()

virtual void makVre::RenderTextureInitializedMessage::setTextureIndex ( int val)
virtual

◆ getHostId()

virtual const DtEntityIdentifier & makVre::RenderTextureInitializedMessage::getHostId ( ) const
virtual

◆ setHostId()

virtual void makVre::RenderTextureInitializedMessage::setHostId ( const DtEntityIdentifier & val)
virtual

◆ getCameraStructName()

virtual const std::string & makVre::RenderTextureInitializedMessage::getCameraStructName ( ) const
virtual

◆ setCameraStructName()

virtual void makVre::RenderTextureInitializedMessage::setCameraStructName ( const std::string & val)
virtual

◆ getChannelName()

virtual const std::string & makVre::RenderTextureInitializedMessage::getChannelName ( ) const
virtual

◆ setChannelName()

virtual void makVre::RenderTextureInitializedMessage::setChannelName ( const std::string & val)
virtual

◆ getWindowName()

virtual const std::string & makVre::RenderTextureInitializedMessage::getWindowName ( ) const
virtual

◆ setWindowName()

virtual void makVre::RenderTextureInitializedMessage::setWindowName ( const std::string & val)
virtual

◆ messageSize()

virtual int makVre::RenderTextureInitializedMessage::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);
DtVreMessage()
Default constructor.
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()

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

◆ getData() [1/2]

RenderTextureInitializedData makVre::RenderTextureInitializedMessage::getData ( )

◆ getData() [2/2]

RenderTextureInitializedData makVre::RenderTextureInitializedMessage::getData ( ) const

◆ operator==()

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

◆ serialize()

virtual void makVre::RenderTextureInitializedMessage::serialize ( DtStreamWriter & writer) const
overrideprotectedvirtual

Serializes the message to a stream writer.

Parameters
writerReference 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()

virtual void makVre::RenderTextureInitializedMessage::deserialize ( DtStreamReader & reader)
overrideprotectedvirtual

Deserializes the message from a stream reader.

Parameters
readerReference 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.

Member Data Documentation

◆ theMessageId

makVre::DtVreMessageId makVre::RenderTextureInitializedMessage::theMessageId
staticprotected

◆ theVersion

UInt64 makVre::RenderTextureInitializedMessage::theVersion
staticprotected

◆ myData

RenderTextureInitializedData makVre::RenderTextureInitializedMessage::myData
protected

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