CrystalSpace

Public API Reference

CS::Physics::iPhysicalSector Struct Reference

This is the interface for the physical sector. More...

#include <ivaria/physics.h>

Inheritance diagram for CS::Physics::iPhysicalSector:

List of all members.

Public Member Functions

virtual void AddJoint (iJoint *joint)=0
 Add a joint to the sector. The joint must have attached two physical bodies.
virtual void AddVehicle (iVehicle *vehicle)=0
 Add a vehicle to the sector.
virtual float GetAngularDamping () const =0
 Get the default angular damping for all objects in this sector.
virtual float GetLinearDamping () const =0
 Get the default linear damping for all objects in this sector.
virtual iRigidBodyGetRigidBody (size_t index)=0
 Get the rigid body by index.
virtual size_t GetRigidBodyCount ()=0
 Get the count of rigid bodies.
virtual iSoftBodyGetSoftBody (size_t index)=0
 Get the soft body by index.
virtual size_t GetSoftBodyCount ()=0
 Get the count of soft bodies.
virtual void RemoveJoint (iJoint *joint)=0
 Remove a joint from this sector.
virtual void RemoveVehicle (iVehicle *vehicle)=0
 Remove a vehicle from this sector.
virtual bool Save (const char *filename)=0
 Save the current state of this sector in a file.
virtual void SetAngularDamping (float damping)=0
 Set the default angular damping for all objects in this sector.
virtual void SetAutoDisableParams (float linear, float angular, float time)=0
 Set the parameters for auto disabling the computation of forces on the physical objects in this sector.
virtual void SetLinearDamping (float damping)=0
 Set the default linear damping for all objects in this sector.

Detailed Description

This is the interface for the physical sector.

It manage all physical bodies.

See also:
CS::Collisions::iCollisionSector CS::Physics::iPhysicalSector

Definition at line 1330 of file physics.h.


Member Function Documentation

virtual void CS::Physics::iPhysicalSector::AddJoint ( iJoint joint  )  [pure virtual]

Add a joint to the sector. The joint must have attached two physical bodies.

virtual void CS::Physics::iPhysicalSector::AddVehicle ( iVehicle vehicle  )  [pure virtual]

Add a vehicle to the sector.

virtual float CS::Physics::iPhysicalSector::GetAngularDamping (  )  const [pure virtual]

Get the default angular damping for all objects in this sector.

virtual float CS::Physics::iPhysicalSector::GetLinearDamping (  )  const [pure virtual]

Get the default linear damping for all objects in this sector.

virtual iRigidBody* CS::Physics::iPhysicalSector::GetRigidBody ( size_t  index  )  [pure virtual]

Get the rigid body by index.

virtual size_t CS::Physics::iPhysicalSector::GetRigidBodyCount (  )  [pure virtual]

Get the count of rigid bodies.

virtual iSoftBody* CS::Physics::iPhysicalSector::GetSoftBody ( size_t  index  )  [pure virtual]

Get the soft body by index.

virtual size_t CS::Physics::iPhysicalSector::GetSoftBodyCount (  )  [pure virtual]

Get the count of soft bodies.

virtual void CS::Physics::iPhysicalSector::RemoveJoint ( iJoint joint  )  [pure virtual]

Remove a joint from this sector.

virtual void CS::Physics::iPhysicalSector::RemoveVehicle ( iVehicle vehicle  )  [pure virtual]

Remove a vehicle from this sector.

virtual bool CS::Physics::iPhysicalSector::Save ( const char *  filename  )  [pure virtual]

Save the current state of this sector in a file.

The format of the file is internal to the dynamic simulation library being used (most probably Bullet).

Returns:
True if the operation succeeded, false otherwise.
virtual void CS::Physics::iPhysicalSector::SetAngularDamping ( float  damping  )  [pure virtual]

Set the default angular damping for all objects in this sector.

The dampening correspond to how much the movements of the objects will be reduced. It is a value between 0 and 1, giving the ratio of speed that will be reduced in one second. 0 means that the movement will not be reduced, while 1 means that the object will not move. The default value is 0.1f.

See also:
CS::Physics::iRigidBody::SetAngularDamping()
virtual void CS::Physics::iPhysicalSector::SetAutoDisableParams ( float  linear,
float  angular,
float  time 
) [pure virtual]

Set the parameters for auto disabling the computation of forces on the physical objects in this sector.

Parameters:
linear Maximum linear movement to disable a body. Default value is 0.8.
angular Maximum angular movement to disable a body. Default value is 1.0.
steps Minimum number of steps the body meets linear and angular requirements before it is disabled. Default value is 0.
time Minimum time the body needs to meet linear and angular movement requirements before it is disabled. Default value is 0.0.
Remarks:
With the Bullet plugin, the 'steps' parameter is ignored.
With the Bullet plugin, calling this method will not affect bodies already created.
virtual void CS::Physics::iPhysicalSector::SetLinearDamping ( float  damping  )  [pure virtual]

Set the default linear damping for all objects in this sector.

The dampening correspond to how much the movements of the objects will be reduced. It is a value between 0 and 1, giving the ratio of speed that will be reduced in one second. 0 means that the movement will not be reduced, while 1 means that the object will not move. The default value is 0.1f.

See also:
CS::Physics::iRigidBody::SetLinearDamping ()

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

Generated for Crystal Space 2.1 by doxygen 1.6.1