Google

Main Page   Class Hierarchy   Compound List   File List   Compound Members  

iObject Struct Reference

This interface is an SCF interface for encapsulating csObject. More...

#include <object.h>

Inheritance diagram for iObject:

iBase csObject csCameraPosition csCollection csColliderWrapper csCurve csCurveTemplate csDataObject csKeyValuePair csLight csMapNode csMaterialWrapper csMeshFactoryWrapper csMeshWrapper csPolygon3D csPolyTxtPlane csPortal csRadElement csRegion csSector csTextureWrapper csThing List of all members.

Public Methods

virtual void SetName (const char *iName)=0
 Set object name.

virtual const char* GetName () const=0
 Query object name.

virtual CS_ID GetID () const=0
 Get the unique ID associated with this object.

virtual void SetObjectParent (iObject *obj)=0
 Set the parent iObject. More...

virtual iObject* GetObjectParent () const=0
 Returns the parent iObject.

virtual void ObjAdd (iObject *obj)=0
 Attach a new iObject to the tree.

virtual void ObjRemove (iObject *obj)=0
 Remove an iObject from the tree.

virtual void ObjRemoveAll ()=0
 Remove all child objects.

virtual void ObjAddChildren (iObject *Parent)=0
 Add all child objects of the given object.

virtual void* GetChild (int iInterfaceID, int iVersion, const char *Name=NULL, bool FirstName=false) const=0
 Look for a child object that implements the given interface. More...

virtual iObject* GetChild (const char *Name) const=0
 Return the first child object with the given name.

virtual iObjectIteratorGetIterator ()=0
 Return an iterator for all child objects. More...

virtual void ObjReleaseOld (iObject *obj)=0

Detailed Description

This interface is an SCF interface for encapsulating csObject.


Member Function Documentation

void * iObject::GetChild ( int iInterfaceID,
int iVersion,
const char * Name = NULL,
bool FirstName = false ) const [pure virtual]
 

Look for a child object that implements the given interface.

You can optionally pass a name to look for. If FirstName is true then the method will stop at the first object with the requested name, even if it did not implement the requested type. Note that the returned object may only be cast to the requested type, no other type, not even iObject!

Note that the returned object will be IncRef'ed.

Reimplemented in csObject.

iObjectIterator * iObject::GetIterator ( ) [pure virtual]
 

Return an iterator for all child objects.

Note that you should not remove child objects while iterating.

Reimplemented in csObject.

void iObject::SetObjectParent ( iObject * obj ) [pure virtual]
 

Set the parent iObject.

Note that this only sets the 'parent' pointer but does not add the object as a child object.

Reimplemented in csObject.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000