r3axis

r3axis

Class

real/gadget/r3axis.h

Library

r3gad

Description:

Axis gadget.

See Also

oops/r3window.h

Super Class

r3Window

R3CLID_WINDOW

JavaScript

r3Axis

Class Identifier

R3CLID_AXIS - 40

Methods

GETCURRENTADJNOTCHPO, DRAWCURRENTADJNOTCH, HITCURRENTADJNOTCH,

Attributes

Side, Min, Max, Visible, Offset, StartMargin, EndMargin, Marks, MinAdjustable, MaxAdjustable, CurrentAdjustable, Value, StepValue, UnitConverter, UnitType, ValueOffset, RangeMinAdjustable, RangeMaxAdjustable, RangeMin, RangeMax, Animator, NoDirectKnobUpdate, CurrentVisible,

super

R3AXISM_GETCURRENTADJNOTCHPO

Method

GETCURRENTADJNOTCHPO

Identifier

R3AXISM_GETCURRENTADJNOTCHPO

Return

R3INT, side code

Param 3:

R3INT*, current window coordinate

JavaScript

rc = obj.GETCURRENTADJNOTCHPO(p3);

Description

Fetch the current notch position in window space.

R3AXISM_DRAWCURRENTADJNOTCH

Method

DRAWCURRENTADJNOTCH

Identifier

R3AXISM_DRAWCURRENTADJNOTCH

JavaScript

obj.DRAWCURRENTADJNOTCH();

Description

Draw current adjustable notch.

R3AXISM_HITCURRENTADJNOTCH

Method

HITCURRENTADJNOTCH

Identifier

R3AXISM_HITCURRENTADJNOTCH

Return

R3INT, see hit codes below

JavaScript

rc = obj.HITCURRENTADJNOTCH();

Description

Hit current adjustable notch.

Side

Attribute

Side

Identifier

R3AXISA_Side

JavaScript type

Integer

C type

R3INT

Description

see side codes below

Syntax


jsobj.SetSide(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3AXISA_Side, value, R3TAG_END);

Min

Attribute

Min

Identifier

R3AXISA_Min

JavaScript type

Number

C type

R3FLOAT

Description

min value

Syntax


jsobj.SetMin(value);
value = jsobj.GetMin();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_Min, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AXISA_Min, &value, R3TAG_END);

Max

Attribute

Max

Identifier

R3AXISA_Max

JavaScript type

Number

C type

R3FLOAT

Description

max value

Syntax


jsobj.SetMax(value);
value = jsobj.GetMax();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_Max, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AXISA_Max, &value, R3TAG_END);

Visible

Attribute

Visible

Identifier

R3AXISA_Visible

JavaScript type

Integer

C type

R3INT

Description

visible

Syntax


jsobj.SetVisible(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3AXISA_Visible, value, R3TAG_END);

Offset

Attribute

Offset

Identifier

R3AXISA_Offset

JavaScript type

Number

C type

R3FLOAT

Description

offset

Syntax


jsobj.SetOffset(value);


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_Offset, value, R3TAG_END);

StartMargin

Attribute

StartMargin

Identifier

R3AXISA_StartMargin

JavaScript type

Integer

C type

R3INT

Description

start (left, top) margin

Syntax


jsobj.SetStartMargin(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3AXISA_StartMargin, value, R3TAG_END);

EndMargin

Attribute

EndMargin

Identifier

R3AXISA_EndMargin

JavaScript type

Integer

C type

R3INT

Description

end (right, bottom) margin

Syntax


jsobj.SetEndMargin(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3AXISA_EndMargin, value, R3TAG_END);

Marks

Attribute

Marks

Identifier

R3AXISA_Marks

JavaScript type

Integer

C type

R3INT

Description

number of tick marks. If not defined, R3AXISCA_TickInterval define the scale

Syntax


jsobj.SetMarks(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3AXISA_Marks, value, R3TAG_END);

MinAdjustable

Attribute

MinAdjustable

Identifier

R3AXISA_MinAdjustable

JavaScript type

Boolean

C type

R3BOOL

Description

enable min notch

Syntax


jsobj.SetMinAdjustable(value);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_MinAdjustable, value, R3TAG_END);

MaxAdjustable

Attribute

MaxAdjustable

Identifier

R3AXISA_MaxAdjustable

JavaScript type

Boolean

C type

R3BOOL

Description

enable max notch

Syntax


jsobj.SetMaxAdjustable(value);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_MaxAdjustable, value, R3TAG_END);

CurrentAdjustable

Attribute

CurrentAdjustable

Identifier

R3AXISA_CurrentAdjustable

JavaScript type

Boolean

C type

R3BOOL

Description

