impeller::Vector3 Struct Reference

#include <vector.h>

Public Member Functions
constexpr	Vector3 ()
constexpr	Vector3 (const Color &c)
constexpr	Vector3 (const Point &p)
constexpr	Vector3 (const Size &s)
constexpr	Vector3 (Scalar x, Scalar y)
constexpr	Vector3 (Scalar x, Scalar y, Scalar z)
constexpr Scalar	Length () const
constexpr Vector3	Normalize () const
constexpr Scalar	Dot (const Vector3 &other) const
constexpr Vector3	Abs () const
constexpr Vector3	Cross (const Vector3 &other) const
constexpr Vector3	Min (const Vector3 &p) const
constexpr Vector3	Max (const Vector3 &p) const
constexpr Vector3	Floor () const
constexpr Vector3	Ceil () const
constexpr Vector3	Round () const
constexpr bool	operator== (const Vector3 &v) const
constexpr bool	operator!= (const Vector3 &v) const
constexpr Vector3	operator+= (const Vector3 &p)
constexpr Vector3	operator-= (const Vector3 &p)
constexpr Vector3	operator*= (const Vector3 &p)
template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>
constexpr Vector3	operator*= (U scale)
constexpr Vector3	operator/= (const Vector3 &p)
template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>
constexpr Vector3	operator/= (U scale)
constexpr Vector3	operator- () const
constexpr Vector3	operator+ (const Vector3 &v) const
constexpr Vector3	operator- (const Vector3 &v) const
constexpr Vector3	operator+ (Scalar s) const
constexpr Vector3	operator- (Scalar s) const
constexpr Vector3	operator* (const Vector3 &v) const
template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>
constexpr Vector3	operator* (U scale) const
constexpr Vector3	operator/ (const Vector3 &v) const
template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>
constexpr Vector3	operator/ (U scale) const
constexpr Vector3	Lerp (const Vector3 &v, Scalar t) const
std::string	ToString () const

Static Public Member Functions
static constexpr Vector3	Combine (const Vector3 &a, Scalar aScale, const Vector3 &b, Scalar bScale)

Public Attributes
union {
struct {
Scalar   x = 0.0f
Scalar   y = 0.0f
Scalar   z = 0.0f
}
Scalar   e [3]
};

Detailed Description

Definition at line 20 of file vector.h.

Constructor & Destructor Documentation

Vector3() [1/6]

constexpr impeller::Vector3::Vector3 ( )

inlineconstexpr

Definition at line 30 of file vector.h.

{};

Vector3() [2/6]

constexpr impeller::Vector3::Vector3 ( const Color &  c )

inlineconstexpr

Definition at line 32 of file vector.h.

: x(c.red), y(c.green), z(c.blue) {}

Vector3() [3/6]

constexpr impeller::Vector3::Vector3 ( const Point &  p )

inlineconstexpr

Definition at line 34 of file vector.h.

: x(p.x), y(p.y) {}

Vector3() [4/6]

constexpr impeller::Vector3::Vector3 ( const Size &  s )

inlineconstexpr

Definition at line 36 of file vector.h.

: x(s.width), y(s.height) {}

Vector3() [5/6]

constexpr impeller::Vector3::Vector3 ( Scalar  x, Scalar  y  )

inlineconstexpr

Definition at line 38 of file vector.h.

: x(x), y(y) {}

Vector3() [6/6]

constexpr impeller::Vector3::Vector3 ( Scalar  x, Scalar  y, Scalar  z  )

inlineconstexpr

Definition at line 40 of file vector.h.

: x(x), y(y), z(z) {}

Member Function Documentation

Abs()

constexpr Vector3 impeller::Vector3::Abs ( ) const

inlineconstexpr

Definition at line 58 of file vector.h.

                                {
    return {std::fabs(x), std::fabs(y), std::fabs(z)};
  }

Ceil()

constexpr Vector3 impeller::Vector3::Ceil ( ) const

inlineconstexpr

Definition at line 82 of file vector.h.

                                 {
    return {std::ceil(x), std::ceil(y), std::ceil(z)};
  }

Combine()

