A PhysicObject is an optional component that can be attached to an Object. They create links between your physic World and your Scene. As soon a PhysicObject is added to an Object it is treated as Static; by adding one or multiple Collider you can then define their representation of inside the physic World.

Based on the type of simulation you are trying to achieve you can optionally add an extra component to the PhysicObject itself that will enable you to simulate RigidBody and SoftBody (DynamicMesh only) physics which in turn will give you access to a more refined set of functionalities.

Static Variables

Name	Description
`object`	Parent Object where the PhysicObject component is maintained.
Declaration Object *object
`rigidbody`	Reference to a RigidBody physics component attached to the active PhysicObject.
Declaration RigidBody *rigidbody Note Only available if rigid body physics have been added to the active PhysicObject (see `AddRigidBody`).
`softbody`	Reference to a SoftBody physics component attached to the active PhysicObject.
Declaration SoftBody *softbody Note Only available if soft body physics have been added to the active PhysicObject (see `AddSoftBody`).
`collider_count`	Total amount of Collider attached to the current PhysicObject.
Declaration unsigned char collider_count

Variables

Name	Description
`force_compound`	Force a single Collider to be treated as a compound shape.
Declaration bool force_compound
`collisionlayer_mask`	Bit mask created using CollisionLayer caps that determine on which layer(s) the PhysicObject will be placed on.
Declaration int collisionlayer_mask
`collisionlayer_filter`	Bit mask created using CollisionLayer caps that determine which layer(s) the PhysicObject can collide with.
Declaration int collisionlayer_filter
`material_callback`	Enable or disable physic material collision callback.
Declaration bool material_callback
`initial_transform`	Initial transformation matrix of the PhysicObject used before the physics simulation started.
Declaration mat4 initial_transform
`friction`	Specify the base friction of the PhysicObject.
Declaration float friction
`initial_transform`	Represent the base restitution of the PhysicObject.
Declaration float restitution

Functions

Name	Description
`AddCollider`	Attach a new Collider to the active PhysicObject.
Declaration Collider AddCollider( const char name, const CollisionBounds type ) Parameters `name`: A unique name to identify the new Collider. `type`: Specify the type of CollisionBounds to be created. Return Value A new Collider reference.
`GetCollider`	Retrieve an existing Collider attached to the active PhysicObject using its name as key.
Declaration Collider GetCollider( const char name ) Parameters `name`: The name of the Collider reference to retrieve. Return Value `nil` if no existing Collider attached to the PhysicObject match the name received in parameter; else return the Collider reference.
`GetColliderAt`	Helper function to retrive a Collider by index.
Declaration Collider GetColliderAt( unsigned char index ) Parameters* `index`: Index of the Collider reference to retrieve. Return Value `nil` if the index is invalid; else return a reference to the Collider pointed by index.
`GetColliderIndex`	Retrieve the index of an existing Collider.
Declaration int GetColliderIndex( const Collider collider ) Parameters* `collider`: Reference to an existing Collider maintained by the active PhysicObject. Return Value `-1` if the collider reference is invalid; else return the index of the Collider reference received in parameter.
`RemoveCollider`	Remove a specific Collider.
Declaration bool RemoveCollider( Collider collider, bool update_local_inertia ) Parameters* `collider`: Reference of the Collider to remove. `update_local_inertia`: Whether or not to force an update of the local inertia; only apply when multiple Collider form a compound shape. Return Value `true` on success; else return `false` if the Collider reference was invalid.
`RemoveColliderAt`	Delete an existing Collider using its internal index.
Declaration bool RemoveColliderAt( int index, bool update_local_inertia ) Parameters `index`: Index of the Collider to remove. `update_local_inertia`: Whether or not to force an update of the local inertia; only apply when multiple Collider form a compound shape. Return Value `true` if that Collider have been removed successfully; `false` if the index is invalid.
`AddRigidBody`	Add RigidBody physics capabilities to the active PhysicObject.
Declaration RigidBody AddRigidBody( void ) Return Value* Reference to the new or existing RigidBody component attached to the current PhysicObject.
`AddSoftBody`	Add SoftBody physics capabilities to the active PhysicObject.
Declaration SoftBody AddSoftBody( void ) Return Value* Reference to the new or existing SoftBody component attached to the current PhysicObject.
`Build`	Force to build/rebuild the active PhysicObject internal physic shape.
Declaration void Build( void ) Note Only call this function manually in the event a structural change have been made on the PhysicObject (ie: a new collider have been added or removed).
`SetTransform`	Manually set the world transformation matrix of the PhysicObject.
Declaration void SetTransform( const mat4 m, bool initial_transform ) Parameters `m`: The transformation matrix to apply to the PhysicObject. `initial_transform`: Determine wether or not the transformation matrix received in parameter should be used as the `initial_transform` of the PhysicObject. Note Since the underlying Object transformation is driven by the physic simulation; changing the `basis_matrix` or `world_matrix` will not have any impact. As soon a PhysicObject component is attached to the Object the physic simulation will control its transformation. This function is available for the user to manually change the transformation maintained by the physics engine.
`GetActivationState`	Retrieve the active ActivationState of the PhysicObject maintained by the physics engine.
Declaration ActivationState GetActivationState( void )
`IsStatic`	Helper to retrieve if the PhysicObject is a static or not.
Declaration bool IsStatic( void )
`IsKinematic`	Helper to retrieve if the PhysicObject is a kinematic object or not.
Declaration bool IsKinematic( void )
`IsActive`	Helper to retrieve if the PhysicObject status in the physic simulation is currently set to active (see ActivationState).
Declaration bool IsActive( void )
`GetContactCount`	Function to retrive the total amount of contact points connected to the active PhysicObject.
Declaration int GetContactCount( void )
`GetContactAt`	Retrieve a specific WorldContact using its index as key.
Declaration WorldContact GetContactAt( unsigned int index ) Return Value A WorldContact structure. If the index is invalid the `physicobject0` of the world contact will be `nil`; else it will point to the first PhysicObject reference involved in the collision.
`GenerateColliders`	Generate a compound shape based on the Collider information parent Object attachments.
Declaration bool GenerateColliders( bool append_colliders ) Parameters `append_colliders`: Force the new Collider to be appended to the existing list of Collider maintained by the active PhysicObject. Return Value `true` if new Collider have been created; else return false if no new colliders have been generate or if the active PhysicObject is a soft body. Warning Apply only for a static or rigid body physics.

Events

The events below are available when an Object have a PhysicObject attached to it. Theses new callbacks are triggered at the various collision stages between two PhysicObject.

Callbacks	Description
`OnOverlap`	Occur when two physic object AABB are overlapping. This does not mean that a collision occurs yet; only report that two PhysicObject are in proximity.
Declaration function OnOverlap()
`OnCollide`	Triggered when two PhysicObject are in proximity and actually collide with each other.
Declaration function OnCollide()
`OnContact`	This callback occurs during the PhysicMaterial combiner phase which indicates that contact points have been created and a collision is occuring.
Declaration function OnContact()

ActivationState

Constant values that represent the current state of a PhysicObject attached to a physic World.

kActive: Tell the system that the PhysicObject is ready to interact with the physic World.
kDeactivated: Put the PhysicObject on standby.
kWantsDeactivation: Force the PhysicObject to be deactivated.
kDisableDeactivation: Force the PhysicObject to always stay active.
kDisableSimulation: Temporary remove the PhysicObject from the physic simulation.