r3animtr

Class

real/layer/r3animtr.h

Library

r3layer

Description:

Animator Class

See Also

oops/r3model.h

Super Class

r3Model

R3CLID_MODEL

JavaScript

r3Animator

Class Identifier

R3CLID_ANIMATOR - 87

Methods

RENDERFRAME, PLAYTOEND, JUMP, STOP, ISPLAYING, ADVANCETIME, NEXTFRAME, PREVFRAME, REWIND, TRANSFORMTIMELINES, PLAY, PLAYTOBEGINNING, JUMPTOEND, private_a, DOSYNC, FRAMETOTIME, TIMETOFRAME,

Attributes

PrimLayer, ModifyLayer, MatLayer, Frames, CurrentFrame, FrameStep, CurrentTime, FieldRendering, MotionBlur, MotionSamples, CurrentField, CurrentSample, FramesPerSecond, CurrentSeconds, PlayLoop, ImageEffectLayer, ParticleEffectLayer, Seconds, AddKeyTolerance, EnableSimulations, AnimMaterials, AnimImageEffects, AnimParticleEffects, RewindObj, RewindMth, RewindData, StartPlayMth, LastFrameInSeconds, PlayRange, RangeFirstFrame, RangeLastFrame, AnimImages, ImageLayer, FieldShiftUp, FieldLaceUp, RangeStartSeconds, RangeEndSeconds, AutoRewind, RealTime, AsyncExecutor, FPS, ExposureFactor,

R3ARM_RENDERFRAME

Method

RENDERFRAME

Identifier

R3ARM_RENDERFRAME

JavaScript

obj.RENDERFRAME();

Description

Render the current frame / field / sample.

R3ARM_PLAYTOEND

Method

PLAYTOEND

Identifier

R3ARM_PLAYTOEND

JavaScript

obj.PLAYTOEND();

Description

Play the animation to the end.

R3ARM_JUMP

Method

JUMP

Identifier

R3ARM_JUMP

JavaScript

obj.JUMP();

Description

Jump to the current target time specified by attributes R3ARA_CurrentFrame, R3ARA_CurrentField, R3ARA_CurrentSample.

R3ARM_STOP

Method

STOP

Identifier

R3ARM_STOP

JavaScript

obj.STOP();

Description

Stop animation.

R3ARM_ISPLAYING

Method

ISPLAYING

Identifier

R3ARM_ISPLAYING

Return

R3INT, 1 if running forward, -1 if running backward, 0 if not running.

JavaScript

rc = obj.ISPLAYING();

Description

Check if animation is running.

R3ARM_ADVANCETIME

Method

ADVANCETIME

Identifier

R3ARM_ADVANCETIME

JavaScript

obj.ADVANCETIME();

Description

Advance time by one frame using the current frame / field / sample resolution.

R3ARM_NEXTFRAME

Method

NEXTFRAME

Identifier

R3ARM_NEXTFRAME

JavaScript

obj.NEXTFRAME();

Description

Step animation forward by one frame.

R3ARM_PREVFRAME

Method

PREVFRAME

Identifier

R3ARM_PREVFRAME

JavaScript

obj.PREVFRAME();

Description

Step animation backwards by one frame.

R3ARM_REWIND

Method

REWIND

Identifier

R3ARM_REWIND

JavaScript

obj.REWIND();

Description

Rewind animation back to the first frame.

R3ARM_TRANSFORMTIMELINES

Method

TRANSFORMTIMELINES

Identifier

R3ARM_TRANSFORMTIMELINES

JavaScript

obj.TRANSFORMTIMELINES();

Description

Rewind animation.

R3ARM_PLAY

Method

PLAY

Identifier

R3ARM_PLAY

JavaScript

obj.PLAY();

Description

Play the animation to current target time using the current frame / field / sample resolution. * The target time is given through attributes R3ARA_CurrentFrame, R3ARA_CurrentField, R3ARA_CurrentSample.

R3ARM_PLAYTOBEGINNING

Method

PLAYTOBEGINNING

Identifier

R3ARM_PLAYTOBEGINNING

JavaScript

obj.PLAYTOBEGINNING();

Description

Play the animation to the beginning of time (reversed play)

R3ARM_JUMPTOEND

Method

JUMPTOEND

Identifier

R3ARM_JUMPTOEND

JavaScript

obj.JUMPTOEND();

Description

Jump animation to the last frame

