DtSimArtPartDescriptor Class Reference

A readable, writable type that holds an articulated part type, attached-to part type, attachment point, and a list of art-part params (DtSimArtPartParamList). More...

Inheritance diagram for DtSimArtPartDescriptor:

List of all members.

Public Member Functions
	DtSimArtPartDescriptor (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtSimArtPartDescriptor (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtSimArtPartDescriptor (const DtString &partName, const DtSimArtPartDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtSimArtPartDescriptor (const DtSymbolString &partName, const DtSimArtPartDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtSimArtPartDescriptor &	operator= (const DtSimArtPartDescriptor &orig)
	assignment
virtual	~DtSimArtPartDescriptor ()
virtual DtSimArtPartDescriptor *	clone (const DtString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtSimArtPartDescriptor *	clone (const DtSymbolString &partName, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	setParamList (const DtSimArtPartParamList &paramList)
	Accessor/mutator for myParamList.
virtual const DtSimArtPartParamList &	paramList () const
	Accessor/mutator for myParamList.
virtual void	setPartType (DtArtPartType partType)
	Accessor/mutator for myPartType.
virtual DtArtPartType	partType () const
	Accessor/mutator for myPartType.
virtual void	setParentPartType (DtArtPartType partType)
	Accessor/mutator for myParentPartType.
virtual DtArtPartType	parentPartType () const
	Accessor/mutator for myParentPartType.
virtual void	setAttachPoint (const DtVector &attachPoint)
	Accessor/mutator for myAttachPoint.
virtual const DtVector &	attachPoint () const
	Accessor/mutator for myAttachPoint.
Protected Member Functions
	DtSimArtPartDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwInt	myPartType
	Parameter Name: art-part-type Parameter Description: The type of an articulated part.
DtRwInt	myParentPartType
	Parameter Name: parent-part-type Parameter Description: The type of the object to which an articulated part is attached.
DtRwVector	myAttachPoint
	Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object.
DtSimArtPartParamList	myParamList
	Parameter Name: art-part-param-list Parameter Description: List of the VR-Link articulated part parameter types the part should use.

---

Detailed Description

A readable, writable type that holds an articulated part type, attached-to part type, attachment point, and a list of art-part params (DtSimArtPartParamList).

The read/write name is not used for anything in particular, and therefore may be used for file readability.

---

Constructor & Destructor Documentation

DtSimArtPartDescriptor::DtSimArtPartDescriptor

(

)

[protected]

default constructor

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtString &	partName,
		const DtSimArtPartDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtSimArtPartDescriptor::DtSimArtPartDescriptor	(	const DtSymbolString &	partName,
		const DtSimArtPartDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtSimArtPartDescriptor::~DtSimArtPartDescriptor

(

)

[virtual]

---

Member Function Documentation

DtSimArtPartDescriptor& DtSimArtPartDescriptor::operator=

(

const DtSimArtPartDescriptor &

orig

)

assignment

virtual DtSimArtPartDescriptor* DtSimArtPartDescriptor::clone	(	const DtString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual DtSimArtPartDescriptor* DtSimArtPartDescriptor::clone	(	const DtSymbolString &	partName,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)		const [virtual]

virtual void DtSimArtPartDescriptor::setParamList

(

const DtSimArtPartParamList &

paramList

)

[virtual]

Accessor/mutator for myParamList.

virtual const DtSimArtPartParamList& DtSimArtPartDescriptor::paramList

(

)

const [virtual]

Accessor/mutator for myParamList.

virtual void DtSimArtPartDescriptor::setPartType

(

DtArtPartType

partType

)

[virtual]

Accessor/mutator for myPartType.

virtual DtArtPartType DtSimArtPartDescriptor::partType

(

)

const [virtual]

Accessor/mutator for myPartType.

virtual void DtSimArtPartDescriptor::setParentPartType

(

DtArtPartType

partType

)

[virtual]

Accessor/mutator for myParentPartType.

virtual DtArtPartType DtSimArtPartDescriptor::parentPartType

(

)

const [virtual]

Accessor/mutator for myParentPartType.

virtual void DtSimArtPartDescriptor::setAttachPoint

(

const DtVector &

attachPoint

)

[virtual]

Accessor/mutator for myAttachPoint.

virtual const DtVector& DtSimArtPartDescriptor::attachPoint

(

)

const [virtual]

Accessor/mutator for myAttachPoint.

---

Member Data Documentation

DtRwInt DtSimArtPartDescriptor::myPartType [protected]

Parameter Name: art-part-type Parameter Description: The type of an articulated part.

For the list of available values see the DIS Enumeration Document (Enumeration and Bit Encoded Values for Use with Protocols for DIS Applications).

DtRwInt DtSimArtPartDescriptor::myParentPartType [protected]

Parameter Name: parent-part-type
Parameter Description: The type of the object to which an articulated part is attached.

For the list of available values see the DIS Enumeration Document (Enumeration and Bit Encoded Values for Use with Protocols for DIS Applications).
Parameter Default Value: 0

DtRwVector DtSimArtPartDescriptor::myAttachPoint [protected]

Parameter Name: attach-point Parameter Description: The point at which at the articulated or attached part is attached to another object.

If this part is being attached to an entity, then the attach-point is is specified in the body coordinate system of the entity. If part is being attached to another attached or articulated part, then the attach-point is specified in the body coordinate system of the part it is being attached to. In a body coordinate system, the axes are specified as follows:

• x-axis points out of the 'front' of the object
  
• y-axis points out of the 'side' of the object
  
• z-axis points out of the 'bottom' of the object Parameter Default Value: (0. 0. 0.) Parameter Units: meters

DtSimArtPartParamList DtSimArtPartDescriptor::myParamList [protected]

Parameter Name: art-part-param-list
Parameter Description: List of the VR-Link articulated part parameter types the part should use.

Part types may be correlated with 3-D models to visualize motion of part in a Stealth viewer.
Parameter Default Value:

---

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

• include/vrfobjparam/artPartDesc.h