static constexpr Vector3 impeller::Vector3::Combine ( const Vector3 &  a, Scalar  aScale, const Vector3 &  b, Scalar  bScale  )

inlinestaticconstexpr

Make a linear combination of two vectors and return the result.

Parameters

a	the first vector.
aScale	the scale to use for the first vector.
b	the second vector.
bScale	the scale to use for the second vector.

Returns

the combined vector.

Definition at line 192 of file vector.h.

                                                  {
    return {
        aScale * a.x + bScale * b.x,  //
        aScale * a.y + bScale * b.y,  //
        aScale * a.z + bScale * b.z,  //
    };
  }

Cross()

constexpr Vector3 impeller::Vector3::Cross ( const Vector3 &  other ) const

inlineconstexpr

Definition at line 62 of file vector.h.

                                                      {
    return {
        (y * other.z) - (z * other.y),  //
        (z * other.x) - (x * other.z),  //
        (x * other.y) - (y * other.x)   //
    };
  }

Dot()

constexpr Scalar impeller::Vector3::Dot ( const Vector3 &  other ) const

inlineconstexpr

Definition at line 54 of file vector.h.

                                                   {
    return ((x * other.x) + (y * other.y) + (z * other.z));
  }

Floor()

constexpr Vector3 impeller::Vector3::Floor ( ) const

inlineconstexpr

Definition at line 78 of file vector.h.

                                  {
    return {std::floor(x), std::floor(y), std::floor(z)};
  }

Length()

constexpr Scalar impeller::Vector3::Length ( ) const

inlineconstexpr

The length (or magnitude of the vector).

Returns

the calculated length.

Definition at line 47 of file vector.h.

{ return sqrt(x * x + y * y + z * z); }

Lerp()

constexpr Vector3 impeller::Vector3::Lerp ( const Vector3 &  v, Scalar  t  ) const

inlineconstexpr

Definition at line 178 of file vector.h.

                                                           {
    return *this + (v - *this) * t;
  }

Max()

constexpr Vector3 impeller::Vector3::Max ( const Vector3 &  p ) const

inlineconstexpr

Definition at line 74 of file vector.h.

                                                {
    return {std::max(x, p.x), std::max(y, p.y), std::max(z, p.z)};
  }

Min()

constexpr Vector3 impeller::Vector3::Min ( const Vector3 &  p ) const

inlineconstexpr

Definition at line 70 of file vector.h.

                                                {
    return {std::min(x, p.x), std::min(y, p.y), std::min(z, p.z)};
  }

Normalize()

constexpr Vector3 impeller::Vector3::Normalize ( ) const

inlineconstexpr

Definition at line 49 of file vector.h.

                                      {
    const auto len = Length();
    return {x / len, y / len, z / len};
  }

operator!=()

constexpr bool impeller::Vector3::operator!= ( const Vector3 &  v ) const

inlineconstexpr

Definition at line 94 of file vector.h.

                                                    {
    return v.x != x || v.y != y || v.z != z;
  }

operator*() [1/2]

constexpr Vector3 impeller::Vector3::operator* ( const Vector3 &  v ) const

inlineconstexpr

Definition at line 160 of file vector.h.

                                                      {
    return Vector3(x * v.x, y * v.y, z * v.z);
  }

operator*() [2/2]

template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>

constexpr Vector3 impeller::Vector3::operator* ( U  scale ) const

inlineconstexpr

Definition at line 165 of file vector.h.

                                             {
    return Vector3(x * scale, y * scale, z * scale);
  }

operator*=() [1/2]

constexpr Vector3 impeller::Vector3::operator*= ( const Vector3 &  p )

inlineconstexpr

Definition at line 112 of file vector.h.

                                                 {
    x *= p.x;
    y *= p.y;
    z *= p.z;
    return *this;
  }

operator*=() [2/2]

template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>

constexpr Vector3 impeller::Vector3::operator*= ( U  scale )

inlineconstexpr

Definition at line 120 of file vector.h.

                                        {
    x *= scale;
    y *= scale;
    z *= scale;
    return *this;
  }

operator+() [1/2]