R3ARM_private_a

Method

private_a

Identifier

R3ARM_private_a

JavaScript

obj.private_a();

Description

Internal method to sync. to real time. Don't call directly.

R3ARM_DOSYNC

Method

DOSYNC

Identifier

R3ARM_DOSYNC

JavaScript

obj.DOSYNC();

Description

Internal, don't call directly

R3ARM_FRAMETOTIME

Method

FRAMETOTIME

Identifier

R3ARM_FRAMETOTIME

Param 1:

R3INT, frame

Param 3:

R3FLOAT, time

JavaScript

obj.FRAMETOTIME(p1, p3);

Description

Convert frame to time (seconds)

R3ARM_TIMETOFRAME

Method

TIMETOFRAME

Identifier

R3ARM_TIMETOFRAME

Param 1:

R3FLOAT, time

Param 3:

R3INT*, frame

JavaScript

obj.TIMETOFRAME(p1, p3);

Description

Convert time to frame

PrimLayer

Attribute

PrimLayer

Identifier

R3ARA_PrimLayer

JavaScript type

Object

C type

R3OBJ*

Description

geometric objects

Syntax

jsobj.SetPrimLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_PrimLayer, value, R3TAG_END);

ModifyLayer

Attribute

ModifyLayer

Identifier

R3ARA_ModifyLayer

JavaScript type

Object

C type

R3OBJ*

Description

modify layer

Syntax

jsobj.SetModifyLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_ModifyLayer, value, R3TAG_END);

MatLayer

Attribute

MatLayer

Identifier

R3ARA_MatLayer

JavaScript type

Object

C type

R3OBJ*

Description

material objects

Syntax

jsobj.SetMatLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_MatLayer, value, R3TAG_END);

Frames

Attribute

Frames

Identifier

R3ARA_Frames

JavaScript type

Integer

C type

R3INT

Description

total number of frames

Syntax

jsobj.SetFrames(value);
value = jsobj.GetFrames();

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

CurrentFrame

Attribute

CurrentFrame

Identifier

R3ARA_CurrentFrame

JavaScript type

Integer

C type

R3INT

Description

current frame 0, ... Frames

Syntax

jsobj.SetCurrentFrame(value);
value = jsobj.GetCurrentFrame();

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

FrameStep

Attribute

FrameStep

Identifier

R3ARA_FrameStep

JavaScript type

Number

C type

R3FLOAT

Description

read only, true interval between subsequent frames

Syntax

jsobj.SetFrameStep(value);
value = jsobj.GetFrameStep();

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

CurrentTime

Attribute

CurrentTime

Identifier

R3ARA_CurrentTime

JavaScript type

Number

C type

R3FLOAT

Description

0 ... 1, current time

Syntax

jsobj.SetCurrentTime(value);
value = jsobj.GetCurrentTime();

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

FieldRendering

Attribute

FieldRendering

Identifier

R3ARA_FieldRendering

JavaScript type

Boolean

C type

R3BOOL

Description

set true for field rendering

Syntax

jsobj.SetFieldRendering(value);
value = jsobj.GetFieldRendering();

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

MotionBlur

Attribute

MotionBlur

Identifier

R3ARA_MotionBlur

JavaScript type

Boolean

C type

R3BOOL

Description

set true for motion blur

Syntax

jsobj.SetMotionBlur(value);
value = jsobj.GetMotionBlur();

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

MotionSamples

Attribute

MotionSamples

Identifier

R3ARA_MotionSamples

JavaScript type

Integer

C type

R3INT

Description

antialiasing depth over time for motion blur

Syntax

jsobj.SetMotionSamples(value);
value = jsobj.GetMotionSamples();

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

CurrentField

Attribute

CurrentField

Identifier

R3ARA_CurrentField

JavaScript type

Integer

C type

R3INT

Description

0 for even, 1 for odd frames, read only

Syntax

jsobj.SetCurrentField(value);
value = jsobj.GetCurrentField();

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

CurrentSample

Attribute

CurrentSample

Identifier

R3ARA_CurrentSample

JavaScript type

Integer

C type

R3INT

Description

current motion blur sample

Syntax

jsobj.SetCurrentSample(value);
value = jsobj.GetCurrentSample();

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

FramesPerSecond

Attribute

FramesPerSecond

Identifier

R3ARA_FramesPerSecond

JavaScript type

Integer

C type

R3INT

Description

