CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iObject Struct Reference
[Utilities]

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

#include <object.h>

Inheritance diagram for iObject:

iBase csObject csColliderWrapper csKeyValuePair csMapNode csProcTexture csSoundWrapper csProcDots csProcFire csProcPlasma csProcSkyTexture csProcWater 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.

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=0, bool FirstName=false) const=0
 Look for a child object that implements the given interface.

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

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


Detailed Description

This interface is an SCF interface for encapsulating csObject.

Main creators of instances implementing this interface:

Main ways to get pointers to this interface:

Definition at line 79 of file object.h.


Member Function Documentation

virtual iObject* iObject::GetChild const char *    Name const [pure virtual]
 

Return the first child object with the given name.

Implemented in csObject.

virtual void* iObject::GetChild int    iInterfaceID,
int    iVersion,
const char *    Name = 0,
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.

Implemented in csObject.

virtual CS_ID iObject::GetID   [pure virtual]
 

Get the unique ID associated with this object.

Implemented in csObject.

virtual csPtr<iObjectIterator> iObject::GetIterator   [pure virtual]
 

Return an iterator for all child objects.

Note that you should not remove child objects while iterating.

Implemented in csObject.

virtual const char* iObject::GetName   [pure virtual]
 

Query object name.

Implemented in csObject.

virtual iObject* iObject::GetObjectParent   [pure virtual]
 

Returns the parent iObject.

Implemented in csObject.

virtual void iObject::ObjAdd iObject *    obj [pure virtual]
 

Attach a new iObject to the tree.

Implemented in csObject.

virtual void iObject::ObjAddChildren iObject *    Parent [pure virtual]
 

Add all child objects of the given object.

Implemented in csObject.

virtual void iObject::ObjRemove iObject *    obj [pure virtual]
 

Remove an iObject from the tree.

Implemented in csObject.

virtual void iObject::ObjRemoveAll   [pure virtual]
 

Remove all child objects.

Implemented in csObject.

virtual void iObject::SetName const char *    iName [pure virtual]
 

Set object name.

Implemented in csObject.

virtual 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.

Implemented in csObject.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.18