control.h File Reference

#include "maxheap.h"
#include "plugapi.h"
#include "assert1.h"
#include "geom/matrix3.h"
#include "geom/quat.h"
#include "interval.h"
#include "ref.h"
#include "geom/box3.h"
#include "geom/bitarray.h"
#include "AnimPropertyID.h"
#include "containers/Array.h"
#include <memory>

Classes
class	ScaleValue
struct	TMComponentsArg
class	Matrix3Indirect
class	DelayedMatrix3
struct	DelayedMatrix3::DelayedOp
struct	DelayedMatrix3::OpQueue
class	DelayedNodeMat
class	EaseCurveList
class	EaseCurveAnimProp
class	MultCurveList
class	MultCurveAnimProp
class	CtrlHitRecord
	class CtrlHitRecord More...
class	CtrlHitLog
	class CtrlHitLog More...
class	IKEnumCallback
class	IKDeriv
class	IKClipObject
class	InitJointData
class	InitJointData2
class	InitJointData3
	class InitJointData3 : public InitJointData2 More...
class	DOFParams
class	Control
class	StdControl
class	SetXFormPacket
class	SetMorphTargetPacket
class	MorphControl
class	PointControllerContainer
class	TempStore

Macros
#define	ORT_BEFORE   1
#define	ORT_AFTER   2
#define	ORT_CONSTANT   1
	Tracks values before or after the range of keys remains constant. More...
#define	ORT_CYCLE   2
	Causes the key pattern to repeat cyclically. More...
#define	ORT_LOOP   3
	The same as ORT_CYCLE with continuity. More...
#define	ORT_OSCILLATE   4
	This reverses the range of keys values to cause the pattern to oscillate. More...
#define	ORT_LINEAR   5
	Takes the slope at the end key in the range and extrapolate with that slope. More...
#define	ORT_IDENTITY   6
	This only is used when mapping time to time. More...
#define	ORT_RELATIVE_REPEAT   7
	Causes the key pattern to repeat with the first key taking off where the last key left off. More...
#define	KEY_MODE_NO_BUFFER   1
#define	GetEaseListInterface(anim)   ((EaseCurveList*)anim->GetInterface(I_EASELIST))
#define	GetMultListInterface(anim)   ((MultCurveList*)anim->GetInterface(I_MULTLIST))
#define	POSITION_DERIV   (1<<0)
#define	ROTATION_DERIV   (1<<1)
#define	COPYPASTE_IKPOS   1
#define	COPYPASTE_IKROT   2
#define	DEF_SPRINGTENS   (0.02f)
#define	CONTROLBASE_CHUNK   0x8499
#define	INORT_CHUNK   0x3000
#define	OUTORT_CHUNK   0x3001
#define	CONT_DISABLED_CHUNK   0x3002
#define	CONT_FLAGS_CHUNK   0x3003
#define	INHERIT_POS_X   (1<<0)
#define	INHERIT_POS_Y   (1<<1)
#define	INHERIT_POS_Z   (1<<2)
#define	INHERIT_ROT_X   (1<<3)
#define	INHERIT_ROT_Y   (1<<4)
#define	INHERIT_ROT_Z   (1<<5)
#define	INHERIT_SCL_X   (1<<6)
#define	INHERIT_SCL_Y   (1<<7)
#define	INHERIT_SCL_Z   (1<<8)
#define	INHERIT_ALL   511

Enumerations
enum	GetSetMethod { CTRL_RELATIVE , CTRL_ABSOLUTE }
enum	SetXFormCommand { XFORM_MOVE , XFORM_ROTATE , XFORM_SCALE , XFORM_SET }

