formZ SDK | 5.0 API Reference | Project | Modeling | Animation
Description
Identifiers for animate along path options. Certain options apply only to certain path types. For example, banking can only apply if the path object is itself a smooth curve. Alignment does not apply if the path object is not a curve.
enum fz_anim_path_opts_enum {
FZ_ANIM_PATH_OPTS_ALIGN,
FZ_ANIM_PATH_OPTS_ALIGN_TANG_AXIS,
FZ_ANIM_PATH_OPTS_ALIGN_SEC_AXIS,
FZ_ANIM_PATH_OPTS_ALIGN_UP_AXIS,
FZ_ANIM_PATH_OPTS_ALIGN_ON_TOP,
FZ_ANIM_PATH_OPTS_ALIGN_BANK,
FZ_ANIM_PATH_OPTS_SINGLE,
FZ_ANIM_PATH_OPTS_MULTI,
FZ_ANIM_PATH_OPTS_START_TIME,
FZ_ANIM_PATH_OPTS_END_TIME,
FZ_ANIM_PATH_OPTS_FOLLOW,
FZ_ANIM_PATH_OPTS_PART_KIND,
FZ_ANIM_PATH_OPTS_PART_INDX,
FZ_ANIM_PATH_OPTS_OBJ };
Members
FZ_ANIM_PATH_OPTS_ALIGN
Whether or not to align entity along the path
Type: fzrt_boolean
Default Value: TRUE
FZ_ANIM_PATH_OPTS_ALIGN_TANG_AXIS
Axis of entity that is to be tangent to path direction. (Only two axes need to be specified).
Type: fz_anim_axis_enum
Default Value: FZ_ANIM_AXIS_X_POS
FZ_ANIM_PATH_OPTS_ALIGN_SEC_AXIS
Axis of entity that is to be aligned leftward. (Only two axes need to be specified).
Type: fz_anim_axis_enum
Default Value: FZ_ANIM_AXIS_Y_POS
FZ_ANIM_PATH_OPTS_ALIGN_UP_AXIS
Axis of entity that is to be aligned upward. (Only two axes need to be specified).
Type: fz_anim_axis_enum
Default Value: FZ_ANIM_AXIS_Z_POS
FZ_ANIM_PATH_OPTS_ALIGN_ON_TOP
If TRUE, the entity's up direction tries to stay upward in relation to the path object's coordinate system's up direction. If FALSE, the entity's up direction tries to stay towards the curvature vector's direction at each point along the path object. This only applies to path objects that have curvature (smooth splines).
Type: fzrt_boolean
Default Value: TRUE
FZ_ANIM_PATH_OPTS_ALIGN_BANK
Whether or not to add a Bank track to the path track by default.
This only applies to path objects that have curvature (smooth splines).
Construction only.
Type: fzrt_boolean
Default Value: FALSE
FZ_ANIM_PATH_OPTS_SINGLE
If not aligned, whether or not to create a single path track,
or three separate path tracks (one for each direction).
Construction only.
Type: fzrt_boolean
Default Value: TRUE
FZ_ANIM_PATH_OPTS_MULTI
If FZ_ANIM_PATH_OPTS_SINGLE is FALSE, these flags determine which separate path
tracks to use, in x, y, and/or z.
Construction only.
Type: fzrt_int (see fz_anim_path_multi_enum, fz_anim_path_multi_bits_enum)
Default Value: FZ_ANIM_PATH_SEPARATE_X | FZ_ANIM_PATH_SEPARATE_Y| FZ_ANIM_PATH_SEPARATE_Z
FZ_ANIM_PATH_OPTS_START_TIME
When in time entity is at the beginning of the path. To edit the
keyframes after the path has been created, see the Bezier keyframe functions.
Construction only.
Type: double
Default Value: Animation Start Time
FZ_ANIM_PATH_OPTS_END_TIME
When in time entity is at the end of the path. To edit the
keyframes after the path has been created, see the Bezier keyframe functions.
Construction only.
Type: double
Default Value: Animation End Time
FZ_ANIM_PATH_OPTS_FOLLOW
How the entity follows the path.
Construction only.
Type: fz_anim_path_follower_enum
Default Value: FZ_ANIM_PATH_FOLLOWER_POS
FZ_ANIM_PATH_OPTS_PART_KIND
For object entities with parts along a path ( FZ_ANIM_PATH_FOLLOWER_PART), this
parameter identifies what kind of part to animate along the path.
Construction only.
Type: fz_anim_objt_part_enum
Default Value: FZ_ANIM_OBJT_PART_PNT
Range: FZ_ANIM_OBJT_PART_PNT <= value <= FZ_ANIM_OBJT_PART_OBJT
FZ_ANIM_PATH_OPTS_PART_INDX
For object entities with parts along a path ( FZ_ANIM_PATH_FOLLOWER_PART), this
parameter identifies the index of the part to animate along the path.
Construction only.
Type: fzrt_int
Default Value: 0
FZ_ANIM_PATH_OPTS_OBJ
The object that the path track references so that the entity follows. Once a path track has been created, the path object can be changed through this parameter. Certain path options may change, because not all objects support all path options.
Type: fz_objt_ptr
Availability
6.1.0.0
See Also
fz_anim_path_opts_ptr, fz_anim_path_opts_get_parm, , fz_anim_trac_path_get_parm, fz_anim_trac_path_set_parm
Defined in