enable current notch

Syntax


jsobj.SetCurrentAdjustable(value);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_CurrentAdjustable, value, R3TAG_END);

Value

Attribute

Value

Identifier

R3AXISA_Value

JavaScript type

Number

C type

R3FLOAT

Description

current value

Syntax


jsobj.SetValue(value);
value = jsobj.GetValue();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_Value, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AXISA_Value, &value, R3TAG_END);

StepValue

Attribute

StepValue

Identifier

R3AXISA_StepValue

JavaScript type

Number

C type

R3FLOAT

Description

how much to step forward/backward

Syntax


jsobj.SetStepValue(value);
value = jsobj.GetStepValue();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_StepValue, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AXISA_StepValue, &value, R3TAG_END);

UnitConverter

Attribute

UnitConverter

Identifier

R3AXISA_UnitConverter

JavaScript type

Object

C type

R3OBJ*

Description

Syntax


jsobj.SetUnitConverter(value);


R3OBJ* value = ...;
R3SetAttrs(r3obj, R3AXISA_UnitConverter, value, R3TAG_END);

UnitType

Attribute

UnitType

Identifier

R3AXISA_UnitType

JavaScript type

Integer

C type

R3INT

Description

see unit converter types

Syntax


jsobj.SetUnitType(value);


R3INT value = ...;
R3SetAttrs(r3obj, R3AXISA_UnitType, value, R3TAG_END);

ValueOffset

Attribute

ValueOffset

Identifier

R3AXISA_ValueOffset

JavaScript type

Number

C type

R3FLOAT*

Description

Syntax


jsobj.SetValueOffset(value);


R3FLOAT* value = ...;
R3SetAttrs(r3obj, R3AXISA_ValueOffset, value, R3TAG_END);

RangeMinAdjustable

Attribute

RangeMinAdjustable

Identifier

R3AXISA_RangeMinAdjustable

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetRangeMinAdjustable(value);
value = jsobj.GetRangeMinAdjustable();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_RangeMinAdjustable, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3AXISA_RangeMinAdjustable, &value, R3TAG_END);

RangeMaxAdjustable

Attribute

RangeMaxAdjustable

Identifier

R3AXISA_RangeMaxAdjustable

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetRangeMaxAdjustable(value);
value = jsobj.GetRangeMaxAdjustable();


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_RangeMaxAdjustable, value, R3TAG_END);
R3BOOL value;
R3GetAttrs(r3obj, R3AXISA_RangeMaxAdjustable, &value, R3TAG_END);

RangeMin

Attribute

RangeMin

Identifier

R3AXISA_RangeMin

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetRangeMin(value);
value = jsobj.GetRangeMin();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_RangeMin, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AXISA_RangeMin, &value, R3TAG_END);

RangeMax

Attribute

RangeMax

Identifier

R3AXISA_RangeMax

JavaScript type

Number

C type

R3FLOAT

Description

Syntax


jsobj.SetRangeMax(value);
value = jsobj.GetRangeMax();


R3FLOAT value = ...;
R3SetAttrs(r3obj, R3AXISA_RangeMax, value, R3TAG_END);
R3FLOAT value;
R3GetAttrs(r3obj, R3AXISA_RangeMax, &value, R3TAG_END);

Animator

Attribute

Animator

Identifier

R3AXISA_Animator

JavaScript type

Object

C type

R3OBJ*

Description

Syntax


jsobj.SetAnimator(value);


R3OBJ* value = ...;
R3SetAttrs(r3obj, R3AXISA_Animator, value, R3TAG_END);

NoDirectKnobUpdate

Attribute

NoDirectKnobUpdate

Identifier

R3AXISA_NoDirectKnobUpdate

JavaScript type

Boolean

C type

R3BOOL

Description

Syntax


jsobj.SetNoDirectKnobUpdate(value);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_NoDirectKnobUpdate, value, R3TAG_END);

CurrentVisible

Attribute

CurrentVisible

Identifier

R3AXISA_CurrentVisible

JavaScript type

Boolean

C type

R3BOOL

Description

default is TRUE

Syntax


jsobj.SetCurrentVisible(value);


R3BOOL value = ...;
R3SetAttrs(r3obj, R3AXISA_CurrentVisible, value, R3TAG_END);

side codes

R3AXSIDE_BOTTOM
R3AXSIDE_TOP
R3AXSIDE_LEFT
R3AXSIDE_RIGHT

R3AKS_HALFHEIGHT
R3AKS_FULLHEIGHT

hit codes

R3_HIT_NONE
R3_HIT_NOTCH
R3_HIT_NEXT
R3_HIT_PREV

Tags

Tags

R3AXISCA_NoFrames