r3aniobj

r3aniobj

Class

real/objects/r3aniobj.h

Library

r3obj

Description:

Base class for all anim. objects.

See Also

real/objects/r3level.h

Super Class

r3Level

R3CLID_LEVEL

JavaScript

r3Aniobj

Class Identifier

R3CLID_ANIOBJ - 142

Methods

EVALPARAM, PERFORMONTARGETS, RECALCULATE, SETOPEN, GETOPEN,

Attributes

TimeBegin, TimeEnd, Frequency, Phase, TimeCurrent, InitTimeCurrent, TimeCurve, Weight, TimeBeginAbsolute, TimeEndAbsolute, TimeCurrentAbsolute, Periodic, EnableCurve,

R3AOM_EVALPARAM

Method

EVALPARAM

Identifier

R3AOM_EVALPARAM

Param 3:

R3TAG*, tags: R3LEVA_OrdNum, (R3INT): ordnum of the sub object to be evaluated R3AOA_Result, R3VECTOR *: evaluated point.

JavaScript

obj.EVALPARAM(p3);

Description

Evaluate point from the sub object whose ordnum is given. The point is evaluated using the objects current time.

R3AOM_PERFORMONTARGETS

Method

PERFORMONTARGETS

Identifier

R3AOM_PERFORMONTARGETS

Param 3:

R3TAG*, tags: R3AOA_PMethod - R3INT, method to be called for each target object R3AOA_PParam, - param for the method

JavaScript

obj.PERFORMONTARGETS(p3);

Description

This sends given method to all siblings except for those who are derived from the r3aniobj base class.

R3AOM_RECALCULATE

Method

RECALCULATE

Identifier

R3AOM_RECALCULATE

JavaScript

obj.RECALCULATE();

Description

Called when time or children has changed. When the animation object receives this method, it should update its target objects.

R3AOM_SETOPEN

Method

SETOPEN

Identifier

R3AOM_SETOPEN

Param 3:

R3BOOL, true shows, false hides

JavaScript

obj.SETOPEN(p3);

Description

Show/Hide sub choreographs

R3AOM_GETOPEN

Method

GETOPEN

Identifier

R3AOM_GETOPEN

Return

R3BOOL, true if opened.

JavaScript

rc = obj.GETOPEN();

Description

Find out whether the object is 'opened' or not.

TimeBegin

Attribute

TimeBegin

Identifier

R3AOA_TimeBegin

JavaScript type

Number

C type

R3FLOAT

Description

time when object is activated (in local time space)

Syntax


jsobj.SetTimeBegin(value);
value = jsobj.GetTimeBegin();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_TimeBegin, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_TimeBegin, &value, R3TAG_END);

TimeEnd

Attribute

TimeEnd

Identifier

R3AOA_TimeEnd

JavaScript type

Number

C type

R3FLOAT

Description

time when object stops (in local time space)

Syntax


jsobj.SetTimeEnd(value);
value = jsobj.GetTimeEnd();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_TimeEnd, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_TimeEnd, &value, R3TAG_END);

Frequency

Attribute

Frequency

Identifier

R3AOA_Frequency

JavaScript type

Number

C type

R3FLOAT

Description

speed of object's local time, 1.0 is the same as parent's time

Syntax


jsobj.SetFrequency(value);
value = jsobj.GetFrequency();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_Frequency, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_Frequency, &value, R3TAG_END);

Phase

Attribute

Phase

Identifier

R3AOA_Phase

JavaScript type

Number

C type

R3FLOAT

Description

object's local time is shifted by this much

Syntax


jsobj.SetPhase(value);
value = jsobj.GetPhase();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_Phase, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_Phase, &value, R3TAG_END);

TimeCurrent

Attribute

TimeCurrent

Identifier

R3AOA_TimeCurrent

JavaScript type

Number

C type

R3FLOAT

Description

object's current time in local time space

Syntax


