formZ SDK | 5.0 API Reference | System | User Interface (FUIM)

fz_fuim_new_check_anim

Description

Creates a check box item which represents an entity parameter that can be animated. The animation item is shown as a small dot behind the check box field, which pops a menu, when clicked on. The menu items allow the user to control the animation status of the parameter. See fz_fuim_new_check for a full description of the check box item.

Plugin Prototype

short fz_fuim_new_check_anim(

fz_fuim_tmpl_ptr

fuim_tmpl,

short

parent,

short

id,

fzrt_int

flags,

char *

titl_str,

fz_fuim_item_func

item_func,

void *

item_data,

fzrt_int

anim_flags,

fzrt_int

windex,

fz_fuim_anim_item_type_enum

item_type,

fz_tag_td *

item_tag,

fzrt_UUID_td

parm_uuid )

Parameters

fuim_tmpl [Input]

fuim manager

parent [Input]

parent group

id [Input]

checkbox item id

flags [Input]

construction flags

Bit Flag Type: fz_fuim_flag_enum

titl_str [Input, Optional]

checkbox title

Default Value: a checkbox 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

check box item id

Availability

6.0.0.2

See Also

fz_fuim_new_check

Function Set

fz_fuim_fset


Defined in

fz_fuim_api.h