| Struct |
Description |
| CapsuleGeometry |
The geometry of a closed capsule which can be viewed as two semi-circles connected by a rectangle.
See PhysicsBody.CreateShape.
|
| ChainGeometry |
The geometry of a chain of ChainSegment.
|
| ChainSegmentGeometry |
The geometry of a chain line segment with one-sided collision which only collides on the "right" side.
Several of these are generated for a chain, connected as ghost1 -> point1 -> point2 -> ghost2.
|
| CircleGeometry |
The geometry of a closed circle.
See PhysicsBody.CreateShape.
|
| PhysicsAABB |
Represents a 2D axis-aligned bounding-box.
|
| PhysicsBody |
A body is contained within a world and has 3 degrees-of-freedom, two for position and one for rotation.
A body can have forces, torques and impulses applied to it.
A body has three distinct types:
Static: This type of body does not move under simulation and behaves as if it has infinite mass, essentially an immovable object. Static bodies never interact with other Static or Kinematic bodies.Dynamic: This type of body is fully simulated and moves according to forces and torques applied to its linear/angular velocities. It can interact with all other body types. It always has finite, non-zero mass.Kinematic: This type of body moves under simulation and moves according to its linear/angular velocities and never uses forces or torques. It only interacts with Dynamic body types. It behaves as if it has infinite mass. A body is automatically destroyed when the world it is in is destroyed. A body cannot exist outside a world.
|
| PhysicsBodyDefinition |
A PhysicsBody definition used to specify important initial properties.
|
| PhysicsCallbacks |
All callback interfaces and targets.
|
| PhysicsChain |
A dedicated shape that produces a chain of shapes connected together to produce a continuous surface.
Chain shapes provide a smooth, continuous surface that will not produce "ghost" collisions.
A PhysicsChain is automatically destroyed when the body it is in is destroyed. A PhysicsChain cannot exist unattached from a body.
This will produce shapes of type PhysicsShape.ShapeType.ChainSegment.
Chains are one-sided.A chain has no mass and should be used on static bodies.A chain can have a counter-clockwise winding order (normal points right of segment direction).A chain is either a loop or open.A chain must have at least 4 points.The distance between any two points must be greater than PhysicsWorld.linearSlop.A chain should not self intersect (this is not validated).An open chain has no collision on the first and final edge.You may overlap two open chains on their first three and/or last three points to get smooth collision. |
| PhysicsChainDefinition |
A PhysicsChain definition used to specify the chain of vertices that will produce multiple ChainSegmentGeometry shape types.
Additionally, non-geometric properties can be specified here.
|
| PhysicsComposer |
Provides the ability to compose geometry using specific operations on layers in a specific order.
|
| PhysicsConstants |
Contacts used by physics.
|
| PhysicsDestructor |
Provides the ability to destruct (fragment and Slice) geometry.
|
| PhysicsDistanceJoint |
Connects an anchor point on body A with an anchor point on body B via a line segment of a specified distance.
|
| PhysicsDistanceJointDefinition |
A joint definition used to specify properties when creating a PhysicsDistanceJoint.
|
| PhysicsEvents |
Various events that can be retrieved during and after the simulation has completed.
See PhysicsWorld.Simulate and PhysicsWorld.Simulate.
|
| PhysicsFixedJoint |
A joint to constrain a pair of bodies together rigidly.
This constraint provides springs to mimic soft-body simulation.
The approximate solver cannot always hold many bodies together completely rigidly.
|
| PhysicsFixedJointDefinition |
A joint definition used to specify properties when creating a PhysicsFixedJoint.
|
| PhysicsHingeJoint |
A joint where an anchor point on body B is fixed to an anchor point on body A.
This joint allows relative rotation.
|
| PhysicsHingeJointDefinition |
A joint definition used to specify properties when creating a PhysicsHingeJoint.
|
| PhysicsIgnoreJoint |
A joint used to ignore collision between two specific bodies.
As a side effect of being a joint, it also keeps the two bodies in the same simulation island meaning they'll wake/sleep at the same time and be solved together on the same thread.
|
| PhysicsIgnoreJointDefinition |
A joint definition used to specify properties when creating a PhysicsIgnoreJoint.
|
| PhysicsJoint |
A joint is used to constrain bodies to the world or to each other in various ways.
A joint is automatically destroyed when either body it is attached to is destroyed. A joint cannot exist unattached from a body.
|
| PhysicsLayers |
This provides a common method to retrieving layer information.
If a PhysicsCoreSettings2D asset is assigned then the full layers (PhysicsCoreSettings2D.physicsLayerNames) will be used if PhysicsCoreSettings2D.usePhysicsLayers is also active.
If no PhysicsCoreSettings2D asset is assigned then the global layers (See LayerMask) will be used.
|
| PhysicsMask |
A 64-bit mask, effectively 64 flags. The default enumerator will iterate all the bits that are set (1).
|
| PhysicsMath |
A set of mathematical operations that are useful for physics.
These operations do not form a fully comprehensive mathematics library, they simply provide operations that are usually required when interacting with physics.
|
| PhysicsPlane |
Represents a 2D plane.
|
| PhysicsQuery |
Various physics queries.
|
| PhysicsRelativeJoint |
A joint constraint used to control the relative movement two bodies while still being responsive to collisions.
A spring controls the position and rotation and velocity control allows for simulated friction such as seen in top-down games.
A typical usage is to control the movement of a dynamic body with respect to the ground.
|
| PhysicsRelativeJointDefinition |
A joint definition used to specify properties when creating a PhysicsRelativeJoint.
|
| PhysicsRotate |
Represents a 2D rotation.
|
| PhysicsShape |
A shape is attached to a body and defines an area to which two distinct types of behaviour are handled:
Collision: Contacts between shapes produce a collision response on their respective bodies, assuming their body type is Dynamic.Trigger: Contacts between shapes do not produce a collision response, only the fact that they're overlapping is reported. An unlimited number of shapes can be attached to a single body, known as a compound body.
A shape is automatically destroyed when the body it is attached to is destroyed. A shape cannot exist unattached from a body.
|
| PhysicsShapeDefinition |
A PhysicsShape definition used to specify important initial properties.
|
| PhysicsSliderJoint |
A joint that requires defining a line of motion defined by the local anchor A.
Body B may slide along the axis defined by the local anchor A.
Body B cannot rotate relative to body A.
The joint translation is zero when the local anchor origins coincide in world space.
The joint uses local anchors so that the initial configuration can violate the constraint slightly.
|
| PhysicsSliderJointDefinition |
A joint definition used to specify properties when creating a PhysicsSliderJoint.
|
| PhysicsTransform |
Represents a 2D transformation combining a translation and a PhysicsRotate.
|
| PhysicsUserData |
Custom user data.
The physics system doesn't use this data, it is entirely for custom use.
|
| PhysicsWheelJoint |
A joint that requires defining a line of motion using an axis and an anchor point.
The joint translation is zero when the local anchors coincide in world space.
The joint uses local anchors so that the initial configuration can violate the constraint slightly.
|
| PhysicsWheelJointDefinition |
A joint definition used to specify properties when creating a PhysicsWheelJoint.
|
| PhysicsWorld |
A world is a container for all other physics objects such as PhysicsBody, PhysicsShape, PhysicsJoint etc.
A world can be simulated in isolation from all other worlds.
The maximum number of worlds that can be created at one time is defined by PhysicsCoreSettings2D.maximumWorlds.
A world is completely isolated from all other worlds.
|
| PhysicsWorldDefinition |
A PhysicsWorld definition used to specify important initial properties.
|
| PolygonGeometry |
The geometry of a closed convex polygon. The geometry has a fixed maximum number of vertices as defined by the constant PhysicsConstants.MaxPolygonVertices.
Polygon regions that require a larger quantity of vertices or are concave are defined by multiple polygon geometry using the PhysicsComposer or the PolygonGeometry.CreatePolygons utility.
See PhysicsBody.CreateShape.
|
| SegmentGeometry |
The geometry of a line segment.
See PhysicsBody.CreateShape.
|