DtArticulatedPartStateRepository Class Reference

DtArticulatedPartStateRepository; class for representing DIS/RPR articulated parts. More...

Inheritance diagram for DtArticulatedPartStateRepository:

List of all members.

Public Types
enum	DtJointAxis { DtYAW, DtPITCH, DtROLL }
	This will be extended to have a DtNoCONSTRAINT value, and then one of these will be passed as an optional argument to setOrientation() calls in the kinematic state methods. More...
Public Member Functions
	DtArticulatedPartStateRepository (DtVrfObject *simObject, const DtObjectType &objectType, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtArticulatedPartStateRepository &	operator= (const DtArticulatedPartStateRepository &orig)
virtual	~DtArticulatedPartStateRepository ()
virtual DtSimObjectStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
virtual DtString	type () const
	returns DtSimObjectStateRepositoryType
DtReal	angle () const
	To use angle, setAngle, turnRate, and setTurnRate as written, we will need to cache a constraint value (in the new interface, this constraint is provided as an option value).
DtReal	turnRate () const
void	setTurnRate (DtReal turnRate)
void	setAngle (DtReal angle)
void	setBodyPartType (const DtArtPartType &type)
	These are converted to/from DtEntityTypes.
DtArtPartType	bodyPartType ()
virtual DtReal	artPartPosition () const
virtual void	setArtPartPosition (DtReal position)
virtual DtReal	artPartPositionRate () const
virtual void	setArtPartPositionRate (DtReal rate)
virtual DtReal	extension () const
virtual void	setExtension (DtReal extension)
virtual DtReal	extensionRate () const
virtual void	setExtensionRate (DtReal rate)
Public Attributes
DtJointAxis	myJointAxis
Protected Member Functions
	DtArticulatedPartStateRepository (const DtArticulatedPartStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
Protected Attributes
DtReal	myArtPartPosition
DtReal	myArtPartPositionRate
DtReal	myExtension
DtReal	myExtensionRate

---

Detailed Description

DtArticulatedPartStateRepository; class for representing DIS/RPR articulated parts.

The DtArticulatedPartStateRepository class is used to represent articulated parts for an entity. When an entity is created, a tree of articulated part state repository objects gets constructed based on the contents of the parameter database entry. The parameter database entry indicates the type of part to create, which part is should be attached to, and what parameter(s) should be set for the part. The base state repository for this tree is the state repository for the entity.

---

Member Enumeration Documentation

enum DtArticulatedPartStateRepository::DtJointAxis

This will be extended to have a DtNoCONSTRAINT value, and then one of these will be passed as an optional argument to setOrientation() calls in the kinematic state methods.

Enumerator:

DtYAW
DtPITCH
DtROLL

---

Constructor & Destructor Documentation

DtArticulatedPartStateRepository::DtArticulatedPartStateRepository	(	DtVrfObject *	simObject,
		const DtObjectType &	objectType,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

DtArticulatedPartStateRepository::DtArticulatedPartStateRepository	(	const DtArticulatedPartStateRepository &	orig,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		[protected]

virtual DtArticulatedPartStateRepository::~DtArticulatedPartStateRepository

(

)

[virtual]

---

Member Function Documentation

const DtArticulatedPartStateRepository& DtArticulatedPartStateRepository::operator=

(

const DtArticulatedPartStateRepository &

orig

)

virtual DtSimObjectStateRepository* DtArticulatedPartStateRepository::clone	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)		const [virtual]

Reimplemented from DtSimObjectStateRepository.

virtual DtString DtArticulatedPartStateRepository::type

(

)

const [virtual]

returns DtSimObjectStateRepositoryType

Reimplemented from DtSimObjectStateRepository.

DtReal DtArticulatedPartStateRepository::angle

(

)

const

To use angle, setAngle, turnRate, and setTurnRate as written, we will need to cache a constraint value (in the new interface, this constraint is provided as an option value).

DtReal DtArticulatedPartStateRepository::turnRate

(

)

const

void DtArticulatedPartStateRepository::setTurnRate

(

DtReal

turnRate

)

void DtArticulatedPartStateRepository::setAngle

(

DtReal

angle

)

void DtArticulatedPartStateRepository::setBodyPartType

(

const DtArtPartType &

type

)

---

These are converted to/from DtEntityTypes.

The state rep for a base part gets DtEntityBase

DtArtPartType DtArticulatedPartStateRepository::bodyPartType

(

)

virtual DtReal DtArticulatedPartStateRepository::artPartPosition

(

)

const [virtual]

virtual void DtArticulatedPartStateRepository::setArtPartPosition

(

DtReal

position

)

[virtual]

virtual DtReal DtArticulatedPartStateRepository::artPartPositionRate

(

)

const [virtual]

virtual void DtArticulatedPartStateRepository::setArtPartPositionRate

(

DtReal

rate

)

[virtual]

virtual DtReal DtArticulatedPartStateRepository::extension

(

)

const [virtual]

virtual void DtArticulatedPartStateRepository::setExtension

(

DtReal

extension

)

[virtual]

virtual DtReal DtArticulatedPartStateRepository::extensionRate

(

)

const [virtual]

virtual void DtArticulatedPartStateRepository::setExtensionRate

(

DtReal

rate

)

[virtual]

---

Member Data Documentation

DtJointAxis DtArticulatedPartStateRepository::myJointAxis

DtReal DtArticulatedPartStateRepository::myArtPartPosition [protected]

DtReal DtArticulatedPartStateRepository::myArtPartPositionRate [protected]

DtReal DtArticulatedPartStateRepository::myExtension [protected]

DtReal DtArticulatedPartStateRepository::myExtensionRate [protected]

---

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

• include/vrfobjcore/artPartSR.h