frames per second

Syntax

jsobj.SetFramesPerSecond(value);
value = jsobj.GetFramesPerSecond();

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

CurrentSeconds

Attribute

CurrentSeconds

Identifier

R3ARA_CurrentSeconds

JavaScript type

Number

C type

R3FLOAT

Description

current time in seconds

Syntax

jsobj.SetCurrentSeconds(value);
value = jsobj.GetCurrentSeconds();

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

PlayLoop

Attribute

PlayLoop

Identifier

R3ARA_PlayLoop

JavaScript type

Boolean

C type

R3BOOL

Description

true for loop animations

Syntax

jsobj.SetPlayLoop(value);
value = jsobj.GetPlayLoop();

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

ImageEffectLayer

Attribute

ImageEffectLayer

Identifier

R3ARA_ImageEffectLayer

JavaScript type

Object

C type

R3OBJ*

Description

image effects

Syntax

jsobj.SetImageEffectLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_ImageEffectLayer, value, R3TAG_END);

ParticleEffectLayer

Attribute

ParticleEffectLayer

Identifier

R3ARA_ParticleEffectLayer

JavaScript type

Object

C type

R3OBJ*

Description

particle effects

Syntax

jsobj.SetParticleEffectLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_ParticleEffectLayer, value, R3TAG_END);

Seconds

Attribute

Seconds

Identifier

R3ARA_Seconds

JavaScript type

Number

C type

R3FLOAT

Description

length of the animation in seconds (frames / frames_per_second)

Syntax

jsobj.SetSeconds(value);
value = jsobj.GetSeconds();

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

AddKeyTolerance

Attribute

AddKeyTolerance

Identifier

R3ARA_AddKeyTolerance

JavaScript type

Number

C type

R3FLOAT

Description

minimun time resolution

Syntax

value = jsobj.GetAddKeyTolerance();

R3FLOAT value;
R3GetAttrs(r3obj, R3ARA_AddKeyTolerance, &value, R3TAG_END);

EnableSimulations

Attribute

EnableSimulations

Identifier

R3ARA_EnableSimulations

JavaScript type

Boolean

C type

R3BOOL

Description

enable simulations

Syntax

jsobj.SetEnableSimulations(value);
value = jsobj.GetEnableSimulations();

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

AnimMaterials

Attribute

AnimMaterials

Identifier

R3ARA_AnimMaterials

JavaScript type

Boolean

C type

R3BOOL

Description

send time events to material layer

Syntax

jsobj.SetAnimMaterials(value);
value = jsobj.GetAnimMaterials();

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

AnimImageEffects

Attribute

AnimImageEffects

Identifier

R3ARA_AnimImageEffects

JavaScript type

Boolean

C type

R3BOOL

Description

send time events to image effects

Syntax

jsobj.SetAnimImageEffects(value);
value = jsobj.GetAnimImageEffects();

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

AnimParticleEffects

Attribute

AnimParticleEffects

Identifier

R3ARA_AnimParticleEffects

JavaScript type

Boolean

C type

R3BOOL

Description

send time events to particle effects

Syntax

jsobj.SetAnimParticleEffects(value);
value = jsobj.GetAnimParticleEffects();

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

RewindObj

Attribute

RewindObj

Identifier

R3ARA_RewindObj

JavaScript type

Object

C type

R3OBJ*

Description

some 'rewind' operations need special treatment, we can't handle

Syntax

jsobj.SetRewindObj(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_RewindObj, value, R3TAG_END);

RewindMth

Attribute

RewindMth

Identifier

R3ARA_RewindMth

JavaScript type

Integer

C type

R3INT

Description

Syntax

jsobj.SetRewindMth(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3ARA_RewindMth, value, R3TAG_END);

RewindData

Attribute

RewindData

Identifier

R3ARA_RewindData

JavaScript type

String

C type

void*

Description

Syntax

jsobj.SetRewindData(value);

void* value = ...;
R3SetAttrs(r3obj, R3ARA_RewindData, value, R3TAG_END);

StartPlayMth

Attribute

StartPlayMth

Identifier

R3ARA_StartPlayMth

JavaScript type

Integer

C type

R3INT

Description

Syntax

jsobj.SetStartPlayMth(value);

R3INT value = ...;
R3SetAttrs(r3obj, R3ARA_StartPlayMth, value, R3TAG_END);

LastFrameInSeconds

Attribute