Functions
CoreExport void	ApplyScaling (Matrix3 &m, const ScaleValue &v)
CoreExport void	InitControlLists ()
CoreExport ScaleValue	operator+ (const ScaleValue &s0, const ScaleValue &s1)
CoreExport ScaleValue	operator- (const ScaleValue &s0, const ScaleValue &s1)
CoreExport ScaleValue	operator* (const ScaleValue &s, float f)
CoreExport ScaleValue	operator* (float f, const ScaleValue &s)
CoreExport ScaleValue	operator+ (const ScaleValue &s, float f)
CoreExport ScaleValue	operator+ (float f, const ScaleValue &s)
bool	IsInitJointData3 (InitJointData2 *jd)
InitJointData3 *	DowncastToJointData3 (InitJointData2 *jd)
TimeValue	CycleTime (Interval i, TimeValue t)
int	NumCycles (Interval i, TimeValue t)
CoreExport Quat	LinearExtrapolate (TimeValue t0, TimeValue t1, const Quat &val0, const Quat &val1, const Quat &endVal)
CoreExport Quat	RepeatExtrapolate (Interval range, TimeValue t, const Quat &startVal, const Quat &endVal, const Quat &cycleVal)
CoreExport Quat	IdentityExtrapolate (TimeValue endPoint, TimeValue t, const Quat &endVal)
CoreExport ScaleValue	LinearExtrapolate (TimeValue t0, TimeValue t1, const ScaleValue &val0, const ScaleValue &val1, const ScaleValue &endVal)
CoreExport ScaleValue	RepeatExtrapolate (Interval range, TimeValue t, const ScaleValue &startVal, const ScaleValue &endVal, const ScaleValue &cycleVal)
CoreExport ScaleValue	IdentityExtrapolate (TimeValue endPoint, TimeValue t, const ScaleValue &endVal)
CoreExport Matrix3	LinearExtrapolate (TimeValue t0, TimeValue t1, const Matrix3 &val0, const Matrix3 &val1, const Matrix3 &endVal)
CoreExport Matrix3	RepeatExtrapolate (Interval range, TimeValue t, const Matrix3 &startVal, const Matrix3 &endVal, const Matrix3 &cycleVal)
CoreExport Matrix3	IdentityExtrapolate (TimeValue endPoint, TimeValue t, const Matrix3 &endVal)
template<class T >
T	LinearInterpolate (const T &v0, const T &v1, float u)
Quat	LinearInterpolate (const Quat &v0, const Quat &v1, float u)
ScaleValue	LinearInterpolate (const ScaleValue &v0, const ScaleValue &v1, float u)
Interval	TestInterval (Interval iv, DWORD flags)
Quat	ScaleQuat (Quat q, float s)
Template Extrapolation Functions
template<class T >
T	LinearExtrapolate (TimeValue t0, TimeValue t1, const T &val0, const T &val1, const T &endVal)
template<class T >
T	RepeatExtrapolate (Interval range, TimeValue t, const T &startVal, const T &endVal, const T &cycleVal)
CoreExport Point3	RepeatExtrapolate (Interval range, TimeValue t, const Point3 &startVal, const Point3 &endVal, const Point3 &cycleVal)
template<class T >
T	IdentityExtrapolate (TimeValue endPoint, TimeValue t, const T &endVal)
High-level Animation Control
CoreExport int	Animating ()
CoreExport void	AnimateOn ()
CoreExport void	AnimateOff ()
CoreExport void	SuspendAnimate ()
CoreExport void	ResumeAnimate ()
CoreExport BOOL	AreWeAnimating (const TimeValue &t)
CoreExport BOOL	AreWeKeying (const TimeValue &t)
CoreExport TimeValue	GetAnimStart ()
CoreExport TimeValue	GetAnimEnd ()
CoreExport void	SetAnimStart (TimeValue s)
CoreExport void	SetAnimEnd (TimeValue e)
Animation Key Mode Methods
CoreExport BOOL	GetSetKeyMode ()
CoreExport void	SetSetKeyMode (BOOL onOff)
CoreExport void	SuspendSetKeyMode ()
CoreExport void	ResumeSetKeyMode ()
CoreExport BOOL	GetSetKeySuspended ()
CoreExport BOOL	GetSetKeyModeStatus ()
CoreExport BOOL	IsSetKeyModeFeatureEnabled ()

Variables
const DWORD	bJointData3 = (1 << 0)

