Loading...
Searching...
No Matches
Public Types |
Public Member Functions |
Static Public Member Functions |
Static Public Attributes |
List of all members
sbx::math::basic_vector3< Type > Class Template Reference
Inheritance diagram for sbx::math::basic_vector3< Type >:
Public Types | |
| using | value_type = base_type::value_type |
| using | reference = base_type::reference |
| using | const_reference = base_type::const_reference |
| using | size_type = base_type::size_type |
| using | length_type = base_type::length_type |
 Public Types inherited from sbx::math::basic_vector< 3u, Type > | |
| using | value_type = Type |
| using | reference = value_type & |
| using | const_reference = const value_type & |
| using | size_type = std::size_t |
| using | length_type = std::float_t |
Public Member Functions | |
| constexpr | basic_vector3 (const base_type &base) noexcept |
| template<scalar X, scalar Y, scalar Z> | |
| constexpr | basic_vector3 (X x, Y y, Z z) noexcept |
| template<scalar Other, scalar Scalar = Other> | |
| constexpr | basic_vector3 (const basic_vector2< Other > &vector, Scalar z=Scalar{0}) noexcept |
| constexpr | operator basic_vector2< Type > () const noexcept |
| constexpr auto | x () noexcept -> reference |
| constexpr auto | x () const noexcept -> const_reference |
| constexpr auto | y () noexcept -> reference |
| constexpr auto | y () const noexcept -> const_reference |
| constexpr auto | z () noexcept -> reference |
| constexpr auto | z () const noexcept -> const_reference |
| constexpr auto | normalize () noexcept -> basic_vector3 & |
| Public Member Functions inherited from sbx::math::basic_vector< 3u, Type > | |
| constexpr | basic_vector (Other value=Other{0}) noexcept |
| Constructs a vector with all components initialized to a value. More... | |
| constexpr | basic_vector (const basic_vector< Size, Other > &other) noexcept |
| Constructs a vector from another vector with convertible scalar type. More... | |
| constexpr | basic_vector (const basic_vector &other) noexcept=default |
| constexpr | basic_vector (basic_vector &&other) noexcept=default |
| auto | operator= (const basic_vector &other) noexcept -> basic_vector &=default |
| auto | operator= (basic_vector &&other) noexcept -> basic_vector &=default |
| constexpr auto | data () noexcept -> value_type * |
| Returns a pointer to the underlying contiguous storage. More... | |
| constexpr auto | data () const noexcept -> const value_type * |
| Returns a pointer to the underlying contiguous storage (const). More... | |
| constexpr auto | operator[] (size_type index) noexcept -> reference |
| Accesses a component by index. More... | |
| constexpr auto | operator[] (size_type index) const noexcept -> const_reference |
| Accesses a component by index (const). More... | |
| constexpr auto | operator+= (const basic_vector< Size, Other > &other) noexcept -> basic_vector & |
| Adds another vector to this vector. More... | |
| constexpr auto | operator-= (const basic_vector< Size, Other > &other) noexcept -> basic_vector & |
| Subtracts another vector from this vector. More... | |
| constexpr auto | operator*= (Other scalar) noexcept -> basic_vector & |
| Multiplies this vector by a scalar. More... | |
| constexpr auto | operator*= (const basic_vector< Size, Other > &other) noexcept -> basic_vector & |
| Multiplies this vector component-wise by another vector. More... | |
| constexpr auto | operator/= (Other scalar) noexcept -> basic_vector & |
| Divides this vector by a scalar. More... | |
| constexpr auto | length_squared () const noexcept -> length_type |
| Returns the squared length of the vector. More... | |
| constexpr auto | length () const noexcept -> length_type |
| Returns the length of the vector. More... | |
| constexpr auto | normalize () noexcept -> basic_vector & |
| Normalizes the vector in-place. More... | |
Static Public Member Functions | |
| static constexpr auto | cross (const basic_vector3 &lhs, const basic_vector3 &rhs) noexcept -> basic_vector3 |
| static constexpr auto | dot (const basic_vector3 &lhs, const basic_vector3 &rhs) noexcept -> length_type |
| static constexpr auto | normalized (const basic_vector3 &vector) noexcept -> basic_vector3 |
| static constexpr auto | reflect (const basic_vector3 &vector, const basic_vector3 &normal) noexcept -> basic_vector3 |
| static constexpr auto | distance_squared (const basic_vector3 &lhs, const basic_vector3 &rhs) noexcept -> value_type |
| static constexpr auto | distance (const basic_vector3 &lhs, const basic_vector3 &rhs) noexcept -> value_type |
| static constexpr auto | orthogonal (const basic_vector3 &vector) noexcept -> basic_vector3 |
| static constexpr auto | splat_x (const basic_vector3 &vector) noexcept -> basic_vector3 |
| static constexpr auto | splat_y (const basic_vector3 &vector) noexcept -> basic_vector3 |
| static constexpr auto | splat_z (const basic_vector3 &vector) noexcept -> basic_vector3 |
| Static Public Member Functions inherited from sbx::math::basic_vector< 3u, Type > | |
| static constexpr auto | min (const basic_vector &vector) noexcept -> value_type |
| Returns the minimum component of a vector. More... | |
| static constexpr auto | min (const basic_vector< Size, Lhs > &lhs, const basic_vector< Size, Rhs > &rhs) noexcept -> basic_vector |
| Returns the component-wise minimum of two vectors. More... | |
| static constexpr auto | max (const basic_vector &vector) noexcept -> value_type |
| Returns the maximum component of a vector. More... | |
| static constexpr auto | max (const basic_vector< Size, Lhs > &lhs, const basic_vector< Size, Rhs > &rhs) noexcept -> basic_vector |
| Returns the component-wise maximum of two vectors. More... | |
| static constexpr auto | abs (const basic_vector< Size, Lhs > &vector) noexcept -> basic_vector |
| Returns the component-wise absolute value of a vector. More... | |
| static constexpr auto | splat (const basic_vector< Size, Other > &vector) noexcept -> basic_vector< Size, Other > |
| Splat a single component across all axes. More... | |
| static constexpr auto | lerp (const basic_vector &x, const basic_vector &y, const value_type a) noexcept -> basic_vector |
| Linearly interpolates between two vectors. More... | |
Static Public Attributes | |
| static constexpr basic_vector3 | zero {base_type::fill(value_type{0})} |
| static constexpr basic_vector3 | one {base_type::fill(value_type{1})} |
| static constexpr basic_vector3 | right {base_type::template axis<x_axis>(value_type{1})} |
| static constexpr basic_vector3 | left {base_type::template axis<x_axis>(value_type{-1})} |
| static constexpr basic_vector3 | up {base_type::template axis<y_axis>(value_type{1})} |
| static constexpr basic_vector3 | down {base_type::template axis<y_axis>(value_type{-1})} |
| static constexpr basic_vector3 | forward {base_type::template axis<z_axis>(value_type{-1})} |
| static constexpr basic_vector3 | backward {base_type::template axis<z_axis>(value_type{1})} |
Additional Inherited Members | |
| Protected Member Functions inherited from sbx::math::basic_vector< 3u, Type > | |
| constexpr | basic_vector (Args &&... args) noexcept |
| constexpr | basic_vector (std::array< value_type, Size > &&components) noexcept |
| Static Protected Member Functions inherited from sbx::math::basic_vector< 3u, Type > | |
| static constexpr auto | fill (Other value) noexcept -> basic_vector |
| static constexpr auto | axis (Other value) noexcept -> basic_vector |
The documentation for this class was generated from the following files:
- libsbx-math/libsbx/math/vector3.hpp
- libsbx-math/libsbx/math/vector3.ipp