constexpr Vector3 impeller::Vector3::operator+ ( const Vector3 &  v ) const

inlineconstexpr

Definition at line 144 of file vector.h.

                                                      {
    return Vector3(x + v.x, y + v.y, z + v.z);
  }

operator+() [2/2]

constexpr Vector3 impeller::Vector3::operator+ ( Scalar  s ) const

inlineconstexpr

Definition at line 152 of file vector.h.

                                              {
    return Vector3(x + s, y + s, z + s);
  }

operator+=()

constexpr Vector3 impeller::Vector3::operator+= ( const Vector3 &  p )

inlineconstexpr

Definition at line 98 of file vector.h.

                                                 {
    x += p.x;
    y += p.y;
    z += p.z;
    return *this;
  }

operator-() [1/3]

constexpr Vector3 impeller::Vector3::operator- ( ) const

inlineconstexpr

Definition at line 142 of file vector.h.

{ return Vector3(-x, -y, -z); }

operator-() [2/3]

constexpr Vector3 impeller::Vector3::operator- ( const Vector3 &  v ) const

inlineconstexpr

Definition at line 148 of file vector.h.

                                                      {
    return Vector3(x - v.x, y - v.y, z - v.z);
  }

operator-() [3/3]

constexpr Vector3 impeller::Vector3::operator- ( Scalar  s ) const

inlineconstexpr

Definition at line 156 of file vector.h.

                                              {
    return Vector3(x - s, y - s, z - s);
  }

operator-=()

constexpr Vector3 impeller::Vector3::operator-= ( const Vector3 &  p )

inlineconstexpr

Definition at line 105 of file vector.h.

                                                 {
    x -= p.x;
    y -= p.y;
    z -= p.z;
    return *this;
  }

operator/() [1/2]

constexpr Vector3 impeller::Vector3::operator/ ( const Vector3 &  v ) const

inlineconstexpr

Definition at line 169 of file vector.h.

                                                      {
    return Vector3(x / v.x, y / v.y, z / v.z);
  }

operator/() [2/2]

template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>

constexpr Vector3 impeller::Vector3::operator/ ( U  scale ) const

inlineconstexpr

Definition at line 174 of file vector.h.

                                             {
    return Vector3(x / scale, y / scale, z / scale);
  }

operator/=() [1/2]

constexpr Vector3 impeller::Vector3::operator/= ( const Vector3 &  p )

inlineconstexpr

Definition at line 127 of file vector.h.

                                                 {
    x /= p.x;
    y /= p.y;
    z /= p.z;
    return *this;
  }

operator/=() [2/2]

template<class U , class = std::enable_if_t<std::is_arithmetic_v<U>>>

constexpr Vector3 impeller::Vector3::operator/= ( U  scale )

inlineconstexpr

Definition at line 135 of file vector.h.

                                        {
    x /= scale;
    y /= scale;
    z /= scale;
    return *this;
  }

operator==()

constexpr bool impeller::Vector3::operator== ( const Vector3 &  v ) const

inlineconstexpr

Definition at line 90 of file vector.h.

                                                    {
    return v.x == x && v.y == y && v.z == z;
  }

Round()

constexpr Vector3 impeller::Vector3::Round ( ) const

inlineconstexpr

Definition at line 86 of file vector.h.

                                  {
    return {std::round(x), std::round(y), std::round(z)};
  }

ToString()

std::string impeller::Vector3::ToString

(

)

const

Definition at line 10 of file vector.cc.

                                  {
  std::stringstream stream;
  stream << "{" << x << ", " << y << ", " << z << "}";
  return stream.str();
}

Member Data Documentation

[union]

union { ... } impeller::Vector3

e

Scalar impeller::Vector3::e[3]

Definition at line 27 of file vector.h.

x

Scalar impeller::Vector3::x = 0.0f

Definition at line 23 of file vector.h.

y

Scalar impeller::Vector3::y = 0.0f

Definition at line 24 of file vector.h.

z

Scalar impeller::Vector3::z = 0.0f

Definition at line 25 of file vector.h.

---

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

• impeller/geometry/vector.h
• impeller/geometry/vector.cc