makVre::DtVreVrfEmbarkationPSR Class Reference

Detailed Description

This class extends the basic embarkation PSR to provide VREngage-specific functionality for entity embarkation operations. It adds support for tracking slot points and other embarkation-related state data, which is used to position entities during embarkation and to animate embarkation sequences.

#include <vreVrfEmbarkationPSR.h>

Inheritance diagram for makVre::DtVreVrfEmbarkationPSR:

Public Member Functions
	DtVreVrfEmbarkationPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVreVrfEmbarkationPSR (const DtVreVrfEmbarkationPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVreVrfEmbarkationPSR () override
DtVreVrfEmbarkationPSR &	operator= (const DtVreVrfEmbarkationPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
virtual const DtRwVector &	slotPoint () const
virtual void	setSlotPoint (const DtRwVector &slotPoint)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject *vrfObject, DtReaderWriterRegistry *parentRegistry)

Protected Attributes
DtRwVector	mySlotPoint

Constructor & Destructor Documentation

DtVreVrfEmbarkationPSR() [1/2]

makVre::DtVreVrfEmbarkationPSR::DtVreVrfEmbarkationPSR	(	DtLocalObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0 )

Constructor with VRF object and optional name.

Parameters

vrfObject	Pointer to the local object this PSR is associated with
rwName	Optional reader/writer name
parentRegistry	Optional parent registry for reader/writer functionality

Creates a new embarkation PSR for the specified VRF object.

Referenced by DtVreVrfEmbarkationPSR(), and operator=().

DtVreVrfEmbarkationPSR() [2/2]

makVre::DtVreVrfEmbarkationPSR::DtVreVrfEmbarkationPSR	(	const DtVreVrfEmbarkationPSR &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0 )

Copy constructor.

Parameters

orig	The source PSR to copy from
rwName	Optional reader/writer name
parentRegistry	Optional parent registry for reader/writer functionality

Creates a new embarkation PSR as a copy of the provided original.

References DtVreVrfEmbarkationPSR().

~DtVreVrfEmbarkationPSR()

virtual makVre::DtVreVrfEmbarkationPSR::~DtVreVrfEmbarkationPSR ( )

overridevirtual

Virtual destructor.

Cleans up resources used by the PSR.

Member Function Documentation

operator=()

DtVreVrfEmbarkationPSR & makVre::DtVreVrfEmbarkationPSR::operator=

(

const DtVreVrfEmbarkationPSR &

orig

)

Assignment operator.

Parameters

orig	The source PSR to copy from

Returns

Reference to this PSR after assignment

Assigns the contents of the provided PSR to this one.

References DtVreVrfEmbarkationPSR().

clone()

virtual DtVrfProcessStateRepository * makVre::DtVreVrfEmbarkationPSR::clone ( const DtString & rwName = DtString::nullString(), DtReaderWriterRegistry * parentRegistry = 0 ) const

overridevirtual

Creates a clone of this PSR.

Parameters

rwName	Optional reader/writer name for the clone
parentRegistry	Optional parent registry for reader/writer functionality

Returns

Pointer to a new PSR that is a clone of this one

Creates a new embarkation PSR as a deep copy of this one.

type()

virtual DtString makVre::DtVreVrfEmbarkationPSR::type ( ) const

overridevirtual

Gets the type identifier for this PSR.

Returns

String identifying this PSR type

Returns a unique type identifier string for this PSR type. Will return DtVreVrfEmbarkationPSRType.

slotPoint()

virtual const DtRwVector & makVre::DtVreVrfEmbarkationPSR::slotPoint ( ) const

virtual

Gets the slot point for embarkation.

Returns

Const reference to the slot point vector

Returns the slot point where an entity should be positioned during embarkation. This is the point in local coordinates where the embarking entity should initially be placed.

Referenced by setSlotPoint().

setSlotPoint()

virtual void makVre::DtVreVrfEmbarkationPSR::setSlotPoint ( const DtRwVector & slotPoint )

virtual

Sets the slot point for embarkation.

Parameters

slotPoint

The new slot point vector

Sets the slot point where an entity should be positioned during embarkation. This is the point in local coordinates where the embarking entity should initially be placed.

References slotPoint().

creator()

static DtVrfProcessStateRepository * makVre::DtVreVrfEmbarkationPSR::creator ( const DtString & rwName, DtLocalObject * vrfObject, DtReaderWriterRegistry * parentRegistry )

static

Factory function to create a new instance of this PSR.

Parameters

rwName	The reader/writer name for the new instance
vrfObject	Pointer to the local object this PSR will be associated with
parentRegistry	Parent registry for reader/writer functionality

Returns

Pointer to a newly created PSR instance

Static factory function used by the PSR creation system to instantiate new instances of this PSR type.

Member Data Documentation

mySlotPoint

DtRwVector makVre::DtVreVrfEmbarkationPSR::mySlotPoint

protected

Slot point for embarkation.

Stores the slot point where an entity should be positioned during embarkation. This is the point in local coordinates where the embarking entity should initially be placed.

---

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

• include/vrfExtensions/vreVrfobjcore/vreVrfEmbarkationPSR.h