Additional Controller Related Functions
CoreExport TempStore	tmpStore
CoreExport Control *	NewDefaultFloatController ()
CoreExport Control *	NewDefaultPoint3Controller ()
CoreExport Control *	NewDefaultMatrix3Controller ()
CoreExport Control *	NewDefaultPositionController ()
CoreExport Control *	NewDefaultRotationController ()
CoreExport Control *	NewDefaultScaleController ()
CoreExport Control *	NewDefaultBoolController ()
CoreExport Control *	NewDefaultColorController ()
CoreExport Control *	NewDefaultPointControllerContainer ()
CoreExport Control *	NewDefaultPoint4Controller ()
CoreExport Control *	NewDefaultFRGBAController ()
CoreExport Control *	NewDefaultPoint2Controller ()
CoreExport Control *	CreateInterpFloat ()
CoreExport Control *	CreateInterpPosition ()
CoreExport Control *	CreateInterpPoint3 ()
CoreExport Control *	CreateInterpRotation ()
CoreExport Control *	CreateInterpScale ()
CoreExport Control *	CreatePRSControl ()
CoreExport Control *	CreateLookatControl ()
CoreExport Control *	CreatePointControllerContainer ()
CoreExport Control *	CreateInterpPoint4 ()
CoreExport Control *	CreateInterpPoint2 ()
CoreExport void	SetDefaultController (SClass_ID sid, ClassDesc *desc)
CoreExport ClassDesc *	GetDefaultController (SClass_ID sid)
CoreExport void	SetDefaultColorController (ClassDesc *desc)
CoreExport void	SetDefaultFRGBAController (ClassDesc *desc)
CoreExport void	SetDefaultBoolController (ClassDesc *desc)

Macro Definition Documentation

ORT_BEFORE

#define ORT_BEFORE   1

ORT_AFTER

#define ORT_AFTER   2

KEY_MODE_NO_BUFFER

#define KEY_MODE_NO_BUFFER   1

GetEaseListInterface

#define GetEaseListInterface

(

anim

)

((EaseCurveList*)anim->GetInterface(I_EASELIST))

GetMultListInterface

#define GetMultListInterface

(

anim

)

((MultCurveList*)anim->GetInterface(I_MULTLIST))

POSITION_DERIV

#define POSITION_DERIV   (1<<0)

ROTATION_DERIV

#define ROTATION_DERIV   (1<<1)

COPYPASTE_IKPOS

#define COPYPASTE_IKPOS   1

COPYPASTE_IKROT

#define COPYPASTE_IKROT   2

DEF_SPRINGTENS

#define DEF_SPRINGTENS   (0.02f)

CONTROLBASE_CHUNK

#define CONTROLBASE_CHUNK   0x8499

INORT_CHUNK

#define INORT_CHUNK   0x3000

OUTORT_CHUNK

#define OUTORT_CHUNK   0x3001

CONT_DISABLED_CHUNK

#define CONT_DISABLED_CHUNK   0x3002

CONT_FLAGS_CHUNK

#define CONT_FLAGS_CHUNK   0x3003

INHERIT_POS_X

#define INHERIT_POS_X   (1<<0)

INHERIT_POS_Y

#define INHERIT_POS_Y   (1<<1)

INHERIT_POS_Z

#define INHERIT_POS_Z   (1<<2)

INHERIT_ROT_X

#define INHERIT_ROT_X   (1<<3)

INHERIT_ROT_Y

#define INHERIT_ROT_Y   (1<<4)

INHERIT_ROT_Z

#define INHERIT_ROT_Z   (1<<5)

INHERIT_SCL_X

#define INHERIT_SCL_X   (1<<6)

INHERIT_SCL_Y

#define INHERIT_SCL_Y   (1<<7)

INHERIT_SCL_Z

#define INHERIT_SCL_Z   (1<<8)

INHERIT_ALL

#define INHERIT_ALL   511

Enumeration Type Documentation

GetSetMethod

enum GetSetMethod

Enumerator
CTRL_RELATIVE
CTRL_ABSOLUTE

{CTRL_RELATIVE,CTRL_ABSOLUTE};

SetXFormCommand

enum SetXFormCommand

Enumerator
XFORM_MOVE
XFORM_ROTATE
XFORM_SCALE
XFORM_SET

