Skip to content
reduz edited this page Apr 10, 2014 · 10 revisions

Range

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

Brief Description

Abstract base class for range-based controls.

Member Functions

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

  • float get_val ( ) const

Return the current value.

  • float get_min ( ) const

Return the minimum value.

  • float get_max ( ) const

Return the maximum value.

  • float get_step ( ) const

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

  • float get_page ( ) const

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

  • float get_unit_value ( ) const

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

  • void set_min ( float minimum )

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

  • void set_step ( float step )

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

  • void set_page ( float pagesize )

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

  • 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.

Clone this wiki locally