TMComponentsArg Struct Reference

Search for all occurrences

---

Detailed Description

See also:

Class Control, Class Matrix3, Class Point3, Class Interval, Class Quat, Class ScaleValue.

Remarks:

This structure is available in release 4.0 and later only.

This structure is for collecting the return results of Control::GetLocalTMComponents. Position, Rotation, or Scale, controllers will put results at the respective component when the corresponding pointer is not NULL.

#include <control.h>

Inheritance diagram for TMComponentsArg:

List of all members.

Public Types
enum	RotationRep {   kXYZ, kXZY, kYZX, kYXZ,   kZXY, kZYX, kXYX, kYZY,   kZXZ, kQuat, kUnknown }
Public Member Functions
	TMComponentsArg ()
	TMComponentsArg (Point3 *pos, Interval *posInv, float *rot, Interval *rotInv, ScaleValue *scl, Interval *sclInv)
Public Attributes
Point3 *	position
	If not NULL this is the position.
Interval *	posValidity
	If not NULL this points to the validity interval for the position.
float *	rotation
	If not NULL this is the rotation and should be a float[4].
Interval *	rotValidity
	If not NULL this points to the validity interval for the rotation.
RotationRep	rotRep
	The rotation representation.
ScaleValue *	scale
	If non-NULL this is the ScaleValue.
Interval *	sclValidity
	The validity interval for the ScaleValue.

---

Member Enumeration Documentation

enum RotationRep

Search for all occurrences

Enumerator:

kXYZ	Search for all occurrences
kXZY	Search for all occurrences
kYZX	Search for all occurrences
kYXZ	Search for all occurrences
kZXY	Search for all occurrences
kZYX	Search for all occurrences
kXYX	Search for all occurrences
kYZY	Search for all occurrences
kZXZ	Search for all occurrences
kQuat	Search for all occurrences
kUnknown	Search for all occurrences

                   {
   // kXYZ should equals EULERTYPE_XYZ, which is 0.(c.f. euler.h)
   kXYZ,
   kXZY,
   kYZX,
   kYXZ,
   kZXY,
   kZYX,
   kXYX,
   kYZY,
   kZXZ,
   kQuat,
   kUnknown
  };

---

Constructor & Destructor Documentation

TMComponentsArg

(

)

[inline]

Remarks:

Constructor

:position(0),rotation(0),scale(0),rotRep(kUnknown) {}

TMComponentsArg	(	Point3 *	pos,
		Interval *	posInv,
		float *	rot,
		Interval *	rotInv,
		ScaleValue *	scl,
		Interval *	sclInv
	)		[inline]

Remarks:

Constructor

   : position(pos),posValidity(posInv),rotation(rot),rotValidity(rotInv)
   , scale(scl),sclValidity(sclInv) {}

---

Member Data Documentation

Point3* position

Search for all occurrences

If not NULL this is the position.

Interval* posValidity

Search for all occurrences

If not NULL this points to the validity interval for the position.

float* rotation

Search for all occurrences

If not NULL this is the rotation and should be a float[4].

Interval* rotValidity

Search for all occurrences

If not NULL this points to the validity interval for the rotation.

RotationRep rotRep

Search for all occurrences

The rotation representation.

This defines what the 4 numbers in the rotation array mean. One of the following enum values:
kXYZ - Same as EULERTYPE_XYZ
kXZY - Same as EULERTYPE_XZY
kYZX - Same as EULERTYPE_YZX
kYXZ - Same as EULERTYPE_YXZ
kZXY - Same as EULERTYPE_ZXY
kZYX - Same as EULERTYPE_ZYX
kXYX - Same as EULERTYPE_XYX
kYZY - Same as EULERTYPE_YZY
kZXZ - Same as EULERTYPE_ZXZ
kQuat - A quaternion representation.
kUnknown - An unknown representation.

ScaleValue* scale

Search for all occurrences

If non-NULL this is the ScaleValue.

Interval* sclValidity

Search for all occurrences

The validity interval for the ScaleValue.