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

Range

Inherits: Control\n\n### Brief Description
Abstract base class for range-based controls.

Member Functions

Signals

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 ==

  • real get_val" ( ) const \ Return the current value. == get_min ==
  • real get_min" ( ) const \ Return the minimum value. == get_max ==
  • real get_max" ( ) const \ Return the maximum value. == get_step ==
  • real get_step" ( ) const \ Return the stepping, if step is 0, stepping is disabled. == get_page ==
  • real get_page" ( ) const \ Return the page size, if page is 0, paging is disabled. == get_unit_value ==
  • real get_unit_value" ( ) const \ Return value mapped to 0 to 1 (unit) range. == set_min ==
  • void set_min" ( real minimum ) \ Set minimum value, clamped range value to it if it"apos;s less. == set_step ==
  • void set_step" ( real step ) \ Set step value. If step is 0, stepping will be disabled. == set_page ==
  • void set_page" ( real pagesize ) \ Set page size. Page is mainly used for scrollbars or anything that controls text scrolling. == set_unit_value ==
  • 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