makVre::DtVortexMovementPSR Class Reference

Detailed Description

Maintains state data for the DtVortexMovementActuator. This state is saved as part of the scenario, ensuring persistence between scenario loads. The primary state maintained is whether high-fidelity collision physics should be used for stationary CGF entities.

#include <vortexMovementPSR.h>

Inheritance diagram for makVre::DtVortexMovementPSR:

Public Member Functions
	DtVortexMovementPSR (DtLocalObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVortexMovementPSR (const DtVortexMovementPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
virtual	~DtVortexMovementPSR () override
DtVortexMovementPSR &	operator= (const DtVortexMovementPSR &orig)
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const override
virtual DtString	type () const override
virtual void	setUseHiFiCollisionsInStationaryCgfState (bool value)
virtual bool	useHiFiCollisionsInStationaryCgfState () const

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

Protected Attributes
DtRwBoolean	myUseHiFiCollisionsInStationaryCgfState

Constructor & Destructor Documentation

DtVortexMovementPSR() [1/2]

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

Constructor.

Creates a process state repository associated with a VR-Forces object.

Parameters

vrfObject	The VR-Forces object this repository is associated with
rwName	Optional name for the reader/writer
parentRegistry	Optional parent registry

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

DtVortexMovementPSR() [2/2]

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

Copy constructor.

Creates a new process state repository as a copy of an existing one.

Parameters

orig	The original repository to copy
rwName	Optional name for the reader/writer
parentRegistry	Optional parent registry

References DtVortexMovementPSR().

~DtVortexMovementPSR()

virtual makVre::DtVortexMovementPSR::~DtVortexMovementPSR ( )

overridevirtual

Destructor.

Member Function Documentation

operator=()

DtVortexMovementPSR & makVre::DtVortexMovementPSR::operator=

(

const DtVortexMovementPSR &

orig

)

Assignment operator.

Copies the state from another repository to this one.

Parameters

orig	The original repository to copy from

Returns

Reference to this repository

References DtVortexMovementPSR().

clone()

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

overridevirtual

Creates a clone of this repository.

Parameters

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

Returns

Pointer to the new repository

type()

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

overridevirtual

Gets the type of this repository.

Returns

DtVortexMovementPSRType

setUseHiFiCollisionsInStationaryCgfState()

virtual void makVre::DtVortexMovementPSR::setUseHiFiCollisionsInStationaryCgfState ( bool value )

virtual

Sets whether high-fidelity collisions should be used for stationary CGF entities.

Controls whether entities should model high-fidelity Vortex collisions while in a CGF state but not currently executing any movement tasks.

Parameters

value

True to enable high-fidelity collisions, false to disable

useHiFiCollisionsInStationaryCgfState()

virtual bool makVre::DtVortexMovementPSR::useHiFiCollisionsInStationaryCgfState ( ) const

virtual

Checks if high-fidelity collisions should be used for stationary CGF entities.

Returns

True if high-fidelity collisions are enabled, false otherwise

creator()

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

static

Factory method to create new instances of this class.

Parameters

rwName	Name for the reader/writer
vrfObject	The VR-Forces object to associate with
parentRegistry	Optional parent registry

Returns

Pointer to the new repository

Member Data Documentation

myUseHiFiCollisionsInStationaryCgfState

DtRwBoolean makVre::DtVortexMovementPSR::myUseHiFiCollisionsInStationaryCgfState

protected

Flag for using high-fidelity collisions in stationary CGF state.

---

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

• include/vrfExtensions/vreVrfVortex/vortexMovementPSR.h