{ XFORM_MOVE, XFORM_ROTATE, XFORM_SCALE, XFORM_SET };

Function Documentation

ApplyScaling()

CoreExport void ApplyScaling	(	Matrix3 &	m,
		const ScaleValue &	v
	)

InitControlLists()

CoreExport void InitControlLists

(

)

operator+() [1/3]

CoreExport ScaleValue operator+	(	const ScaleValue &	s0,
		const ScaleValue &	s1
	)

Remarks

Returns the sum of two ScaleValues. This still multiplies since scale values are multiplicative not additive.

operator-()

CoreExport ScaleValue operator-	(	const ScaleValue &	s0,
		const ScaleValue &	s1
	)

Remarks

Returns the difference of two ScaleValues.

operator*() [1/2]

CoreExport ScaleValue operator*	(	const ScaleValue &	s,
		float	f
	)

Remarks

Multiplication of a ScaleValue and a float.

operator*() [2/2]

CoreExport ScaleValue operator*	(	float	f,
		const ScaleValue &	s
	)

Remarks

Multiplication of a ScaleValue and a float.

operator+() [2/3]

CoreExport ScaleValue operator+	(	const ScaleValue &	s,
		float	f
	)

Remarks

Returns the sum of a ScaleValue and a float. This adds f to s.x, s.y, and s.z.

operator+() [3/3]

CoreExport ScaleValue operator+	(	float	f,
		const ScaleValue &	s
	)

Remarks

Returns the sum of a ScaleValue and a float.

IsInitJointData3()

bool IsInitJointData3 ( InitJointData2 *  jd )

inline

{
  return (jd->flags & bJointData3);
}

DowncastToJointData3()

InitJointData3* DowncastToJointData3 ( InitJointData2 *  jd )

inline

{
  return IsInitJointData3(jd) ? (InitJointData3*)jd : NULL;
}

CycleTime()

TimeValue CycleTime ( Interval  i, TimeValue  t  )

inline

Remarks

Returns a TimeValue that is the specified time mod of the interval length. The returned time is somewhere within the interval passed. This cycles the time so that it appears within the interval.

   {
   int res, dur = i.Duration()-1;
   if (dur<=0) return t;      
   res   = (t-i.Start())%dur;
   if (t<i.Start()) {
      return i.End()+res;
   } else {
      return i.Start()+res;
      }
   }

NumCycles()

int NumCycles ( Interval  i, TimeValue  t  )

inline

Remarks

Returns the number of times the TimeValue cycles through the interval.

   {
   int dur = i.Duration()-1;
   if (dur<=0) return 1;
   if (t<i.Start()) {
      return (abs(t-i.Start())/dur)+1;
   } else 
   if (t>i.End()) {
      return (abs(t-i.End())/dur)+1;
   } else {
      return 0;
      }
   }

LinearExtrapolate() [1/4]

T LinearExtrapolate	(	TimeValue	t0,
		TimeValue	t1,
		const T &	val0,
		const T &	val1,
		const T &	endVal
	)

Remarks

Performs a linear extrapolation and returns the result.

{
    return (T)(endVal + (val1-val0) * float(t1-t0));
}

RepeatExtrapolate() [1/5]

T RepeatExtrapolate	(	Interval	range,
		TimeValue	t,
		const T &	startVal,
		const T &	endVal,
		const T &	cycleVal
	)

Remarks

Performs a repeat extrapolation and returns the result. This will cycle the time t into the interval range.

{
    int cycles = NumCycles(range,t);
    T delta;
    if (t<range.Start()) {
        delta = startVal - endVal;
    } else {
        delta = endVal - startVal;
    }
    return (T)(cycleVal + delta * float(cycles));
}

RepeatExtrapolate() [2/5]

CoreExport Point3 RepeatExtrapolate	(	Interval	range,
		TimeValue	t,
		const Point3 &	startVal,
		const Point3 &	endVal,
		const Point3 &	cycleVal
	)

Remarks

Performs a linear extrapolation and returns the result.

IdentityExtrapolate() [1/4]

T IdentityExtrapolate	(	TimeValue	endPoint,
		TimeValue	t,
		const T &	endVal
	)

