CrystalSpace

Public API Reference

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

csObject Class Reference

A generic csObject class. More...

#include <csutil/csobject.h>

Inheritance diagram for csObject:

iObject iBase csColliderWrapper csKeyValuePair csMapNode csProcTexture csSoundWrapper csProcAnimated List of all members.

Public Member Functions

 csObject (iBase *pParent=0)
 Initialize the csObject.
 csObject (csObject &o)
 Copy constructor.
virtual ~csObject ()
 Destroy this object and the associated children.
virtual void SetName (const char *iName)
 Set object name.
virtual const char * GetName () const
 Query object name.
virtual uint GetID () const
 Get the unique ID associated with this object.
virtual void SetObjectParent (iObject *)
 Set the parent csObject.
virtual iObjectGetObjectParent () const
 Returns the parent iObject.
virtual void ObjAdd (iObject *obj)
 Attach a new iObject to the tree.
virtual void ObjRemove (iObject *obj)
 Deletes the given object, removing it from the object tree.
virtual void ObjRemoveAll ()
 Deletes all objects, removing them from the object tree.
virtual void ObjAddChildren (iObject *Parent)
 Add all child objects of the given object.
virtual void * GetChild (int iInterfaceID, int iVersion, const char *Name=0, bool FirstName=false) const
 Look for a child object that implements the given interface.
virtual iObjectGetChild (const char *Name) const
 Return the first child object with the given name.
virtual csPtr< iObjectIteratorGetIterator ()
 Return an iterator for all child objects.

Protected Member Functions

void InitializeObject ()
 private initialization function

Protected Attributes

uint csid
 Each object has a unique ID associated with it.
csObjectContainerChildren
 The array of child nodes.
char * Name
 Object's name or 0 if unnamed.
iObjectParentObject
 Parent object.

Detailed Description

A generic csObject class.

Any csObject can have any number of iObject children attached to it. You can use SCF_QUERY_INTERFACE to get interfaces from the child objects.

Definition at line 37 of file csobject.h.


Constructor & Destructor Documentation

csObject::csObject iBase pParent = 0  ) 
 

Initialize the csObject.

csObject::csObject csObject o  ) 
 

Copy constructor.

The copied object contains all children of the original object, but has a new ID and is not automatically added to the original object's parent.

virtual csObject::~csObject  )  [virtual]
 

Destroy this object and the associated children.


Member Function Documentation

virtual iObject* csObject::GetChild const char *  Name  )  const [virtual]
 

Return the first child object with the given name.

Implements iObject.

virtual void* csObject::GetChild int  iInterfaceID,
int  iVersion,
const char *  Name = 0,
bool  FirstName = false
const [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.

Implements iObject.

virtual uint csObject::GetID  )  const [virtual]
 

Get the unique ID associated with this object.

Implements iObject.

virtual csPtr<iObjectIterator> csObject::GetIterator  )  [virtual]
 

Return an iterator for all child objects.

Note that you should not remove child objects while iterating.

Implements iObject.

virtual const char* csObject::GetName  )  const [virtual]
 

Query object name.

Implements iObject.

virtual iObject* csObject::GetObjectParent  )  const [virtual]
 

Returns the parent iObject.

Implements iObject.

void csObject::InitializeObject  )  [protected]
 

private initialization function

virtual void csObject::ObjAdd iObject obj  )  [virtual]
 

Attach a new iObject to the tree.

Implements iObject.

virtual void csObject::ObjAddChildren iObject Parent  )  [virtual]
 

Add all child objects of the given object.

Implements iObject.

virtual void csObject::ObjRemove iObject obj  )  [virtual]
 

Deletes the given object, removing it from the object tree.

Implements iObject.

virtual void csObject::ObjRemoveAll  )  [virtual]
 

Deletes all objects, removing them from the object tree.

Implements iObject.

virtual void csObject::SetName const char *  iName  )  [virtual]
 

Set object name.

Implements iObject.

virtual void csObject::SetObjectParent iObject  )  [virtual]
 

Set the parent csObject.

Implements iObject.


Member Data Documentation

csObjectContainer* csObject::Children [protected]
 

The array of child nodes.

Definition at line 45 of file csobject.h.

uint csObject::csid [protected]
 

Each object has a unique ID associated with it.

Definition at line 42 of file csobject.h.

char* csObject::Name [protected]
 

Object's name or 0 if unnamed.

Definition at line 48 of file csobject.h.

iObject* csObject::ParentObject [protected]
 

Parent object.

Definition at line 51 of file csobject.h.


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