Box2D.Character_Movement.Plane Struct Reference

A plane in 2D space. More...

Public Member Functions
	Plane (Vec2 normal, float offset)
	Constructs a new Plane object with the given parameters.
	Plane ()
	Constructs a new Plane object with default values.

Public Attributes
Vec2	Normal
	The normal vector of the plane.
float	Offset
	The offset of the plane.

Properties
bool	Valid [get]
	Checks if the plane is valid.

Detailed Description

A plane in 2D space.

Constructor & Destructor Documentation

Plane()

Box2D.Character_Movement.Plane.Plane ( Vec2  normal, float  offset  )

inline

Constructs a new Plane object with the given parameters.

Parameters

normal	The normal vector of the plane.
offset	The offset of the plane.

Exceptions

ArgumentOutOfRangeException

Thrown when the normal vector is not a unit vector.

A plane is valid if its normal is a unit vector and it is not NaN or infinity.

Property Documentation

Valid

bool Box2D.Character_Movement.Plane.Valid

get

Checks if the plane is valid.

Returns

True if the plane is valid, false otherwise.

A plane is valid if its normal is a unit vector and it is not NaN or infinity.
This wraps b2IsValidPlane.

---

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

• src/Box2DBindings/Collision/Character Movement/Plane.cs