makVre::DtFpsFirstPersonUpdaterAgent Class Reference

Detailed Description

DtFpsFirstPersonUpdaterAgent provides a distributed interface for controlling DtFpsFirstPersonUpdater objects. It enables remote control of first-person model orientation and configuration across distributed rendering systems. This agent forwards calls to the actual updater object, handling distribution when needed.

#include <DtFpsFirstPersonUpdaterAgent.hpp>

Inheritance diagram for makVre::DtFpsFirstPersonUpdaterAgent:

Public Member Functions
	DtFpsFirstPersonUpdaterAgent ()
virtual	~DtFpsFirstPersonUpdaterAgent () override
DtFpsFirstPersonUpdater *	findObject ()
const DtFpsFirstPersonUpdater *	findObject () const
virtual void	setModelPitch (float pitch)=0
virtual void	setModelHeading (float heading)=0
virtual void	setPitchAxis (char axis)=0
virtual void	setBaseRotation (DtVector yawPitchRoll)=0
virtual void	setPivotJoint (std::string jointName)=0
Public Member Functions inherited from makVre::DtSceneObjectMimicUpdaterAgent
	DtSceneObjectMimicUpdaterAgent ()
virtual	~DtSceneObjectMimicUpdaterAgent ()
DtSceneObjectMimicUpdater *	findObject ()
const DtSceneObjectMimicUpdater *	findObject () const
virtual void	setParentSceneObject (makVrv::DtUniqueID id)=0
virtual void	setModelOffset (const DtVector &offset)=0

Static Public Member Functions
static DtFpsFirstPersonUpdaterAgent *	create (makVrv::DtAgentManagerInterface &sceneInterface, bool bDistribute=true)
Static Public Member Functions inherited from makVre::DtSceneObjectMimicUpdaterAgent
static DtSceneObjectMimicUpdaterAgent *	create (makVrv::DtAgentManagerInterface &sceneInterface, bool bDistribute=true)

Protected Member Functions
virtual DtFpsFirstPersonUpdater *	findObjectAsDtFpsFirstPersonUpdater ()=0
Protected Member Functions inherited from makVre::DtSceneObjectMimicUpdaterAgent
virtual DtSceneObjectMimicUpdater *	findObjectAsDtSceneObjectMimicUpdater ()=0

Constructor & Destructor Documentation

DtFpsFirstPersonUpdaterAgent()

makVre::DtFpsFirstPersonUpdaterAgent::DtFpsFirstPersonUpdaterAgent

(

)

Default constructor.

Referenced by create().

~DtFpsFirstPersonUpdaterAgent()

virtual makVre::DtFpsFirstPersonUpdaterAgent::~DtFpsFirstPersonUpdaterAgent ( )

overridevirtual

Virtual destructor.

Member Function Documentation

create()

static DtFpsFirstPersonUpdaterAgent * makVre::DtFpsFirstPersonUpdaterAgent::create ( makVrv::DtAgentManagerInterface & sceneInterface, bool bDistribute = true )

static

Static helper method to create an instance of this agent.

Parameters

sceneInterface	Reference to the agent manager interface
bDistribute	Flag indicating whether to distribute this agent

Returns

Pointer to a newly created agent instance

References DtFpsFirstPersonUpdaterAgent().

findObject() [1/2]

DtFpsFirstPersonUpdater * makVre::DtFpsFirstPersonUpdaterAgent::findObject

(

)

Finds the actual updater object this agent is controlling.

Returns

Pointer to the controlled DtFpsFirstPersonUpdater object

Warning

Any direct modifications to the actual object will NOT work when using distributed rendering

findObject() [2/2]

const DtFpsFirstPersonUpdater * makVre::DtFpsFirstPersonUpdaterAgent::findObject

(

)

const

Finds the actual updater object this agent is controlling (const version)

Returns

Const pointer to the controlled DtFpsFirstPersonUpdater object

Warning

Any direct modifications to the actual object will NOT work when using distributed rendering

setModelPitch()

virtual void makVre::DtFpsFirstPersonUpdaterAgent::setModelPitch ( float pitch )

pure virtual

Sets the pitch of the first-person model.

Parameters

pitch

Pitch angle in degrees

Controls the pitch rotation of the first-person model, relative to the parent entity's SceneObject orientation.

Implemented in makVre::DtFpsFirstPersonUpdaterAgentImplementation.

setModelHeading()

virtual void makVre::DtFpsFirstPersonUpdaterAgent::setModelHeading ( float heading )

pure virtual

Sets the heading of the first-person model.

Parameters

heading

Heading angle in degrees

Controls the heading rotation of the first-person model, relative to the parent entity's SceneObject orientation.

Implemented in makVre::DtFpsFirstPersonUpdaterAgentImplementation.

setPitchAxis()

virtual void makVre::DtFpsFirstPersonUpdaterAgent::setPitchAxis ( char axis )

pure virtual

Sets the axis used for pitch rotation.

Parameters

axis	Character representing the axis ('X', 'Y', or 'Z')

Configuration parameter that controls which axis is used by setModelPitch. Default is 'Y'.

Implemented in makVre::DtFpsFirstPersonUpdaterAgentImplementation.

setBaseRotation()

virtual void makVre::DtFpsFirstPersonUpdaterAgent::setBaseRotation ( DtVector yawPitchRoll )

pure virtual

Sets the base rotation for the first-person model.

Parameters

yawPitchRoll

Vector containing yaw, pitch, and roll values in degrees

Configuration parameter that sets a base rotation for the first-person model. Values from setModelPitch and setModelHeading are added to this base rotation. Value is relative to the parent entity's SceneObject. Default is (0,0,0).

Implemented in makVre::DtFpsFirstPersonUpdaterAgentImplementation.

setPivotJoint()

virtual void makVre::DtFpsFirstPersonUpdaterAgent::setPivotJoint ( std::string jointName )

pure virtual

Sets the pivot joint for model rotation.

Parameters

jointName

Name of the skeletal joint to use as pivot

Configuration parameter that specifies the name of the skeletal joint in the first-person model around which the model should be rotated. Default is "cervical".

Implemented in makVre::DtFpsFirstPersonUpdaterAgentImplementation.

findObjectAsDtFpsFirstPersonUpdater()

virtual DtFpsFirstPersonUpdater * makVre::DtFpsFirstPersonUpdaterAgent::findObjectAsDtFpsFirstPersonUpdater ( )

protectedpure virtual

Implementation method to find the controlled object as DtFpsFirstPersonUpdater.

Returns

Pointer to the controlled DtFpsFirstPersonUpdater object

Implemented in makVre::DtFpsFirstPersonUpdaterAgentImplementation.

---

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

• include/roles/human/vreHumanFrontend/DtFpsFirstPersonUpdaterAgent.hpp