SuperDex Physics C++ API
Loading...
Searching...
No Matches
superdex::Plane Class Referencefinal

#include <plane.h>

Public Member Functions

real GetDistanceFromOrigin () const
Real3 GetNormal () const
bool operator!= (Plane const &other) const =default
bool operator== (Plane const &other) const =default
 Plane ()=default
 Plane (Real3 const &normal, real distFromOrigin)
 Plane (Vec4r normal, real distFromOrigin)
Vec4r VGetNormal () const
Vec4r VGetPacked () const

Public Attributes

real distance = {0_r}
 Signed distance from the origin along the normal [m].
Real3 normal = {0_r, 1_r, 0_r}
 Outward-facing plane normal (unit length).

Detailed Description

Definition at line 34 of file plane.h.

Constructor & Destructor Documentation

◆ Plane() [1/3]

superdex::Plane::Plane ( )
inlinedefault

◆ Plane() [2/3]

superdex::Plane::Plane ( Vec4r normal,
real distFromOrigin )
inline

Definition at line 40 of file plane.h.

◆ Plane() [3/3]

superdex::Plane::Plane ( Real3 const & normal,
real distFromOrigin )
inline

Definition at line 42 of file plane.h.

Member Function Documentation

◆ GetDistanceFromOrigin()

real superdex::Plane::GetDistanceFromOrigin ( ) const
inlinenodiscard

Definition at line 49 of file plane.h.

◆ GetNormal()

Real3 superdex::Plane::GetNormal ( ) const
inlinenodiscard

Definition at line 45 of file plane.h.

◆ operator!=()

bool superdex::Plane::operator!= ( Plane const & other) const
default

◆ operator==()

bool superdex::Plane::operator== ( Plane const & other) const
default

◆ VGetNormal()

Vec4r superdex::Plane::VGetNormal ( ) const
inlinenodiscard

Definition at line 57 of file plane.h.

◆ VGetPacked()

Vec4r superdex::Plane::VGetPacked ( ) const
inlinenodiscard

Definition at line 53 of file plane.h.

Member Data Documentation

◆ distance

real superdex::Plane::distance = {0_r}

Signed distance from the origin along the normal [m].

Definition at line 37 of file plane.h.

◆ normal

Real3 superdex::Plane::normal = {0_r, 1_r, 0_r}

Outward-facing plane normal (unit length).

Definition at line 36 of file plane.h.


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