Enabled rigid body physics to be applied on a PhysicObject. The programming interface below allows you to control a variety of properties that will affect the behaviors of the RigidBody.

It also contains multiple helpers and functions to be able to control the physics movement of an object; create and attach different types of RigidConstraint to your rigid body to make your physics World more lifelike.

See Also

Static Variables

Name	Description
`physicobject`	Parent PhysicObject where the RigidBody component is stored.
Declaration PhysicObject *physicobject
`rigidconstraint_count`	Current amount of RigidConstraint attached to the current RigidBody.
Declaration unsigned short rigidconstraint_count

Variables

Name	Description
`default_state`	The default ActivationState the RigidBody after it is created.
Declaration ActivationState default_state
`adaptation_method`	The default AdaptationMethod to use for AdaptiveMesh located on the active RigidBody.
Declaration AdaptationMethod adaptation_method
`kinematic`	Determine whether or not the RigidBody transformation should be controlled by the application.
Declaration bool kinematic
`disable_contact_response`	Force the RigidBody to act as a ghost and stop responding to collision.
Declaration bool disable_contact_response Note Even is contact response is set to `false` collision events can still be detected and scripted.
`remove_broken_constraints`	Force the system to remove RigidConstraint as soon as the become broken.
Declaration bool remove_broken_constraints Note It is generally preferable to set this variable to `true` to avoid extra computations maintaining and evaluating RigidConstraint that have basically no more impact on the physic simulation.
`mass`	Control the mass of the active RigidBody.
Declaration float form_factor Range 0.0 to inf. Note A value of `0.0` will force the physics engine to consider the RigidBody as a static object.
`form_factor`	Control the form factor of the inertia tensor.
Declaration float form_factor Range 0.0 to 1.0
`linear_factor`	Linear factors allow you to specify the influence of movements for each axis.
Declaration vec3 linear_factor Range 0.0 to 1.0
`angular_factor`	Angular factors works basically the same way as is linear counterpart at the exception that it is applied to the rotational part of the RigidBody transformation.
Declaration vec3 angular_factor Range 0.0 to 1.0
`anisotropic_friction`	Control the internal friction damping by altering the value for each axis.
Declaration vec3 anisotropic_friction Range 0.0 to 1.0 Note Tweaking this vector you can control the impact of friction on a per axis basis (this vector is always relative to the friction direction vector).
`linear_damping`	Specify the linear damping factor for each axis.
Declaration float linear_damping Range 0.0 to 1.0
`angular_damping`	Controls the angular damping factor for each rotational axis.
Declaration float angular_damping Range 0.0 to 1.0
`linear_sleeping_threshold`	Linear sleeping threshold value in seconds; where 1.0 = 1 sec.
Declaration float linear_sleeping_threshold Range 0.0 to 1.0 Note If the rigid body linear velocity is stable for that period of time, the physics object will be marked for deactivation.
`angular_sleeping_threshold`	Same as `linear_sleeping_threshold` but control the angular sleeping threshold value.
Declaration float angular_sleeping_threshold Range 0.0 to 1.0 Note If the rigid body angular velocity is stable for that period of time, the physics object will be marked for deactivation.
`contact_processing_threshold`	The period of time (where 1.0 = 1 sec.) a contact point should still be considered as `alive` before it gets destroyed.
Declaration float contact_processing_threshold Range 0.0 to 1.0
`motion_threshold`	Interpolation factor that will be use to interpolate the motion between the previous and current frame.
Declaration float motion_threshold Range 0.0 to inf. Attention Can only be used when continuous collision detection is enabled (see the World help page for more info.)
`swept_sphere_radius`	Radius of the swept sphere to use for continuous collision detection.
Declaration float swept_sphere_radius Range 0.001 to inf.
`gravity`	Custom gravity vector to use for the active RigidBody.
Declaration vec3 gravity Remarks Setting this vector manually will override the World gravity; to restore it back to default, set the vector to 0.
`force`	Control the amount of force that should be applied on the RigidBody.
Declaration vec3 force
`torque`	Control the how much rotational torque should be applied on the RigidBody.
Declaration vec3 torque
`linear_velocity`	Set/get the amount of linear velocity is currently applied on the RigidBody.
Declaration vec3 linear_velocity
`angular_velocity`	Set/get how much angular velocity is currently applied on the RigidBody.
Declaration vec3 angular_velocity

Functions

