CEL

Public API Reference

iDynamicFactory Struct Reference

A factory object in the dynamic world. More...

#include <propclass/dynworld.h>

Inheritance diagram for iDynamicFactory:

List of all members.

Public Member Functions

virtual void AddRigidBox (const csVector3 &offset, const csVector3 &size, float mass, size_t idx=csArrayItemNotFound)=0
 Create a box rigid body.
virtual void AddRigidCapsule (float radius, float length, const csVector3 &offset, float mass, size_t idx=csArrayItemNotFound)=0
 Create a capsule rigid body.
virtual void AddRigidConvexMesh (const csVector3 &offset, float mass, size_t idx=csArrayItemNotFound)=0
 Create a convex mesh rigid body.
virtual void AddRigidCylinder (float radius, float length, const csVector3 &offset, float mass, size_t idx=csArrayItemNotFound)=0
 Create a cylinder rigid body.
virtual void AddRigidMesh (const csVector3 &offset, float mass, size_t idx=csArrayItemNotFound)=0
 Create a mesh rigid body.
virtual void AddRigidSphere (float radius, const csVector3 &offset, float mass, size_t idx=csArrayItemNotFound)=0
 Create a sphere rigid body.
virtual void ClearAttribute (csStringID nameID)=0
 Clear a given attribute.
virtual DynFactJointDefinitionCreateJoint ()=0
 Create a new joint and return a reference to the data so that it can be set up.
virtual bool CreatePivotJoint (const csVector3 &objpos)=0
 Create a pivot joint at a specific object space position (bullet only).
virtual void DeleteBodies ()=0
 Delete all bodies.
virtual void DeleteBody (size_t idx)=0
 Delete a body at a specific index.
virtual const char * GetAttribute (csStringID nameID) const =0
 Get an attribute.
virtual csPtr< iAttributeIteratorGetAttributes () const =0
 Get all attributes.
virtual const csBox3GetBBox () const =0
 Get the bounding box in object space as reported by iObjectModel for the given mesh factory.
virtual celBodyInfo GetBody (size_t idx) const =0
 Get the body.
virtual size_t GetBodyCount () const =0
 Get the number of bodies.
virtual const char * GetDefaultEntityTemplate () const =0
 Get the default entity template name or 0 if none.
virtual float GetImposterRadius () const =0
 Get the imposter radius.
virtual DynFactJointDefinitionGetJoint (size_t idx)=0
 Get a specific joint.
virtual size_t GetJointCount () const =0
 Get the amount of joints.
virtual float GetMaximumRadiusRelative () const =0
 Get the maximum relative radius for this factory.
virtual size_t GetObjectCount () const =0
 Get the number of dynamic objects that currently exist in memory and which depend on this factory.
virtual const csBox3GetPhysicsBBox () const =0
 Get the bounding box as calculated from the physical objects that have been attached to this factory.
virtual size_t GetPivotJointCount () const =0
 Get the amount of pivot joints.
virtual csVector3 GetPivotJointPosition (size_t idx)=0
 Get the position of a pivot joint.
virtual bool IsLightFactory () const =0
 Return true if this dynamic factory is a light factory (created with AddLightFactory()).
virtual bool IsLogicFactory () const =0
 Return true if this dynamic factory is a logic factory (created with AddLogicFactory()).
virtual void RemoveJoint (size_t idx)=0
 Remove a joint.
virtual void RemoveJoints ()=0
 Remove all joints.
virtual void RemovePivotJoint (size_t idx)=0
 Remove a specific pivot joint.
virtual void RemovePivotJoints ()=0
 Remove all pivot joints.
virtual void SetAttribute (csStringID nameID, const char *value)=0
 Generic attribute system.
virtual void SetColliderEnabled (bool e)=0
 Create a collider for the CS collision detection system (not physics).
virtual void SetDefaultEntityTemplate (const char *tmpName)=0
 Set the entity template that is linked to this factory.
virtual void SetGeometryGenerator (iGeometryGenerator *gen)=0
 Set a geometry generator that is going to be used as soon as a mesh is created from this factory.
virtual void SetJoint (size_t idx, const DynFactJointDefinition &def)=0
 Set joint parameters.
virtual void SetPivotJointPosition (size_t idx, const csVector3 &objpos)=0
 Change the starting position of a pivot joint.

Detailed Description

A factory object in the dynamic world.

Definition at line 207 of file dynworld.h.


Member Function Documentation

virtual void iDynamicFactory::AddRigidBox ( const csVector3 offset,
const csVector3 size,
float  mass,
size_t  idx = csArrayItemNotFound 
) [pure virtual]

Create a box rigid body.

If the optional index is given then this body will replace the body that was at that specific index.

virtual void iDynamicFactory::AddRigidCapsule ( float  radius,
float  length,
const csVector3 offset,
float  mass,
size_t  idx = csArrayItemNotFound 
) [pure virtual]

Create a capsule rigid body.

If the optional index is given then this body will replace the body that was at that specific index.

virtual void iDynamicFactory::AddRigidConvexMesh ( const csVector3 offset,
float  mass,
size_t  idx = csArrayItemNotFound 
) [pure virtual]

Create a convex mesh rigid body.

If the optional index is given then this body will replace the body that was at that specific index.

virtual void iDynamicFactory::AddRigidCylinder ( float  radius,
float  length,
const csVector3 offset,
float  mass,
size_t  idx = csArrayItemNotFound 
) [pure virtual]

