formZ SDK | 5.0 API Reference | System | User Interface (FUIM)
Description
Creates a radio button item which represents an entity parameter that can be animated.
The animation item is shown as a small dot behind the radio button, which
pops a menu, when clicked on. The menu items allow the user to control the animation status of the parameter.
See for a full description of the radio button.
Note, that ususally, the anim_flags argument has the FZ_FUIM_ANIM_FLAG_DEFER_BIT bit set.
This causes the radio button to not show an animation item right next to it. The item ids returned
by are stored in an array array, which is then passed
to . Typically a layout is created so that the animation item is positioned
to the right of the group of radio buttons. That means, that the radio buttons are grouped together and
together with the animation item are placed in a horizopntal parent group.
Note, that it is important, that all the radio buttons and
are passed the same track uuid (parm_uuid).
Plugin Prototype
short fz_fuim_new_radio_anim(
fuim_tmpl, | |
short | parent, |
short | id, |
fzrt_int | flags, |
char * | titl_str, |
item_func, | |
void * | item_data, |
fzrt_int | anim_flags, |
fzrt_int | windex, |
item_type, | |
item_tag, | |
parm_uuid ) |
Parameters
fuim_tmpl [Input]
fuim manager
parent [Input]
parent group
id [Input]
item id
flags [Input]
construction flags
Bit Flag Type: fz_fuim_flag_enum
titl_str [Input, Optional]
radio button title
Default Value: a radio button item without a title is created
item_func [Input, Optional]
item function
item_data [Input, Optional]
data to pass to item function
if item_func is NULL, this is ignored
anim_flags [Input]
bit encoded flag, that determine the appearance of the animation item.
Bit Flag Type: The flags are defined by fz_fuim_anim_flags_enum.
windex [Input]
The project, in which the animated entity exists
item_type [Input]
The type of entity that is animated
item_tag [Input]
The tag reference of the animated entity
parm_uuid [Input]
The uuid of the track (entity parameter), which is animated
Returns
radio item id
Availability
6.0.0.2
See Also
Function Set
Defined in