IDL_Container

An IDL_ Container object holds other objects. Destroying an IDL_Container object destroys any objects that have been added to the container via the Add method.

Superclasses

This class has no superclasses.

Subclasses

The following classes are subclassed from this class:

Creation

See IDL_Container::Init

Methods

Intrinsic Methods

This class has the following methods:


IDL_Container::Add

The IDL_Container:: Add procedure method adds a child object to the container. IDL_Container is described above.

Calling Sequence

Obj -> [IDL_Container::] Add( Object )

Arguments

Object

An instance of an object to be added to the container object.

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. The default is to add the new object at the end of the list of contained items.


IDL_Container::Cleanup

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

Calling Sequence

OBJ_DESTROY, Obj

or

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

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDL_Container::Count

The IDL_Container:: Count function method returns the number of objects contained by the container object. IDL_Container is described above.

Calling Sequence

Result = Obj -> [IDL_Container::] Count()

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDL_Container::Get

The IDL_Container:: Get function method returns an array of object references to objects in a container. Unless the ALL or COUNT keywords are specified, the first object in the container is returned. If no objects are found in the container, the Get function returns -1. IDL_Container is described above.

Calling Sequence

Result = Obj -> [IDL_Container::] Get()

Arguments

There are no arguments for this method.

Keywords

ALL

Set this keyword to return an array of object references to all of the objects in the container.

COUNT

Set this keyword equal to a named variable that will contain the number of objects selected by the function. If the ALL keyword is also specified, specifying this keyword is the same as calling the IDL_Container::Count method.

ISA

Set this keyword equal to a class name. Only objects that inherit from the specified class will be returned.

POSITION

Set this keyword equal to a scalar or array containing the zero-based indices of the positions of the objects to return.


IDL_Container::Init

The IDL_Container:: Init function method initializes the container object. IDL_Container is described above.

Calling Sequence

Obj = OBJ_NEW('IDL_Container')

 

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

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDL_Container::IsContained

The IDL_Container:: IsContained function method returns true (1) if the specified object is in the container, or false (0) otherwise. IDL_Container is described above.

Calling Sequence

Result = Obj -> [IDL_Container::] IsContained( Object)

Arguments

Object

The object reference of the object to search for in the container.

Keywords

There are no keywords for this method.


IDL_Container::Move

The IDL_Container:: Move procedure method moves an object from one position in a container to a new position. The order of the other objects in the container remains unchanged. IDL_Container is described above.

Positioning within a container controls the rendering order of the contained objects. The object whose location has the lowest index value is rendered first. If several objects are located at the same point in three-dimensional space, the object rendered first will occlude objects rendered later. Objects located "behind" other objects in three-dimensional space must be rendered before objects in front of them, even if the "front" objects are translucent.

Calling Sequence

Obj -> [IDL_Container::] Move, Source , Destination

Arguments

Source

The zero-based index of the current location of the object to be moved.

Destination

The zero-based index of the location in the container where the object will reside after being moved.

Keywords

There are no keywords for this method.


IDL_Container::Remove

The IDL_Container:: Remove procedure method removes an object from view from the container. IDL_Container is described above.

Calling Sequence

Obj -> [IDL_Container::] Remove [ , Child_object]

Arguments

Child_object

The object reference of the object to be removed from the container. If Child_object is not provided (and neither the ALL nor POSITION keyword are set), the first object in the container will be removed.

Keywords

ALL

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

POSITION

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