Create a cylinder rigid body.

If the optional index is given then this body will replace the body that was at that specific index.

virtual void iDynamicFactory::AddRigidMesh ( const csVector3 offset,
float  mass,
size_t  idx = csArrayItemNotFound 
) [pure virtual]

Create a mesh rigid body.

If the optional index is given then this body will replace the body that was at that specific index.

virtual void iDynamicFactory::AddRigidSphere ( float  radius,
const csVector3 offset,
float  mass,
size_t  idx = csArrayItemNotFound 
) [pure virtual]

Create a sphere rigid body.

If the optional index is given then this body will replace the body that was at that specific index.

virtual void iDynamicFactory::ClearAttribute ( csStringID  nameID  )  [pure virtual]

Clear a given attribute.

virtual DynFactJointDefinition& iDynamicFactory::CreateJoint (  )  [pure virtual]

Create a new joint and return a reference to the data so that it can be set up.

virtual bool iDynamicFactory::CreatePivotJoint ( const csVector3 objpos  )  [pure virtual]

Create a pivot joint at a specific object space position (bullet only).

Returns false if it was not possible to create a pivot.

virtual void iDynamicFactory::DeleteBodies (  )  [pure virtual]

Delete all bodies.

virtual void iDynamicFactory::DeleteBody ( size_t  idx  )  [pure virtual]

Delete a body at a specific index.

virtual const char* iDynamicFactory::GetAttribute ( csStringID  nameID  )  const [pure virtual]

Get an attribute.

virtual csPtr<iAttributeIterator> iDynamicFactory::GetAttributes (  )  const [pure virtual]

Get all attributes.

virtual const csBox3& iDynamicFactory::GetBBox (  )  const [pure virtual]

Get the bounding box in object space as reported by iObjectModel for the given mesh factory.

virtual celBodyInfo iDynamicFactory::GetBody ( size_t  idx  )  const [pure virtual]

Get the body.

virtual size_t iDynamicFactory::GetBodyCount (  )  const [pure virtual]

Get the number of bodies.

virtual const char* iDynamicFactory::GetDefaultEntityTemplate (  )  const [pure virtual]

Get the default entity template name or 0 if none.

virtual float iDynamicFactory::GetImposterRadius (  )  const [pure virtual]

Get the imposter radius.

If 0.0 then impostering is disabled (imposters are currently not implemented yet).

virtual DynFactJointDefinition& iDynamicFactory::GetJoint ( size_t  idx  )  [pure virtual]

Get a specific joint.

The returned reference can be modified freely but objects created using this factory will not be updated automatically.

virtual size_t iDynamicFactory::GetJointCount (  )  const [pure virtual]

Get the amount of joints.

virtual float iDynamicFactory::GetMaximumRadiusRelative (  )  const [pure virtual]

Get the maximum relative radius for this factory.

virtual size_t iDynamicFactory::GetObjectCount (  )  const [pure virtual]

Get the number of dynamic objects that currently exist in memory and which depend on this factory.

virtual const csBox3& iDynamicFactory::GetPhysicsBBox (  )  const [pure virtual]

Get the bounding box as calculated from the physical objects that have been attached to this factory.

If the dynamic world is not in physics mode then this will return the normal bounding box.

virtual size_t iDynamicFactory::GetPivotJointCount (  )  const [pure virtual]

Get the amount of pivot joints.

virtual csVector3 iDynamicFactory::GetPivotJointPosition ( size_t  idx  )  [pure virtual]

Get the position of a pivot joint.

virtual bool iDynamicFactory::IsLightFactory (  )  const [pure virtual]

Return true if this dynamic factory is a light factory (created with AddLightFactory()).

virtual bool iDynamicFactory::IsLogicFactory (  )  const [pure virtual]

Return true if this dynamic factory is a logic factory (created with AddLogicFactory()).

virtual void iDynamicFactory::RemoveJoint ( size_t  idx  )  [pure virtual]

Remove a joint.

virtual void iDynamicFactory::RemoveJoints (  )  [pure virtual]

Remove all joints.

virtual void iDynamicFactory::RemovePivotJoint ( size_t  idx  )  [pure virtual]

Remove a specific pivot joint.

virtual void iDynamicFactory::RemovePivotJoints (  )  [pure virtual]

Remove all pivot joints.

virtual void iDynamicFactory::SetAttribute ( csStringID  nameID,
const char *  value 
) [pure virtual]

Generic attribute system.

virtual void iDynamicFactory::SetColliderEnabled ( bool  e  )  [pure virtual]

Create a collider for the CS collision detection system (not physics).

This is useful if you want to make a game that doesn't use physics (see iPcDynamicWorld->EnablePhysics()).

virtual void iDynamicFactory::SetDefaultEntityTemplate ( const char *  tmpName  )  [pure virtual]

Set the entity template that is linked to this factory.

This represents the default entity template to be used when creating entities from this dynamic object.

virtual void iDynamicFactory::SetGeometryGenerator ( iGeometryGenerator gen  )  [pure virtual]

Set a geometry generator that is going to be used as soon as a mesh is created from this factory.

virtual void iDynamicFactory::SetJoint ( size_t  idx,
const DynFactJointDefinition def 
) [pure virtual]

Set joint parameters.

virtual void iDynamicFactory::SetPivotJointPosition ( size_t  idx,
const csVector3 objpos 
) [pure virtual]

Change the starting position of a pivot joint.


The documentation for this struct was generated from the following file:

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1