ValueIncrement

Description

struct Tinman.AddOns.Editors.ValueIncrement

Full source code is included in the Tinman 3D SDK download.

Settings for incrementing a GUI value.

The following methods may be used as ValueIncrementDelegate for various Component types:

Public / Constants

Zero

public static readonly attribute Zero → (ValueIncrement)

Increment settings that never change the GUI value.

Public / Constructors

Value​Increment

public constructor ValueIncrement → (3)

step in : float64

[>=0]
The increment value.

frequency in : int32

[>=0]
Frequency of increments, in Hertz.

delay in : int32

[>=0]
Delay before first increment, in milli-seconds.

Creates a new instance of ValueIncrement.

Public / Methods

Update​Input​Field​Integer

public static method UpdateInputFieldInteger → (3)

component in : InputFieldInteger

The GUI component that holds the value.

scale in : float64

The scale factor.

offset in : float64

The offset value.

A ValueIncrementDelegate that modifies the value of an InputFieldInteger field.

The modified value is round with Maths.Round before being set to the given component in.

Update​Input​Field​Lat​Lon_​Latitude

public static method UpdateInputFieldLatLon_Latitude → (3)

component in : InputFieldLatLon

The GUI component that holds the value.

scale in : float64

The scale factor.

offset in : float64

The offset value.

A ValueIncrementDelegate that modifies the LatLon.Latitude part of the value of an InputFieldLatLon field.

Update​Input​Field​Lat​Lon_​Longitude

public static method UpdateInputFieldLatLon_Longitude → (3)

component in : InputFieldLatLon

The GUI component that holds the value.

scale in : float64

The scale factor.

offset in : float64

The offset value.

A ValueIncrementDelegate that modifies the LatLon.Longitude part of the value of an InputFieldLatLon field.

Update​Input​Field​Number

public static method UpdateInputFieldNumber → (3)

component in : InputFieldNumber

The GUI component that holds the value.

scale in : float64

The scale factor.

offset in : float64

The offset value.

A ValueIncrementDelegate that modifies the value of an InputFieldNumber field.

Public / Attributes

Delay

public readonly attribute Delay → (int32)

Delay before first increment, in milli-seconds.

Frequency

public readonly attribute Frequency → (int32)

Frequency of increments, in Hertz.

Is​Zero

public attribute IsZero → (get)

value : bool

true if this is Zero, false if not.

Do these increment settings never change the GUI value?

Step

public readonly attribute Step → (float64)

The step value.