formZ SDK | 5.0 API Reference | Project | Modeling | Animation

# fz_anim_opts_parm_enum

Description

Identifiers for the general animation options. Each project has its own set of options.

enum fz_anim_opts_parm_enum {

FZ_ANIM_PARM_CRNT_TIME,

FZ_ANIM_PARM_CRNT_FRAME,

FZ_ANIM_PARM_START_TIME,

FZ_ANIM_PARM_END_TIME,

FZ_ANIM_PARM_FPS,

FZ_ANIM_PARM_LOOP_CONTROL,

FZ_ANIM_PARM_SKIP,

FZ_ANIM_PARM_PB_START_TIME,

FZ_ANIM_PARM_PB_END_TIME,

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_KEYF,

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_AT_INTV,

FZ_ANIM_PARM_ENTY_PVIEW_AT_INTV,

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_BEFORE,

FZ_ANIM_PARM_ENTY_PVIEW_BEFORE_NUM,

FZ_ANIM_PARM_ENTY_PVIEW_BEFORE_INTV,

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_AFTER,

FZ_ANIM_PARM_ENTY_PVIEW_AFTER_NUM,

FZ_ANIM_PARM_ENTY_PVIEW_AFTER_INTV,

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_TRAIL,

FZ_ANIM_PARM_USE_CNTL_CACHE };

Members

FZ_ANIM_PARM_CRNT_TIME

Current (active) time (in seconds) of the animation

Type: double

Default Value: 0.0

Range: animation start time <= value < animation end time

FZ_ANIM_PARM_CRNT_FRAME

Current (active) frame of the animation

Type: fzrt_int

Default Value: 0

Range: animation start frame <= value <= animation end frame

FZ_ANIM_PARM_START_TIME

Animation start time

Type: double

Default Value: 0.0

Range: value < animation end time

FZ_ANIM_PARM_END_TIME

Animation end time

Type: double

Default Value: 10.0

Range: value > animation start time

FZ_ANIM_PARM_FPS

Animation frames per second

Type: double

Default Value: 30.0

Range: value > 0.0

FZ_ANIM_PARM_LOOP_CONTROL

Playback loop control

Type: fz_anim_play_loop_enum

Default Value: FZ_ANIM_PLAY_LOOP_CONT

FZ_ANIM_PARM_SKIP

Enable frame skipping to keep playback in real time. If FALSE, no frames will be skipped.

Type: fzrt_boolean

Default Value: TRUE

FZ_ANIM_PARM_PB_START_TIME

Animation playback start time

Type: double

Default Value: 0.0

Range: value < animation end time

FZ_ANIM_PARM_PB_END_TIME

Animation playback end time

Type: double

Default Value: 10.0

Range: value > animation start time

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_KEYF

Show animated entities at their keyframe locations.

Type: fzrt_boolean

Default Value: TRUE

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_AT_INTV

Show animated entities at every specified interval.

Type: fzrt_boolean

Default Value: FALSE

FZ_ANIM_PARM_ENTY_PVIEW_AT_INTV

Sampling interval at which to show animated entities.

Type: double

Default Value: 1 (sec)

Range: value > 0

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_BEFORE

Whether or not to show specified number of animated entities at specified interval before the current frame.

Type: fzrt_boolean

Default Value: FALSE

FZ_ANIM_PARM_ENTY_PVIEW_BEFORE_NUM

Number of animated entities before the current frame.

Type: fzrt_int

Default Value: 4

FZ_ANIM_PARM_ENTY_PVIEW_BEFORE_INTV

Sampling interval at which to show animated entities before the current frame.

Type: double

Default Value: 0.25 (sec)

Range: value > 0

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_AFTER

Whether or not to show specified number of animated entities at specified interval after the current frame.

Type: fzrt_boolean

Default Value: FALSE

FZ_ANIM_PARM_ENTY_PVIEW_AFTER_NUM

Number of animated entities after the current frame.

Type: fzrt_int

Default Value: 4

FZ_ANIM_PARM_ENTY_PVIEW_AFTER_INTV

Sampling interval at which to show animated entities after the current frame.

Type: double

Default Value: 0.25 (sec)

Range: value > 0

FZ_ANIM_PARM_ENTY_PVIEW_SHOW_TRAIL

Whether or not to show the trail of animated entities.

Type: fzrt_boolean

Default Value: TRUE

FZ_ANIM_PARM_USE_CNTL_CACHE

Whether or not to use the controller cache.

Type: fzrt_boolean

Default Value: TRUE

Availability

6.1.0.0

See Also

Defined in

fz_anim_api.h