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

fz_fuim_new_icon_anim_obsolete

Description

Creates an icon item which represents an entity parameter that can be animated. The animation item is shown as a small dot behind the icon, 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_icon for a full description of the icon item.
If several icons are used to represent the state of a single pararameter, they must be set up like radio buttons. See for more details.

Plugin Prototype

short fz_fuim_new_icon_anim_obsolete(

fz_fuim_tmpl_ptr

fuim_tmpl,

short

parent,

short

id,

fzrt_int

flags,

fzrt_floc_ptr

floc,

fzrt_int

hpos,

fzrt_int

vpos,

fzrt_floc_ptr

floc_mask,

fzrt_int

hpos_mask,

fzrt_int

vpos_mask,

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]

icon item id

flags [Input]

construction flags

Bit Flag Type: fz_fuim_flag_enum

floc [Input]

file location of file which contains the icon.

hpos [Input]

left horizontal location of icon data in file.

vpos [Input]

top vertical location of icon data in file.

floc_mask [Input, Optional]

file location of file which contains the icon mask data.

hpos_mask [Input, Optional]

left horizontal location of icon mask data in file.

vpos_mask [Input, Optional]

top vertical location of icon mask data in file.

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

icon item id

Availability

6.0.0.2

See Also

, fz_fuim_new_icon

Function Set

fz_fuim_fset


Defined in

fz_fuim_api.h