DtMechAddon Class Reference

Detailed Description

Provides additional functionality for Vortex mechanisms, including pre-step callbacks for synchronizing with VR-Forces.

#include <vortexMovementActuator.h>

Inheritance diagram for DtMechAddon:

Public Member Functions
	DtMechAddon (VxSim::VxExtension *proxy)
virtual	~DtMechAddon () override
virtual void	preStep () override
void	setVortexMovementActuator (DtVortexMovementActuator *obj)
void	setUpdatingFromCGF (bool cgfDriven)

Static Public Attributes
static const VxSim::VxFactoryKey	kFactoryKey

Protected Attributes
DtVortexMovementActuator *	myMovementActuator
bool	myUpdatingFromCGF

Constructor & Destructor Documentation

DtMechAddon()

DtMechAddon::DtMechAddon ( VxSim::VxExtension * proxy )

explicit

Constructor.

Parameters

proxy

Pointer to the extension proxy

~DtMechAddon()

virtual DtMechAddon::~DtMechAddon ( )

overridevirtual

Destructor.

Member Function Documentation

preStep()

virtual void DtMechAddon::preStep ( )

overridevirtual

Called before each physics step.

Updates the Vortex mechanism from VR-Forces data.

setVortexMovementActuator()

void DtMechAddon::setVortexMovementActuator

(

DtVortexMovementActuator *

obj

)

Sets the movement actuator to communicate with.

Parameters

obj	Pointer to the movement actuator

setUpdatingFromCGF()

void DtMechAddon::setUpdatingFromCGF

(

bool

cgfDriven

)

Sets whether updates come from CGF.

Parameters

cgfDriven

True if driven by CGF, false if player-controlled

Member Data Documentation

kFactoryKey

const VxSim::VxFactoryKey DtMechAddon::kFactoryKey

static

Factory key for creating instances of this addon.

myMovementActuator

DtVortexMovementActuator* DtMechAddon::myMovementActuator

protected

The movement actuator.

myUpdatingFromCGF

bool DtMechAddon::myUpdatingFromCGF

protected

Flag indicating if updates come from CGF.

---

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

• include/vrfExtensions/vreVrfVortex/vortexMovementActuator.h