sbx::math::basic_vector2< Type > Class Template Reference

A vector in two-dimensional space. More...

#include <vector2.hpp>

Inheritance diagram for sbx::math::basic_vector2< 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< 2u, 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_vector2 (const base_type &base) noexcept
template<scalar Other>
constexpr	basic_vector2 (Other x, Other y) 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
Public Member Functions inherited from sbx::math::basic_vector< 2u, Type >
constexpr	basic_vector (Other value=Other{0}) noexcept
constexpr	basic_vector (const basic_vector< Size, Other > &other) noexcept
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 *
constexpr auto	operator[] (size_type index) noexcept -> reference
constexpr auto	operator[] (size_type index) const noexcept -> const_reference
constexpr auto	operator+= (const basic_vector< Size, Other > &other) noexcept -> basic_vector &
constexpr auto	operator-= (const basic_vector< Size, Other > &other) noexcept -> basic_vector &
constexpr auto	operator*= (Other scalar) noexcept -> basic_vector &
constexpr auto	operator*= (const basic_vector< Size, Other > &other) noexcept -> basic_vector &
constexpr auto	operator/= (Other scalar) noexcept -> basic_vector &
constexpr auto	length_squared () const noexcept -> length_type
constexpr auto	length () const noexcept -> length_type
constexpr auto	normalize () noexcept -> basic_vector &

Static Public Member Functions
static constexpr auto	dot (const basic_vector2 &lhs, const basic_vector2 &rhs) noexcept -> length_type
static constexpr auto	normalized (const basic_vector2 &vector) noexcept -> basic_vector2
static constexpr auto	orthogonal (const basic_vector2 &vector) noexcept -> basic_vector2
static constexpr auto	determinant (const basic_vector2 &lhs, const basic_vector2 &rhs) noexcept -> value_type
static constexpr auto	distance (const basic_vector2 &lhs, const basic_vector2 &rhs) noexcept -> value_type
Static Public Member Functions inherited from sbx::math::basic_vector< 2u, Type >
static constexpr auto	min (const basic_vector< Size, Lhs > &lhs, const basic_vector< Size, Rhs > &rhs) noexcept -> basic_vector
static constexpr auto	max (const basic_vector< Size, Lhs > &lhs, const basic_vector< Size, Rhs > &rhs) noexcept -> basic_vector
static constexpr auto	abs (const basic_vector< Size, Lhs > &vector) noexcept -> basic_vector
static constexpr auto	splat (const basic_vector< Size, Other > &vector) noexcept -> basic_vector< Size, Other >
static constexpr auto	lerp (const basic_vector &x, const basic_vector &y, const value_type a) noexcept -> basic_vector

Static Public Attributes
static constexpr basic_vector2	zero {base_type::fill(value_type{0})}
static constexpr basic_vector2	one {base_type::fill(value_type{1})}

Additional Inherited Members
Protected Member Functions inherited from sbx::math::basic_vector< 2u, 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< 2u, Type >
static constexpr auto	fill (Other value) noexcept -> basic_vector
static constexpr auto	axis (Other value) noexcept -> basic_vector

Detailed Description

template<scalar Type>
class sbx::math::basic_vector2< Type >

A vector in two-dimensional space.

Template Parameters

Type	The type of the vectors components.

---

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

• libsbx-math/libsbx/math/vector2.hpp
• libsbx-math/libsbx/math/vector2.ipp