jsobj.SetTimeCurrent(value);
value = jsobj.GetTimeCurrent();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_TimeCurrent, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_TimeCurrent, &value, R3TAG_END);

InitTimeCurrent

Attribute

InitTimeCurrent

Identifier

R3AOA_InitTimeCurrent

JavaScript type

Number

C type

R3FLOAT

Description

object's current time. NOTE: this doesn't cause RECALCULATE method

Syntax


jsobj.SetInitTimeCurrent(value);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_InitTimeCurrent, value, R3TAG_END);

TimeCurve

Attribute

TimeCurve

Identifier

R3AOA_TimeCurve

JavaScript type

Object

C type

R3OBJ*

Description

curve transforming local time, GET only

Syntax


value = jsobj.GetTimeCurve();


R3OBJ* value;
R3GetAttrs(r3obj, R3AOA_TimeCurve, &value, R3TAG_END);

Weight

Attribute

Weight

Identifier

R3AOA_Weight

JavaScript type

Number

C type

R3FLOAT

Description

chor. weight

Syntax


jsobj.SetWeight(value);
value = jsobj.GetWeight();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_Weight, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_Weight, &value, R3TAG_END);

TimeBeginAbsolute

Attribute

TimeBeginAbsolute

Identifier

R3AOA_TimeBeginAbsolute

JavaScript type

Number

C type

R3FLOAT

Description

time when object is activated

Syntax


jsobj.SetTimeBeginAbsolute(value);
value = jsobj.GetTimeBeginAbsolute();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_TimeBeginAbsolute, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_TimeBeginAbsolute, &value, R3TAG_END);

TimeEndAbsolute

Attribute

TimeEndAbsolute

Identifier

R3AOA_TimeEndAbsolute

JavaScript type

Number

C type

R3FLOAT

Description

time when object stops

Syntax


jsobj.SetTimeEndAbsolute(value);
value = jsobj.GetTimeEndAbsolute();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_TimeEndAbsolute, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_TimeEndAbsolute, &value, R3TAG_END);

TimeCurrentAbsolute

Attribute

TimeCurrentAbsolute

Identifier

R3AOA_TimeCurrentAbsolute

JavaScript type

Number

C type

R3FLOAT

Description

object's current time in abs time space

Syntax


jsobj.SetTimeCurrentAbsolute(value);
value = jsobj.GetTimeCurrentAbsolute();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AOA_TimeCurrentAbsolute, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AOA_TimeCurrentAbsolute, &value, R3TAG_END);

Periodic

Attribute

Periodic

Identifier

R3AOA_Periodic

JavaScript type

Boolean

C type

R3BOOL

Description

periodic

Syntax


jsobj.SetPeriodic(value);
value = jsobj.GetPeriodic();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AOA_Periodic, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3AOA_Periodic, &value, R3TAG_END);

EnableCurve

Attribute

EnableCurve

Identifier

R3AOA_EnableCurve

JavaScript type

Boolean

C type

R3BOOL

Description

enable / disable time curve

Syntax


jsobj.SetEnableCurve(value);
value = jsobj.GetEnableCurve();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AOA_EnableCurve, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3AOA_EnableCurve, &value, R3TAG_END);

Tags

Tags

R3AOA_Result
R3AOA_ParamOffset
R3AOA_PMethod
R3AOA_PParam
<sect6> <title>r3choreo</title>

r3choreo

Class

real/objects/r3choreo.h

Library

r3obj

Description:

Choreographer Class

See Also

real/objects/r3aniobj.h

Super Class

r3Aniobj

R3CLID_ANIOBJ

JavaScript

r3Choreographer

Class Identifier

R3CLID_CHOREOGRAPHER - 12

Methods

Attributes

</sect6>
<sect6> <title>r3morph</title>

r3morph

Class

real/objects/r3morph.h

Library

r3obj

Description:

Morphing level.

See Also

real/objects/r3aniobj.h

Super Class

r3Aniobj

