Lysa.ui  0.0
Lysa 3D Engine
Knob Class Referenceabstract

Detailed Description

A value selected by rotating a disc, with a cursor drawn inside the disc. Fires OnValueChange.

Inherits from: ValueSelect

Lua full name: lysa.ui.Knob

Public Member Functions

nil set_cursor_extent (start: number, stop: number)
 Sets the start and the end of the inner cursor, as ratios of the radius. More...
 
number angle_of (value: number)
 Returns the angle in radians the cursor points at for a value. More...
 
lysa.float2 point_at (angle: number, distance: number)
 Returns the point at an angle in radians and a distance from the center. More...
 
number value_of_tick (index: integer)
 Returns the value of the graduation at index in [0, divisions]. More...
 
string label_of_tick (index: integer)
 Returns the label of the graduation at index in [0, divisions]. More...
 

Properties

number start_angle
 Angle of the minimum value, in degrees counterclockwise from the horizontal axis.
 
number sweep_angle
 Angle swept clockwise from the minimum to the maximum value, in degrees.
 
integer divisions
 Number of intervals between the graduations drawn around the disc.
 
boolean ticks_visible
 True when the graduations are drawn around the disc.
 
boolean labels_visible
 True when the value of each graduation is drawn around the disc.
 
integer precision
 Number of decimals of the labels, zero for integer values.
 
number tick_length
 Length in virtual screen units of the graduations.
 
number tick_width
 Thickness in virtual screen units of the graduations.
 
number tick_gap
 Space in virtual screen units between the disc and the graduations.
 
number label_gap
 Space in virtual screen units between the graduations and the labels.
 
number cursor_width
 Thickness in virtual screen units of the cursor drawn inside the disc.
 
number cursor_start
 Distance between the center and the start of the cursor, as a ratio of the radius. (read-only)
 
number cursor_end
 Distance between the center and the end of the cursor, as a ratio of the radius. (read-only)
 
lysa.float2 center
 Center of the disc in widget coordinates. (read-only)
 
number radius
 Radius of the disc in virtual screen units, reduced to keep the graduations and the labels inside the widget. (read-only)
 
number ticks_radius
 Distance between the center and the start of the graduations. (read-only)
 
number labels_radius
 Distance between the center and the center of the labels. (read-only)
 
number label_height
 Height of a label in virtual screen units, zero when the labels are hidden. (read-only)
 
number max_label_width
 Width of the widest label in virtual screen units, zero when the labels are hidden. (read-only)
 

Member Function Documentation

nil set_cursor_extent ( number  start,
number  stop)

Sets the start and the end of the inner cursor, as ratios of the radius.

Parameters
startnumber
stopnumber
number angle_of ( number  value)

Returns the angle in radians the cursor points at for a value.

Parameters
valuenumber
Returns
number
lysa.float2 point_at ( number  angle,
number  distance)

Returns the point at an angle in radians and a distance from the center.

Parameters
anglenumber
distancenumber
Returns
lysa.float2
number value_of_tick ( integer  index)

Returns the value of the graduation at index in [0, divisions].

Parameters
indexinteger
Returns
number
string label_of_tick ( integer  index)

Returns the label of the graduation at index in [0, divisions].

Parameters
indexinteger
Returns
string

Property Documentation

number start_angle

Angle of the minimum value, in degrees counterclockwise from the horizontal axis.

number sweep_angle

Angle swept clockwise from the minimum to the maximum value, in degrees.

integer divisions

Number of intervals between the graduations drawn around the disc.

boolean ticks_visible

True when the graduations are drawn around the disc.

boolean labels_visible

True when the value of each graduation is drawn around the disc.

integer precision

Number of decimals of the labels, zero for integer values.

number tick_length

Length in virtual screen units of the graduations.

number tick_width

Thickness in virtual screen units of the graduations.

number tick_gap

Space in virtual screen units between the disc and the graduations.

number label_gap

Space in virtual screen units between the graduations and the labels.

number cursor_width

Thickness in virtual screen units of the cursor drawn inside the disc.

number cursor_start

Distance between the center and the start of the cursor, as a ratio of the radius. (read-only)

number cursor_end

Distance between the center and the end of the cursor, as a ratio of the radius. (read-only)

lysa.float2 center

Center of the disc in widget coordinates. (read-only)

number radius

Radius of the disc in virtual screen units, reduced to keep the graduations and the labels inside the widget. (read-only)

number ticks_radius

Distance between the center and the start of the graduations. (read-only)

number labels_radius

Distance between the center and the center of the labels. (read-only)

number label_height

Height of a label in virtual screen units, zero when the labels are hidden. (read-only)

number max_label_width

Width of the widest label in virtual screen units, zero when the labels are hidden. (read-only)