A scene object represents the entire scene to be drawn and serves as a container of IDLgrView or IDLgrViewgroup objects.
This class is a subclass of IDL_Container
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.
An instance of the IDLgrView or IDLgrViewgroup object class.
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.
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.
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
, which in turn contains
, the string specifying the fully qualified object name of object3 would be
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.
The IDLgrScene:: GetProperty procedure method retrieves the value of a property or group of properties for the contour. IDLgrScene is described above.
Any keyword to IDLgrScene::Init
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.
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.
Properties retrievable via IDLgrScene::GetProperty
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.
The IDLgrScene:: Remove procedure method removes a view from the scene object. IDLgrScene is described above.
A reference to the IDLgrView object to be removed from the scene.
Any keyword to IDLgrScene::Init