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

Range

#####Inherits: Control

Brief Description

Abstract base class for range-based controls.

Member Functions

Signals

  • value_changed ( real 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

  • real get_val ( ) const

Return the current value.

  • real get_min ( ) const

Return the minimum value.

  • real get_max ( ) const

Return the maximum value.

  • real get_step ( ) const

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

  • real get_page ( ) const

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

  • real get_unit_value ( ) const

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

  • void set_min ( real minimum )

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

  • void set_step ( real step )

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

  • void set_page ( real pagesize )

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

  • void set_unit_value ( real 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