View source for IPhysicsObject

{{toc-right}}

'''<code>IPhysicsObject</code>''' is the basic representation of a rigid [[VPhysics]] object. It is shared between the server, client and VPhysics libraries.

== Getting and setting ==

* If you just want to create a physics object for your entity's model, [[VPhysics#Programming|use a <code>VPhysicsInit*()</code> function]].
* An entity's main physics object can be accessed with <code>CBaseEntity::VPhysicsGetObject()</code>, while a list of all its objects is returned by <code>VPhysicsGetObjectList()</code>.
* New <code>IPhysicsObject</code>s can be created with the <code>[[IPhysicsEnvironment|physenv]]->Create*()</code> functions, or with the global <code>PhysModelCreate*()</code> helpers. {{note|Remember to call <code>physenv->DestroyObject()</code> when you no longer need these.}}

== Member functions ==

=== State ===

; <code>Wake()</code>
; <code>Sleep()</code>
: To improve performance physics objects will go to sleep after a second or so of inactivity. They will be woken by interaction with another object, but not by changes to their own internal state. ''If you change a simulation property of the object and want it to respond immediately, make sure that you <code>Wake()</code> it!''
; <code>GetCollide()</code>
: Gets this object's <code>[[CPhysCollide]]</code> (the actual geometry it represents).
; <code>BecomeTrigger()</code>
; <code>RemoveTrigger()</code>
: {{confirm|The object stops colliding with other objects, but still triggers <code>[[Touch()]]</code>?}}
; <code>EnableCollisions()</code>
; <code>EnableGravity()</code>
; <code>EnableDrag()</code>
; <code>EnableMotion()</code>
: Various simulation features that can be enabled or disabled per-object.

=== Properties ===

; <code>SetMass()</code>
; <code>SetInertia()</code>
: Overrides this object's mass (in kilos) and inertia ({{todo|units; it's a [[vector]]}}).
; <code>SetDamping()</code>
: {{confirm|Sets rotation damping (how fast the object stops spinning)}}
; <code>SetDragCoefficient()</code>
: Set friction. {{todo|Units}}
; <code>SetBuoyancyRatio()</code>
: Sets how much upward force is exerted on the object (relative to its mass) whenever it is in water. 0 means that the object sinks, while >1 results in the object bouncing off the surface with increasing violence.
: Source does not simulate water pressure, so genuine buoyancy is not possible.

=== Forces ===

; <code>ApplyForceCenter()</code>
; <code>ApplyForceOffset()</code>
: Applies a inch per second per kilogram force relative to the world. If you specify an offset the force comes from a specific location, otherwise it applies evenly across the whole object.
; <code>ApplyTorqueCenter()</code>
: Applies a degrees per second per kilogram ({{confirm}}) rotation relative to the world.
; <code>AddVelocity()</code>
; <code>SetVelocity()</code>
; <code>SetVelocityInstantaneous()</code>
: Adds or sets velocity (inch/s) and torque (degrees/s) in a physically incorrect way that affects the object regardless of its current mass/inertia.
; <code>SetPosition()</code>
; <code>SetPositionMatrix()</code>
: Teleports the object to a new location. {{todo|Impact of teleporting an object short distances every frame vs. letting it find its own way.}}

== Multiple IPhysicsObjects ==

An entity can represent up to 1024 <code>IPhysicsObject</code>s. This happens in Valve's code with vehicle wheels and whenever a model has [[$collisionjoints]] (the "must all be convex" limitation of which is imposed by studiomdl, not the engine).

{{note|Avoid simulating completely separate physics objects with one entity. Although VPhysics doesn't care one way or the other, game systems which use [[bounding box]]es will become very inefficient should the objects become far apart. You will also encounter problems with [[QPhysics]] velocity calculations when the "main" object is moving but others aren't (or vice versa). It's probably possible to work around all of these issues with the mod SDK, but only after a lot of work!}}

[[multi_phys|See multi_phys for an example entity that performs all of the jobs needed for multiple <code>IPhysicsObject</code>s.]]

[[Category:Physics]]
[[Category:Interfaces|P]]