The IDLgrAxis::Init function method initializes an axis object.

Note: Init methods are special lifecycle methods, and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: if you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.

Syntax


Obj = OBJ_NEW('IDLgrAxis' [, Direction] [, PROPERTY=value])

or

Result = Obj->[IDLgrAxis::]Init([Direction] [, PROPERTY=value])     (In a lifecycle method only.)

Return Value


When this method is called indirectly, as part of the call to the OBJ_NEW function, the return value is an object reference to the newly-created object.

When called directly within a subclass Init method, the return value is 1 if initialization was successful, or zero otherwise.

Arguments


Direction

An integer value specifying which axis is being created. Specify 0 (zero) to create an X axis, 1 (one) to create a Y axis, or 2 to create a Z axis.

Note: The value specified by the Direction argument is used to initialize the value of the DIRECTION property of the IDLgrAxis object.

Keywords


Any property listed under IDLgrAxis Properties that contains the word “Yes” in the “Init” column of the properties table can be initialized during object creation using this method. To initialize the value of a property, specify the property name as a keyword set equal to the appropriate property value.

Version History


5.0

Introduced