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

fz_fuim_new_slider_edit_pcent_float_anim

Description

Creates a slider item with a text edit field, which show a percentage value. The slider and text edit field are linked to a float value. This value which represents an entity parameter that can be animated. The animation item is shown as a small dot behind the text edit item, 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 precent slider item.

Plugin Prototype

short fz_fuim_new_slider_edit_pcent_float_anim(

fz_fuim_tmpl_ptr

fuim_tmpl,

short

parent,

char *

titl_str,

short

slid_item_id,

short

edit_item_id,

float

min,

float

max,

float

pmin,

float

pmax,

float

field_min,

float

field_max,

fzrt_int

range_flags,

fz_fuim_item_func

item_func,

void *

item_data,

float *

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,

short *

slid_item,

short *

edit_item )

Parameters

fuim_tmpl [Input]

fuim manager

parent [Input]

parent group

titl_str [Input, Optional]

slider title

Default Value: a slider item without a name is created

slid_item_id [Input]

slider item id

edit_item_id [Input]

text edit item id

min [Input]

minimum value of slider (range value)

max [Input]

maximum value of slider (range value)

pmin [Input]

minimum value of slider (display value)

pmax [Input]

maximum value of slider (display value)

field_min [Input]

minimum allowable field value, if the range_flags parameter is passed with FZ_FUIM_RANGE_MIN. This argument must be less or equal to the pmin argument

field_max [Input]

maximum allowable field value, if the range_flags parameter is passed with FZ_FUIM_RANGE_MAX. This argument must be greater or equal to the pmax argument

range_flags [Input]

range flags

Bit Flag Type: fz_fuim_range_enum

item_func [Input, Optional]

item function

item_data [Input, Optional]

data to pass to item function
if item_func is NULL, this is ignored

data [Input]

pointer to the data

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

slid_item [Result, Optional]

slider item id

edit_item [Result, Optional]

text edit item id

Returns

item id of the slider title

Availability

6.0.0.2

See Also

Function Set

fz_fuim_fset


Defined in

fz_fuim_api.h