R3CLID_ANIOBJ

JavaScript

r3Morphing

Class Identifier

R3CLID_MORPHING - 1498

Methods

EXECUTE, RESETKNOTS, SETKNOT, GETKNOT,

Attributes

Closed, Interpolation, KnotCount, Knots, AbsKnots,

Registration

int R3RegisterMorphingClass(R3APP *app);

R3MORPHINGM_EXECUTE

Method

EXECUTE

Identifier

R3MORPHINGM_EXECUTE

JavaScript

obj.EXECUTE();

Description

Run morphing.

R3MORPHINGM_RESETKNOTS

Method

RESETKNOTS

Identifier

R3MORPHINGM_RESETKNOTS

JavaScript

obj.RESETKNOTS();

Description

Reset knot values to uniform distribution.

R3MORPHINGM_SETKNOT

Method

SETKNOT

Identifier

R3MORPHINGM_SETKNOT

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the knot to be set

Param 3:

R3FLOAT, new time in seconds

JavaScript

rc = obj.SETKNOT(p1, p3);

Description

Set given knot value

R3MORPHINGM_GETKNOT

Method

GETKNOT

Identifier

R3MORPHINGM_GETKNOT

Return

R3BOOL, true if succeeded

Param 1:

R3INT, index of the knot to be set

Param 3:

R3FLOAT, new time in seconds

JavaScript

rc = obj.GETKNOT(p1, p3);

Description

Get given knot value

Closed

Attribute

Closed

Identifier

R3MORPHINGA_Closed

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetClosed(value);
value = jsobj.GetClosed();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3MORPHINGA_Closed, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3MORPHINGA_Closed, &value, R3TAG_END);

Interpolation

Attribute

Interpolation

Identifier

R3MORPHINGA_Interpolation

JavaScript type

Integer

C type

R3INT

Description

interpolation modes below

Syntax


jsobj.SetInterpolation(value);
value = jsobj.GetInterpolation();


R3INT value = ...;
R3SetAttrs(r3obj, R3MORPHINGA_Interpolation, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3MORPHINGA_Interpolation, &value, R3TAG_END);

KnotCount

Attribute

KnotCount

Identifier

R3MORPHINGA_KnotCount

JavaScript type

Integer

C type

R3INT

Description

number of key objects

Syntax


jsobj.SetKnotCount(value);
value = jsobj.GetKnotCount();


R3INT value = ...;
R3SetAttrs(r3obj, R3MORPHINGA_KnotCount, value, R3TAG_END);
R3INT value;
R3GetAttrs(r3obj, R3MORPHINGA_KnotCount, &value, R3TAG_END);

Knots

Attribute

Knots

Identifier

R3MORPHINGA_Knots

JavaScript type

Number

C type

R3FLOAT*

Description

time values corresponding to the sub objects in local timeline space

Syntax


jsobj.SetKnots(value);
value = jsobj.GetKnots();


R3FLOAT* value = ...;
R3SetAttrs(r3obj, R3MORPHINGA_Knots, value, R3TAG_END);
R3FLOAT* value;
R3GetAttrs(r3obj, R3MORPHINGA_Knots, &value, R3TAG_END);

AbsKnots

Attribute

AbsKnots

Identifier

R3MORPHINGA_AbsKnots

JavaScript type

Number

C type

R3FLOAT*

Description

same as above in absolute timing

Syntax


jsobj.SetAbsKnots(value);
value = jsobj.GetAbsKnots();


R3FLOAT* value = ...;
R3SetAttrs(r3obj, R3MORPHINGA_AbsKnots, value, R3TAG_END);
R3FLOAT* value;
R3GetAttrs(r3obj, R3MORPHINGA_AbsKnots, &value, R3TAG_END);

interpolation

R3MORPHIT_CUBIC
R3MORPHIT_LINEAR
R3MORPHIT_DISCRETE

Tags

Tags

R3MORPHINGA_KnotId
</sect6>