Remarks

Performs a linear extrapolation using a slope of one and a point, and returns the result.

{
    return (T)(endVal + float(t-endPoint));
}

LinearExtrapolate() [2/4]

CoreExport Quat LinearExtrapolate	(	TimeValue	t0,
		TimeValue	t1,
		const Quat &	val0,
		const Quat &	val1,
		const Quat &	endVal
	)

RepeatExtrapolate() [3/5]

CoreExport Quat RepeatExtrapolate	(	Interval	range,
		TimeValue	t,
		const Quat &	startVal,
		const Quat &	endVal,
		const Quat &	cycleVal
	)

IdentityExtrapolate() [2/4]

CoreExport Quat IdentityExtrapolate	(	TimeValue	endPoint,
		TimeValue	t,
		const Quat &	endVal
	)

LinearExtrapolate() [3/4]

CoreExport ScaleValue LinearExtrapolate	(	TimeValue	t0,
		TimeValue	t1,
		const ScaleValue &	val0,
		const ScaleValue &	val1,
		const ScaleValue &	endVal
	)

RepeatExtrapolate() [4/5]

CoreExport ScaleValue RepeatExtrapolate	(	Interval	range,
		TimeValue	t,
		const ScaleValue &	startVal,
		const ScaleValue &	endVal,
		const ScaleValue &	cycleVal
	)

IdentityExtrapolate() [3/4]

CoreExport ScaleValue IdentityExtrapolate	(	TimeValue	endPoint,
		TimeValue	t,
		const ScaleValue &	endVal
	)

LinearExtrapolate() [4/4]

CoreExport Matrix3 LinearExtrapolate	(	TimeValue	t0,
		TimeValue	t1,
		const Matrix3 &	val0,
		const Matrix3 &	val1,
		const Matrix3 &	endVal
	)

RepeatExtrapolate() [5/5]

CoreExport Matrix3 RepeatExtrapolate	(	Interval	range,
		TimeValue	t,
		const Matrix3 &	startVal,
		const Matrix3 &	endVal,
		const Matrix3 &	cycleVal
	)

IdentityExtrapolate() [4/4]

CoreExport Matrix3 IdentityExtrapolate	(	TimeValue	endPoint,
		TimeValue	t,
		const Matrix3 &	endVal
	)

LinearInterpolate() [1/3]

T LinearInterpolate	(	const T &	v0,
		const T &	v1,
		float	u
	)

{
    return (T)((1.0f-u)*v0 + u*v1);
}

LinearInterpolate() [2/3]

Quat LinearInterpolate ( const Quat &  v0, const Quat &  v1, float  u  )

inline

   {
   return Slerp(v0,v1,u);
   }

LinearInterpolate() [3/3]

ScaleValue LinearInterpolate ( const ScaleValue &  v0, const ScaleValue &  v1, float  u  )

inline

   {
   ScaleValue res;
   res.s = ((float)1.0-u)*v0.s + u*v1.s;
   res.q = Slerp(v0.q,v1.q,u);
   return res;
   }

TestInterval()

Interval TestInterval ( Interval  iv, DWORD  flags  )

inline

Remarks

Takes an interval and checks the flags and modifies the interval based on the state of the flags.

   {
   TimeValue start = iv.Start();
   TimeValue end = iv.End();
   if (!(flags&TIME_INCLEFT)) {
      start++;
      }  
   if (!(flags&TIME_INCRIGHT)) {
      end--;
      }
   if (end<start) {
      iv.SetEmpty();
   } else {
      iv.Set(start,end);
      }
   return iv;  
   }

ScaleQuat()

Quat ScaleQuat ( Quat  q, float  s  )

inline

Remarks

Returns a quaternion scaled by the specified factor. This scales the 'angle' of the quaternion.

   {
   float angle;
   Point3 axis;
   AngAxisFromQ(q,&angle,axis);
   return QFromAngAxis(angle*s,axis);
   }

Animating()

CoreExport int Animating

(

)

AnimateOn()

CoreExport void AnimateOn

(

)

AnimateOff()

CoreExport void AnimateOff

