DtHumanEyepointController Class Reference

End User Description: This controller monitors the posture of the lifeform entity that it is mounted on, and provides an eyepoint position appropriate to the current posture of the output port. More...

Inheritance diagram for DtHumanEyepointController:

List of all members.

Public Member Functions
	DtHumanEyepointController (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
virtual	~DtHumanEyepointController ()
	destructor
virtual bool	init ()
	Calls createPorts and createPortGroups Initializes myLastTickSimTime.
virtual DtString	type () const
	Returns a string identifies the class type of component.
virtual void	tick ()
	This gives the thread of control to the component.
Static Public Member Functions
static DtSimComponent *	creator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
	(const DtString&,DtVrfObject*,DtSimManager*,
Protected Member Functions
virtual bool	createPortGroups ()
	creates myEyepointOutputPortGroup.
virtual bool	createPorts ()
	Creates myOrientationOutputPort and myPositionOutputPort.
Protected Attributes
DtHumanStateRepository *	myLifeformStateRep
DtLifeformState	myLastState
int	myLookDirection
Ports and Port Groups
DtOutputPortGroup *	myEyepointOutputPortGroup
	Outputs: Output Port Group Name: eyepoint-offset Output Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity origin.
DtOrientationOutputPort *	myOrientationOutputPort
	Output Port Name: orientation Input Port Description: Always outputs 0,0,0.
DtVectorOutputPort *	myPositionOutputPort
	Output Port Name: position Output Port Description: Specifies the position of the eyes of the lifeform.
Private Member Functions
	DtHumanEyepointController ()
	Not implemented.
	DtHumanEyepointController (const DtHumanEyepointController &orig)
	Not implemented.
const DtHumanEyepointController &	operator= (const DtHumanEyepointController &orig)
	Not implemented.

---

Detailed Description

End User Description: This controller monitors the posture of the lifeform entity that it is mounted on, and provides an eyepoint position appropriate to the current posture of the output port.

For example, a crawling entity will have its eyepoint low, and forward in comparison to the same entity when standing. It is designed to be connected to a DtObjectSensor or derived type of sensor.

Uses Descriptor Type: DtComponentDescriptor

---

Constructor & Destructor Documentation

DtHumanEyepointController::DtHumanEyepointController	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

virtual DtHumanEyepointController::~DtHumanEyepointController

(

)

[virtual]

destructor

DtHumanEyepointController::DtHumanEyepointController

(

)

[private]

Not implemented.

DtHumanEyepointController::DtHumanEyepointController

(

const DtHumanEyepointController &

orig

)

[private]

Not implemented.

---

Member Function Documentation

virtual bool DtHumanEyepointController::init

(

)

[virtual]

Calls createPorts and createPortGroups Initializes myLastTickSimTime.

Reimplemented from DtControllerComponent.

virtual DtString DtHumanEyepointController::type

(

)

const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:

DtHumanEyepointControllerType

Reimplemented from DtControllerComponent.

virtual void DtHumanEyepointController::tick

(

)

[virtual]

This gives the thread of control to the component.

The component is ticked once each simulation from by the component list it's on. This base class tick has no functionality.

Reimplemented from DtSimComponent.

static DtSimComponent* DtHumanEyepointController::creator	(	const DtString &	name,
		DtVrfObject *	owner,
		DtSimManager *	simManager,
		DtComponentDescriptor *	desc = 0,
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:

name	Reader writer name of this component.
owner	The DtVrfObject that owns this component
simManager	The simulation manager (provides access to terrain, message interface, simulation clock).
desc	The component descriptor used to initialize this component.
parentRegistry	Pointer to the parent reader writer registry (the containing object that reads/writes this object).

(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:

New instance of this class.

const DtHumanEyepointController& DtHumanEyepointController::operator=

(

const DtHumanEyepointController &

orig

)

[private]

Not implemented.

virtual bool DtHumanEyepointController::createPortGroups

(

)

[protected, virtual]

creates myEyepointOutputPortGroup.

Reimplemented from DtSimComponent.

virtual bool DtHumanEyepointController::createPorts

(

)

[protected, virtual]

Creates myOrientationOutputPort and myPositionOutputPort.

Reimplemented from DtSimComponent.

---

Member Data Documentation

DtOutputPortGroup* DtHumanEyepointController::myEyepointOutputPortGroup [protected]

Outputs: Output Port Group Name: eyepoint-offset
Output Port Group Description: Allows an external controller to provide position and orientation of the sensor relative to the entity origin.

Designed to be connected to a DtObjectSensor or derived class.

DtOrientationOutputPort* DtHumanEyepointController::myOrientationOutputPort [protected]

Output Port Name: orientation
Input Port Description: Always outputs 0,0,0.

This controller doesn't do any orientation changes of the eyepoint.
Output Port Range:
Output Port Default Value: 0,0,0
Output Group Parent: sensor-offset

DtVectorOutputPort* DtHumanEyepointController::myPositionOutputPort [protected]

Output Port Name: position
Output Port Description: Specifies the position of the eyes of the lifeform.

This position changes based on posture of the entity.
Output Port Range:
Output Group Parent: sensor-offset

DtHumanStateRepository* DtHumanEyepointController::myLifeformStateRep [protected]

DtLifeformState DtHumanEyepointController::myLastState [protected]

int DtHumanEyepointController::myLookDirection [protected]

---

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

• include/vrfmodel/humanEyepointController.h