HughPH.Box2D
Organised dotnet bindings for Box2D 3.1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Properties | List of all members
Box2D.Character_Movement.CollisionPlane Struct Reference

These are collision planes that can be fed to b2SolvePlanes. Normally this is assembled by the user from plane results in b2PlaneResult. More...

Collaboration diagram for Box2D.Character_Movement.CollisionPlane:
Collaboration graph
[legend]

Public Member Functions

 CollisionPlane (Plane plane, float pushLimit, float push, bool clipVelocity)
 Constructs a new CollisionPlane object with the given parameters.
 
 CollisionPlane ()
 Constructs a new CollisionPlane object with default values.
 

Public Attributes

Plane Plane
 The collision plane between the mover and some shape.
 
float PushLimit
 Setting this to float.System.Math.float.MaxValue makes the plane as rigid as possible. Lower values can make the plane collision soft. Usually in meters.
 
float Push
 The push on the mover determined by b2SolvePlanes. Usually in meters.
 

Properties

bool ClipVelocity [get, set]
 Indicates if b2ClipVector should clip against this plane. Should be false for soft collision.
 

Detailed Description

These are collision planes that can be fed to b2SolvePlanes. Normally this is assembled by the user from plane results in b2PlaneResult.

Constructor & Destructor Documentation

◆ CollisionPlane()

Box2D.Character_Movement.CollisionPlane.CollisionPlane ( Plane  plane,
float  pushLimit,
float  push,
bool  clipVelocity 
)
inline

Constructs a new CollisionPlane object with the given parameters.

Parameters
planeThe collision plane between the mover and some shape.
pushLimitThe plane rigidity. Setting this to float.System.Math.float.MaxValue makes the plane as rigid as possible. Lower values can make the plane collision soft. Usually in meters.
pushThe push on the mover determined by b2SolvePlanes. Usually in meters.
clipVelocityIndicates if Mover.ClipVector(in Vec2,Box2D.Character_Movement.CollisionPlane[]) should clip against this plane. Should be false for soft collision.

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