Range

####Inherits: Control ####Category: Core

Brief Description

Abstract base class for range-based controls.

Member Functions

• float get_val ( ) const
• float get_value ( ) const
• float get_min ( ) const
• float get_max ( ) const
• float get_step ( ) const
• float get_page ( ) const
• float get_unit_value ( ) const
• bool get_rounded_values ( ) const
• void set_val ( float value )
• void set_value ( float value )
• void set_min ( float minimum )
• void set_max ( float maximum )
• void set_step ( float step )
• void set_page ( float pagesize )
• void set_unit_value ( float value )
• void set_rounded_values ( bool arg0 )
• void set_exp_unit_value ( bool enabled )
• bool is_unit_value_exp ( ) const
• void share ( Object with )
• void unshare ( )

Signals

• value_changed ( float value )
• changed ( )

Description

Range is a base class for Control nodes that change a floating point value between a need a minimum, maximum, using step and page, for example a ScrollBar.

Member Function Description

get_val

• float get_val ( ) const

Return the current value.

get_min

• float get_min ( ) const

Return the minimum value.

get_max

• float get_max ( ) const

Return the maximum value.

get_step

• float get_step ( ) const

Return the stepping, if step is 0, stepping is disabled.

get_page

• float get_page ( ) const

Return the page size, if page is 0, paging is disabled.

get_unit_value

• float get_unit_value ( ) const

Return value mapped to 0 to 1 (unit) range.

set_min

• void set_min ( float minimum )

Set minimum value, clamped range value to it if it"apos;s less.

set_step

• void set_step ( float step )

Set step value. If step is 0, stepping will be disabled.

set_page

• void set_page ( float pagesize )

Set page size. Page is mainly used for scrollbars or anything that controls text scrolling.

set_unit_value

• void set_unit_value ( float value )

Set value mapped to 0 to 1 (unit) range, it will then be converted to the actual value within min and max.