Synopsis
Creates and plays back keyframe animations.
v File
v/anim_m.v
Input Ports
|
None |
|
Parameters
The following table lists the animator module's public parameters which are stored in the animParam subobject. They carry settings and flags used by other objects in the macro. They can be set by UI controls defined in the animUI subobject. See the description below for more details.
|
Name
|
Type
|
Description
|
UI Control
|
|
reset |
int |
Sets playback to the first frame. |
Go To Start UIbutton in PlaybackControls |
|
reset back |
int |
Sets playback to the last frame. |
Go To End UIbutton control in animUI.PlaybackControls |
|
run |
int |
Displays the current sequence of frames forwards, according to run options mode. |
Run and Stop UIbutton controls in animUI.PlaybackControls |
|
run back |
int |
Displays the currrent sequence of frames backwards according to run options the mode. |
Run Backwards and Stop UIbutton controls in animUI.PlaybackControls. |
|
step |
int |
Advances playback to the next frame. |
StepForward UIbutton control in animUI.PlaybackControls. |
|
step back |
int |
Sets playback to the previous frame. |
StepBack UIbutton control in animUI.PlaybackControls. |
|
run options |
int |
Specifies mode for running the animation:
|
RunOptions UIoptionMenu control in animUI.PlaybackControls |
|
add frame |
int |
Records the current view as the next keyframe at current time plus frame delta. |
Add UIbutton control in animUI.KeyframeControls |
|
delete frame |
int |
Deletes the currently selected keyframe. |
Delete UIbutton control in animUI.KeyframeControls |
|
clear frames |
int |
Clear UIbutton control in animUI.KeyframeControls | |
|
complete frames |
int |
Adds a copy of the first frame to the end of the animation sequence. |
Complete UIbutton control in animUI.KeyframeControls |
|
move frame |
int |
Assigns the current value of New Time to the current frame. |
Move UIbutton control in animUI.KeyframeControls |
|
frames per second |
int |
Specifies the number of interpolated frames created for each second of time in the animation. |
Frames Per Second UIfield control in animUI.PlaybackControls. |
|
frame delta |
float |
Specifies the amount of time, in seconds, added to the current time to create the new time at which new keyframes are added. |
Frame Delta UIfield control in animUI.KeyframeControls |
|
current time |
float |
Specifies the time of the keyframe selected in the Frame Times list. |
current time is set by selecting a keyframe from the Frame Times list, or by the Current Time VUIdial control in animUI.KeyframeControls. |
|
new time |
float |
Specifies the new time to assign to the selected keyframe when the Move button is pushed. |
New Time UIfield control in animUI.KeyframeControls |
Output Ports
|
None |
Subobjects
The following table lists the immediate subobjects of animator.
|
Name
|
Type
|
Description
|
|
animParam |
group |
Collects the public parameters used by animator. |
|
animCompute |
macro |
Encapsulates the processing done by the animator to create the animation sequence. |
|
animUI |
macro |
Encapsulates the user interface controls displayed in the default UImodpanel. |
|
UImod panel |
group |
Represents the default UI panel. |
|
instancer |
module |
A module |
Description
The animator macro records and plays back a series of images recorded from an AVS/Express view.
Parameters
reset
int When reset is set to a non-zero value, the amimator playback is set to the first frame of the current animated sequence, and the value of reset returns to 0.
The reset parameter is set by the the Go To Start UIbutton control in animUI.PlaybackControls.
reset back
int When reset back is set to a non-zero value, the amimator playback is set to the last frame of the animated sequence. and the value of reset back returns to 0.
The reset back parameter is set by the the Go To End UIbutton control in animUI.PlaybackControls.
run
int While run is set to a non-zero value, animator displays the current sequence of frames from first to last, according to the value of the run options parameter. When the animated sequence is complete, run is automatically reset to 0
The run parameter is set to 1 by the Run UIbutton control, and to 0 by the Stop UIbutton control.
run back
int While run back is set to a non-zero value, animator displays the currrent sequence of frames backwards, from last to first, according to the mode set in the run options parameter. When the animated sequence is complete, run back is automatically reset to 0.
The run back parameter is set to 1 by the Run Backwards UIbutton control, and to 0 by the Stop control.
step
int When step is set to a non-zero value, the current frame is advanced to the next frame forwards in the animation sequence. When the new frame is set, step is automatically reset to 0.
The step parameter is set by the StepForward UIbutton control in animUI.PlaybackControls.
step back
int When step back is set to a non-zero value, the current frame is set to the previous frame in the animation sequence. When the new frame is set, step back is automatically reset to 0.
The step parameter is set by the StepBack UIbutton control in animUI.PlaybackControls.
run options
int The run options parameter specifies one of three modes for running the animation:
· 0 = Once
· 1 = Cycle
· 2 = Bounce
The run options parameter is set by the RunOptions UIoptionMenu control in animUI.PlaybackControls
add frame
int When add-frame is set, the animator records the current view as the next keyframe. The new keyframe is assigned the current time plus the value of the frame delta parameter. The new time must not already be assigned to a keyframe.
The add frame parameter is set by the Add UIbutton control in animUI.KeyframeControls.
delete frame
int When delete frame is set, the animator deletes the currently selected keyframe.
The delete frame parameter is set by the Delete UIbutton control in animUI.KeyframeControls.
clear frames
int When clears frames is set, the animator deletes all currently recorded frames.
The clear frames parameter is set by the Clear UIbutton control in animUI.KeyframeControls.
complete frames
int When the complete frames parameter is set, animator adds a copy of the first frame to the end of the animation sequence. This ensures that the view returns to the state of the first frame at the end of the animation.
The complete frame parameter is set by the Complete UIbutton control in animUI.KeyframeControls.
move frame
int When the move frame parameter is set, animator assigns the current value of New Time to the current frame. The new Time must not be a currently defined time in the animation sequence.
The move frame parameter is set by the Move UIbutton control in animUI.KeyframeControls.
frames per second
int Specifies the number of interpolated frames that are created for each second of time in the animation. The interpolated frames are created between the keyframes defined for the animation.
The frames per second parameter is set by the Frames Per Second UIfield control in animUI.PlaybackControls.
frame delta
float Specifies the amount of time, in seconds, added to the current time to create the new time at which new frames are added.
The frame delta parameter is set by the Frame Delta UIfield control in animUI.KeyframeControls.
current time
float Specifies the time of the keyframe selected in the Current Frame Times list. When current times is set to a new time, the animation display is updated to reflect the new time. However, when the the animation is run, current time is not updated and does not interact with the Playback Controls..
The current time is set by selecting a keyframe from the Current Frame Time list, or by the Current Time VUIdial control in animUI.KeyframeControls.
new time
float Specifies the new time to assign to the selected keyframe when the Move button is pushed.
The new time parameter is set by the New Time UIfield control in animUI.KeyframeControls.
Example
See also