IDLgrROIGroup::Init

IDLgrROIGroup::Init

Syntax | Return Value | Arguments | Keywords | Version History

The IDLgrROIGroup::Init function method initializes an Object Graphics region of interest group object.

Note

Init methods are special life cycle 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('IDLgrROIGroup' [, PROPERTY=value])

Result = Obj->[IDLgrROIGroup::]Init([PROPERTY=value]) (Only in a subclass' Init method.)

Note

Keywords can be used in either form. They are omitted in the second form for brevity.

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

None

Keywords

Any property listed under IDLgrROIGroup 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.

All other keywords are passed to the superclass of this object.

Version History

Introduced: 5.3

CLIP_PLANES keyword added: 5.6