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

# fz_anim_node_trac_is_compatible

Description

This function returns whether the given track type is compatible for a given animation node. The animation node may be an entity, track, or controller node.
If a track type is compatible with an animation node, a track of this type can be added to the node and is supported by the node.
Sometimes two different tracks may be supported by the same entity, but not compatible at the same time. For example, a view entity supports FZ_TRAC_TYPE_POS_X and FZ_TRAC_TYPE_EYE_X, however, cannot have both applied at the same time, since they both animate the same data, the view's eye position. They are used in different circumstances. The FZ_TRAC_TYPE_POS_X also controls the view's COI point, whereas the FZ_TRAC_TYPE_EYE_X controls only its eye point.
The trac_id identifies the type of track node that is to be added as a child to the given anim_node. Some track types are defined already (for example, FZ_TRAC_TYPE_POS_X).

Plugin Prototype

fzrt_error_td fz_anim_node_trac_is_compatible(

fzrt_int | windex,
fz_anim_node_ptr | anim_node,
fzrt_UUID_td | trac_id,
fzrt_boolean * | is_compatible )

Parameters

windex [Input]

project window index

anim_node [Input]

animation node (entity, track, or controller node)

trac_id [Input]

the track type to test for compatibility

is_compatible [Result]

whether or not the given track type is compatible with the given anim node.

Returns

Error codes

Availability

6.1.0.0

Example Files

util_anim_cntl.fsl

Function Set

fz_anim_fset

Defined in

fz_anim_api.h