In file include/csengine/cscoll.h:

class csCollection : public csObject

A collection object is for conveniance of the script language

Inheritance:


Public Methods

void AddObject (csObject* obj)
Add an object to the collection.
csCollection ()
Create a new csCollection with the given name
csObject* FindObject (char* name)
Find an object with the given name inside this collection
int GetNumObjects ()
Get the number of objects in this collection
void Move (const csVector3& v)
Relative move
void Move (float dx, float dy, float dz)
Relative move
csObject* operator[] (int i)
void SetMove (csSector* home, float x, float y, float z)
Set the location of all objects in the collection
void SetMove (csSector* home, const csVector3& v)
Set the location of all objects in the collection
void SetTransform (const csMatrix3& matrix)
Set the transformation matrix for all objects in the collection
void Transform ()
Really do the transformation and moving of all objects in the collection
void Transform (csMatrix3& matrix)
Relative transform
virtual ~csCollection ()

Private Fields

csVector objects
The list of objects contained in this csCollection.

Inherited from csObject:

Public Methods

CS_ID GetID()
csObject* GetObj(const csIdType& objtype)
virtual csObject* GetObjectParent()
void ObjAdd(csObject* obj)
csObjIterator ObjGet(const csIdType& objtype)
void ObjRelease(csObject* obj)
void ObjRemove(csObject* obj)

Private Fields

CS_ID csid_value
csObjTree* objtree

Private Methods

virtual void SetObjectParent(csObject* parent)

Documentation

A collection object is for conveniance of the script language. Objects are (currently) not really hierarchical in Crystal Space. A collection simulates a hierarchy. The script can then perform operations like 'move' and 'transform' on all the objects in the collection together.
csVector objects
The list of objects contained in this csCollection.

csCollection()
Create a new csCollection with the given name

virtual ~csCollection()

void SetMove(csSector* home, const csVector3& v)
Set the location of all objects in the collection

void SetMove(csSector* home, float x, float y, float z)
Set the location of all objects in the collection

void SetTransform(const csMatrix3& matrix)
Set the transformation matrix for all objects in the collection

void Move(float dx, float dy, float dz)
Relative move

void Move(const csVector3& v)
Relative move

void Transform(csMatrix3& matrix)
Relative transform

void Transform()
Really do the transformation and moving of all objects in the collection. This should be called after calling any of the other set_move, set_transform, move or transform calls.

csObject* FindObject(char* name)
Find an object with the given name inside this collection

int GetNumObjects()
Get the number of objects in this collection

void AddObject(csObject* obj)
Add an object to the collection.

csObject* operator[] (int i)


This class has no child classes.

alphabetic index hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de