LastFrameInSeconds

Identifier

R3ARA_LastFrameInSeconds

JavaScript type

Number

C type

R3FLOAT

Description

Syntax

jsobj.SetLastFrameInSeconds(value);
value = jsobj.GetLastFrameInSeconds();

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

PlayRange

Attribute

PlayRange

Identifier

R3ARA_PlayRange

JavaScript type

Boolean

C type

R3BOOL

Description

set true for playing a range

Syntax

jsobj.SetPlayRange(value);
value = jsobj.GetPlayRange();

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

RangeFirstFrame

Attribute

RangeFirstFrame

Identifier

R3ARA_RangeFirstFrame

JavaScript type

Integer

C type

R3INT

Description

animation range start frame

Syntax

jsobj.SetRangeFirstFrame(value);
value = jsobj.GetRangeFirstFrame();

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

RangeLastFrame

Attribute

RangeLastFrame

Identifier

R3ARA_RangeLastFrame

JavaScript type

Integer

C type

R3INT

Description

animation range, end frame

Syntax

jsobj.SetRangeLastFrame(value);
value = jsobj.GetRangeLastFrame();

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

AnimImages

Attribute

AnimImages

Identifier

R3ARA_AnimImages

JavaScript type

Boolean

C type

R3BOOL

Description

enable/disable image animation

Syntax

jsobj.SetAnimImages(value);
value = jsobj.GetAnimImages();

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

ImageLayer

Attribute

ImageLayer

Identifier

R3ARA_ImageLayer

JavaScript type

Object

C type

R3OBJ*

Description

image objects

Syntax

jsobj.SetImageLayer(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_ImageLayer, value, R3TAG_END);

FieldShiftUp

Attribute

FieldShiftUp

Identifier

R3ARA_FieldShiftUp

JavaScript type

Boolean

C type

R3BOOL

Description

compute latter field above former one

Syntax

jsobj.SetFieldShiftUp(value);
value = jsobj.GetFieldShiftUp();

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

FieldLaceUp

Attribute

FieldLaceUp

Identifier

R3ARA_FieldLaceUp

JavaScript type

Boolean

C type

R3BOOL

Description

interlace latter field above former one

Syntax

jsobj.SetFieldLaceUp(value);
value = jsobj.GetFieldLaceUp();

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

RangeStartSeconds

Attribute

RangeStartSeconds

Identifier

R3ARA_RangeStartSeconds

JavaScript type

Number

C type

R3FLOAT

Description

animation range, in seconds

Syntax

jsobj.SetRangeStartSeconds(value);
value = jsobj.GetRangeStartSeconds();

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

RangeEndSeconds

Attribute

RangeEndSeconds

Identifier

R3ARA_RangeEndSeconds

JavaScript type

Number

C type

R3FLOAT

Description

animation range, in seconds

Syntax

jsobj.SetRangeEndSeconds(value);
value = jsobj.GetRangeEndSeconds();

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

AutoRewind

Attribute

AutoRewind

Identifier

R3ARA_AutoRewind

JavaScript type

Boolean

C type

R3BOOL

Description

enable/disable animation rewind

Syntax

jsobj.SetAutoRewind(value);
value = jsobj.GetAutoRewind();

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

RealTime

Attribute

RealTime

Identifier

R3ARA_RealTime

JavaScript type

Boolean

C type

R3BOOL

Description

real time play back, delays or skips frames to sync to real time

Syntax

jsobj.SetRealTime(value);
value = jsobj.GetRealTime();

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

AsyncExecutor

Attribute

AsyncExecutor

Identifier

R3ARA_AsyncExecutor

JavaScript type

Object

C type

R3OBJ*

Description

async executor

Syntax

jsobj.SetAsyncExecutor(value);

R3OBJ* value = ...;
R3SetAttrs(r3obj, R3ARA_AsyncExecutor, value, R3TAG_END);

FPS

Attribute

FPS

Identifier

R3ARA_FPS

JavaScript type

Number

C type

R3FLOAT

Description

frames per second

Syntax

jsobj.SetFPS(value);
value = jsobj.GetFPS();

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

ExposureFactor

Attribute

ExposureFactor

Identifier

R3ARA_ExposureFactor

JavaScript type

Number

C type

R3FLOAT

Description

0 < relative exposure time < 1.0

Syntax

jsobj.SetExposureFactor(value);
value = jsobj.GetExposureFactor();

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