Name	Description
`Activate`	Activate the RigidBody.
Declaration void Activate( bool force_activation ) Parameters `force_activation`: Choose whether or not to force the activation.
`Deactivate`	Force the physic engine to deactivate the RigidBody.
Declaration void Deactivate( void )
`WantsDeactivation`	Hint the physic engine that the RigidBody should be marked for deactivation.
Declaration void WantsDeactivation( void )
`DisableDeactivation`	Force the physic engine to never deactivate the RigidBody.
Declaration void DisableDeactivation( void )
`DisableSimulation`	Remove the RigidBody from the physics simulation.
Declaration void DisableSimulation( void ) Remarks To reactivate simply force the RigidBody re-activation.
`GetActivationState`	Return the current ActivationState of the RigidBody.
Declaration ActivationState GetActivationState( void )
`ClearForces`	Set all forces back to 0; wich will force the RigidBody to stop moving instantenously.
Declaration void ClearForces( void )
`ApplyForce`	Apply a certain amount of force to the active RigidBody.
Declaration void ApplyForce( const vec3 force, const vec3 relative_position ) Parameters `force`: Vector that represents how much force should be applied. `relative_position`: Specify the relative position to calculate the force direction vector. A zeroed vector represents the center of the RigidBody.
`ApplyImpulse`	Apply a specific amount of impulse on the RigidBody.
Declaration void ApplyImpulse( const vec3 impulse, const vec3 relative_position ) Parameters `impulse`: Vector to specify the amount of impulse that should be applied. `relative_position`: Specify the relative position to calculate the direction vector. Zero represents the center of the RigidBody.
`ApplyTorqueImpulse`	Apply a certain amount of torque impulse on the RigidBody.
Declaration void ApplyTorqueImpulse( const vec3 torque ) Parameters `torque`: Determine the torque impulse vector to apply.
`ApplyCentralImpulse`	Apply a specific amount of impulse to the center of the RigidBody.
Declaration void ApplyCentralImpulse( const vec3 impulse ) Parameters `impulse`: Vector to specify the amount of impulse that should be applied to the RigidBody center.
`ClearVelocities`	Clear out all velocity data (linear and angular).
Declaration void ClearVelocities( void )
`GetNumConstraintLinks`	Return how many constraints are connected to the current RigidBody.
Declaration int GetNumConstraintLinks( void ) Return Value The amount of constraints (either RigidConstraint or SoftConstraint) currently connected to the active RigidBody.
`AddConstraint`	Create a new RigidConstraint and attach it to the active RigidBody.
Declaration RigidConstraint AddConstraint( const char name, const RigidConstraintType type ) Parameters `name`: A name to identify the RigidConstraint to its parent RigidBody. `type`: Specify the RigidConstraintType that should be created. Return Value A reference to the newly created RigidConstraint.
`AddBallConstraint`	Helper function to create and attach a BallConstraint to the current RigidBody.
Declaration BallConstraint AddBallConstraint( const char name ) Parameters `name`: A name to identify the BallConstraint. Return Value Reference to the new BallConstraint.
`AddHingeConstraint`	Helper function to create and attach a HingeConstraint to the current RigidBody.
Declaration HingeConstraint AddHingeConstraint( const char name ) Parameters `name`: A name to identify the HingeConstraint. Return Value Reference to the new HingeConstraint.
`AddTwistConstraint`	Helper function to create and attach a TwistConstraint to the current RigidBody.
Declaration TwistConstraint AddTwistConstraint( const char name ) Parameters `name`: A name to identify the TwistConstraint. Return Value Reference to the new TwistConstraint.
`AddSliderConstraint`	Helper function to create and attach a SliderConstraint to the current RigidBody.
Declaration SliderConstraint AddSliderConstraint( const char name ) Parameters `name`: A name to identify the SliderConstraint. Return Value Reference to the new SliderConstraint.
`AddGenericConstraint`	Helper function to create and attach a GenericConstraint to the current RigidBody.
Declaration GenericConstraint AddGenericConstraint( const char name ) Parameters `name`: A name to identify the GenericConstraint. Return Value Reference to the new GenericConstraint.
`AddFixedConstraint`	Helper function to create and attach a FixedConstraint to the current RigidBody.
Declaration FixedConstraint AddFixedConstraint( const char name ) Parameters `name`: A name to identify the FixedConstraint. Return Value Reference to the new FixedConstraint.
`GetConstraint`	Retrieve the reference of a specific RigidConstraint attached to the current RigidBody using its name as key.
Declaration RigidConstraint GetConstraint( const char name ) Parameters `name`: Name of the RigidConstraint to retrieve. Return Value On success, returns a valid reference to an existing RigidConstraint; else return `nil`.
`GetConstraintAt`	Retrieve the reference of a RigidConstraint using its internal index as key.
Declaration RigidConstraint GetConstraintAt( unsigned short index ) Parameters* `index`: Internal index of the constraint to retrieve. Return Value A valid reference to the RigidConstraint pointed by index.
`GetConstraintIndex`	Return the internal index of a specific RigidConstraint reference.
Declaration int GetConstraintIndex( const RigidConstraint rigidconstraint ) Parameters* `rigidconstraint`: An existing RigidConstraint reference. Return Value `-1` if the reference received by the function is invalid; else return the internal index of the `rigidconstraint`.
`RemoveConstraint`	Remove a specific RigidConstraint attached to the active RigidBody.
Declaration bool RemoveConstraint( RigidConstraint rigidconstraint ) Parameters* `rigidconstraint`: Reference to the RigidConstraint to remove. Return Value `true` on success; `false` if the reference is invalid.
`RemoveConstraintAt`	Remove an existing RigidConstraint by index.
Declaration bool RemoveConstraintAt( int index ) Parameters `index`: Internal index of the RigidConstraint reference to remove. Return Value `true` on success; `false` if the index is out of bounds or invalid.