IDLgrScene

A scene object represents the entire scene to be drawn and serves as a container of IDLgrView or IDLgrViewgroup objects.

Superclasses

This class is a subclass of IDL_Container

Subclasses

This class has no subclasses.

Creation

See IDLgrScene::Init

Methods

Intrinsic Methods

This class has the following methods:

Inherited Methods

This class inherits the following methods:

IDLgrScene::Add

The IDLgrScene::Add function method verifies that the added item is an instance of an IDLgrView or IDLgrViewgroup object. If it is, IDLgrScene:Add adds the view or viewgroup to the specified scene. IDLgrScene is described above.

Calling Sequence

Obj -> [IDLgrScene::] Add, View

Arguments

View

An instance of the IDLgrView or IDLgrViewgroup object class.

Keywords

POSITION

Set this keyword equal to the zero-based index of the position within the container at which the new object should be placed.

IDLgrScene::Cleanup

The IDLgrScene:: Cleanup procedure method performs all cleanup on the object. IDLgrScene is described above.

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

Calling Sequence

OBJ_DESTROY, Obj

Obj -> [IDLgrScene::] Cleanup ( In a subclass' Cleanup method only .)

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.

IDLgrScene::GetByName

The IDLgrScene:: GetByName function method finds contained objects by name and returns the object reference to the named object. If the named object is not found, the GetByName function returns a null object reference.

NOTE: The GetByName function does not perform a recursive search through the object hierarchy. If a fully qualified object name is not specified, only the contents of the current container object are inspected for the named object.

IDLgrScene is described above.

Calling Sequence

Result = Obj -> [IDLgrScene::] GetByName( Name )

Arguments

Name

A string containing the name of the object to be returned.

Object naming syntax is very much like the syntax of a Unix filesystem. Objects contained by other objects can include the name of their parent object; this allows you to create a fully qualified name specification. For example, if object1 contains object2 , which in turn contains object3 , the string specifying the fully qualified object name of object3 would be 'object1/object2/object3' .

Object names are specified relative to the object on which the GetByName method is called. If used at the beginning of the name string, the / character represents the top of an object hierarchy. The string '..' represents the object one level "up" in the hierarchy.

Keywords

There are no keywords for this method.

IDLgrScene::GetProperty

The IDLgrScene:: GetProperty procedure method retrieves the value of a property or group of properties for the contour. IDLgrScene is described above.

Calling Sequence

Obj -> [IDLgrScene::] GetProperty

Keywords

Any keyword to IDLgrScene::Init

ALL

Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.

NOTE: The fields of this structure may change in subsequent releases of IDL.

IDLgrScene::Init

The IDLgrScene:: Init function method initializes the scene object. IDLgrScene is described above.

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.

Calling Sequence

Obj = OBJ_NEW('IDLgrScene')

Result = Obj -> [IDLgrScene::] Init( ) ( In a subclass' Init method only .)

Arguments

There are no arguments for this method.

Keywords

Properties retrievable via IDLgrScene::GetProperty

COLOR (Get, Set)

Set this keyword to the color to which the scene should be erased before drawing. The color may be specified as a color lookup table index or an RGB vector.

TRANSPARENT (Get, Set)

Set this keyword to disable window clearing. If this keyword is not set, the destination object in use by the scene is automatically erased when the scene is initialized.

UVALUE (Get, Set)

Set this keyword to a value of any type. You can use this "user value" to contain any information you wish. Remember that if you set the user value equal to a pointer or object reference, you should destroy the pointer or object reference explicitly when destroying the object it is a user value of.

IDLgrScene::Remove

The IDLgrScene:: Remove procedure method removes a view from the scene object. IDLgrScene is described above.

Calling Sequence

Obj -> [IDLgrScene::] Remove, View

Arguments

View

A reference to the IDLgrView object to be removed from the scene.

Keywords

ALL

Set this keyword to remove all object from the container. If this keyword is set, the View argument is not required.

POSITION

Set this keyword equal to the zero-based index of the object to be removed. If the View argument is supplied, this keyword is ignored.

IDLgrScene::SetProperty

The IDLgrScene:: SetProperty procedure method sets the value of a property or group of properties for the buffer.

Calling Sequence

Obj -> [IDLgrScene::] SetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrScene::Init