Euphoria
Public Member Functions | List of all members
eu::n3 Struct Reference

a 3d unit (vector) More...

Inheritance diagram for eu::n3:
eu::v3

Public Member Functions

constexpr n3 operator- () const
 
constexpr bool is_valid () const
 returns false if the length isn't 1
 
bool operator== (const n3 &rhs)=delete
 
constexpr n3 (float a, float b, float c)
 asserts that the length is 1
 
constexpr n3 (const v3 &v)
 asserts that the length is 1
 
- Public Member Functions inherited from eu::v3
 v3 (float a)
 
 v3 (const std::tuple< float, float, float > &a)
 
constexpr v3 (float ax, float ay, float az)
 
 v3 (const float *a)
 assumes the given pointer is a array of 3 floats
 
float dot (const v3 &rhs) const
 
v3 cross (const v3 &u) const
 
void operator+= (const v3 &rhs)
 
void operator-= (const v3 &rhs)
 
void operator/= (float rhs)
 
void operator*= (float rhs)
 
v3 operator- () const
 
floatget_data_ptr ()
 Returns an array to the data.
 
const floatget_data_ptr () const
 Returns an array to the data.
 
constexpr float get_length_squared () const
 Returns the squared length of the vector.
 
float get_length () const
 Returns the length of the vector.
 
bool normalize ()
 Changes the length to 1.
 
std::optional< n3get_normalized () const
 Returns a unit vector.
 
bool operator== (const v3 &rhs)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from eu::v3
static v3 from_to (const v3 &from, const v3 &to)
 creates a vector going from from to to
 
static v3 from_localspace_rui (const Q &rotation, float right, float up, float in)
 Creates a vector in quaterion local space from Right Up In.
 
- Public Attributes inherited from eu::v3
float x
 
float y
 
float z
 

Detailed Description

a 3d unit (vector)

Definition at line 91 of file vec3.h.

Constructor & Destructor Documentation

◆ n3() [1/2]

constexpr eu::n3::n3 ( float  a,
float  b,
float  c 
)
inlineconstexpr

asserts that the length is 1

Definition at line 108 of file vec3.h.

◆ n3() [2/2]

constexpr eu::n3::n3 ( const v3 v)
inlineexplicitconstexpr

asserts that the length is 1

Definition at line 115 of file vec3.h.

Member Function Documentation

◆ is_valid()

constexpr bool eu::n3::is_valid ( ) const
inlineconstexpr

returns false if the length isn't 1

Definition at line 100 of file vec3.h.

◆ operator-()

constexpr n3 eu::n3::operator- ( ) const
inlineconstexpr

Definition at line 93 of file vec3.h.

◆ operator==()

bool eu::n3::operator== ( const n3 rhs)
delete

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