physx::PxPlane Class Reference

Representation of a plane. More...

#include <PxPlane.h>

Collaboration diagram for physx::PxPlane:

Public Member Functions
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane ()
	Constructor.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (float nx, float ny, float nz, float distance)
	Constructor from a normal and a distance.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (const PxVec3 &normal, float distance)
	Constructor from a normal and a distance.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (const PxVec3 &point, const PxVec3 &normal)
	Constructor from a point on the plane and a normal.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (const PxVec3 &p0, const PxVec3 &p1, const PxVec3 &p2)
	Constructor from three points.
PX_CUDA_CALLABLE PX_INLINE bool	operator== (const PxPlane &p) const
	returns true if the two planes are exactly equal
PX_CUDA_CALLABLE PX_FORCE_INLINE float	distance (const PxVec3 &p) const
PX_CUDA_CALLABLE PX_FORCE_INLINE bool	contains (const PxVec3 &p) const
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec3	project (const PxVec3 &p) const
	projects p into the plane
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec3	pointInPlane () const
	find an arbitrary point in the plane
PX_CUDA_CALLABLE PX_FORCE_INLINE void	normalize ()
	equivalent plane with unit normal
PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane	transform (const PxTransform &pose) const
	transform plane
PX_CUDA_CALLABLE PX_FORCE_INLINE PxPlane	inverseTransform (const PxTransform &pose) const
	inverse-transform plane
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane ()
	Constructor.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (float nx, float ny, float nz, float distance)
	Constructor from a normal and a distance.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (const PxVec3 &normal, float distance)
	Constructor from a normal and a distance.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (const PxVec3 &point, const PxVec3 &normal)
	Constructor from a point on the plane and a normal.
PX_CUDA_CALLABLE PX_FORCE_INLINE	PxPlane (const PxVec3 &p0, const PxVec3 &p1, const PxVec3 &p2)
	Constructor from three points.
PX_CUDA_CALLABLE PX_INLINE bool	operator== (const PxPlane &p) const
	returns true if the two planes are exactly equal
PX_CUDA_CALLABLE PX_FORCE_INLINE float	distance (const PxVec3 &p) const
PX_CUDA_CALLABLE PX_FORCE_INLINE bool	contains (const PxVec3 &p) const
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec3	project (const PxVec3 &p) const
	projects p into the plane
PX_CUDA_CALLABLE PX_FORCE_INLINE PxVec3	pointInPlane () const
	find an arbitrary point in the plane
PX_CUDA_CALLABLE PX_FORCE_INLINE void	normalize ()
	equivalent plane with unit normal

Public Attributes
PxVec3	n
	The normal to the plane.
float	d
	The distance from the origin.

Detailed Description

Representation of a plane.

Plane equation used: n.dot(v) + d = 0

---

The documentation for this class was generated from the following files:

• RavEngine/deps/physx/physx/include/foundation/PxPlane.h
• RavEngine/deps/physx/pxshared/include/foundation/PxPlane.h