(

)

SuspendAnimate()

CoreExport void SuspendAnimate

(

)

ResumeAnimate()

CoreExport void ResumeAnimate

(

)

AreWeAnimating()

CoreExport BOOL AreWeAnimating

(

const TimeValue &

t

)

AreWeKeying()

CoreExport BOOL AreWeKeying

(

const TimeValue &

t

)

GetAnimStart()

CoreExport TimeValue GetAnimStart

(

)

GetAnimEnd()

CoreExport TimeValue GetAnimEnd

(

)

SetAnimStart()

CoreExport void SetAnimStart

(

TimeValue

s

)

SetAnimEnd()

CoreExport void SetAnimEnd

(

TimeValue

e

)

NewDefaultFloatController()

CoreExport Control* NewDefaultFloatController

(

)

NewDefaultPoint3Controller()

CoreExport Control* NewDefaultPoint3Controller

(

)

NewDefaultMatrix3Controller()

CoreExport Control* NewDefaultMatrix3Controller

(

)

NewDefaultPositionController()

CoreExport Control* NewDefaultPositionController

(

)

NewDefaultRotationController()

CoreExport Control* NewDefaultRotationController

(

)

NewDefaultScaleController()

CoreExport Control* NewDefaultScaleController

(

)

NewDefaultBoolController()

CoreExport Control* NewDefaultBoolController

(

)

NewDefaultColorController()

CoreExport Control* NewDefaultColorController

(

)

NewDefaultPointControllerContainer()

CoreExport Control* NewDefaultPointControllerContainer

(

)

NewDefaultPoint4Controller()

CoreExport Control* NewDefaultPoint4Controller

(

)

NewDefaultFRGBAController()

CoreExport Control* NewDefaultFRGBAController

(

)

NewDefaultPoint2Controller()

CoreExport Control* NewDefaultPoint2Controller

(

)

CreateInterpFloat()

CoreExport Control* CreateInterpFloat

(

)

CreateInterpPosition()

CoreExport Control* CreateInterpPosition

(

)

CreateInterpPoint3()

CoreExport Control* CreateInterpPoint3

(

)

CreateInterpRotation()

CoreExport Control* CreateInterpRotation

(

)

CreateInterpScale()

CoreExport Control* CreateInterpScale

(

)

CreatePRSControl()

CoreExport Control* CreatePRSControl

(

)

CreateLookatControl()

CoreExport Control* CreateLookatControl

(

)

CreatePointControllerContainer()

CoreExport Control* CreatePointControllerContainer

(

)

CreateInterpPoint4()

CoreExport Control* CreateInterpPoint4

(

)

CreateInterpPoint2()

CoreExport Control* CreateInterpPoint2

(

)

SetDefaultController()

CoreExport void SetDefaultController	(	SClass_ID	sid,
		ClassDesc *	desc
	)

GetDefaultController()

CoreExport ClassDesc* GetDefaultController

(

SClass_ID

sid

)

SetDefaultColorController()

CoreExport void SetDefaultColorController

(

ClassDesc *

desc

)

SetDefaultFRGBAController()

CoreExport void SetDefaultFRGBAController

(

ClassDesc *

desc

)

SetDefaultBoolController()

CoreExport void SetDefaultBoolController

(

ClassDesc *

desc

)

GetSetKeyMode()

CoreExport BOOL GetSetKeyMode

(

)

SetSetKeyMode()

CoreExport void SetSetKeyMode

(

BOOL

onOff

)

SuspendSetKeyMode()

CoreExport void SuspendSetKeyMode

(

)

ResumeSetKeyMode()

CoreExport void ResumeSetKeyMode

(

)

GetSetKeySuspended()

CoreExport BOOL GetSetKeySuspended

(

)

GetSetKeyModeStatus()

CoreExport BOOL GetSetKeyModeStatus

(

)

IsSetKeyModeFeatureEnabled()

CoreExport BOOL IsSetKeyModeFeatureEnabled

(

)

Variable Documentation

bJointData3

const DWORD bJointData3 = (1 << 0)

tmpStore

CoreExport TempStore tmpStore

extern