VIPRA::f3d Struct Reference

Public Member Functions
F3D_FUNC	f3d (VIPRA::f_pnt valX) noexcept
F3D_FUNC	f3d (VIPRA::f_pnt valX, VIPRA::f_pnt valY) noexcept
F3D_FUNC	f3d (VIPRA::f_pnt valX, VIPRA::f_pnt valY, VIPRA::f_pnt valZ) noexcept
F3D_FUNC	f3d (f3d const &other) noexcept=default
F3D_FUNC	f3d (f3d &&other) noexcept=default
F3D_FUNC_W_DISCARD auto	operator= (f3d const &other) noexcept -> f3d &=default
F3D_FUNC_W_DISCARD auto	operator= (f3d &&other) noexcept -> f3d &=default
	__attribute__ ((always_inline)) static auto random(VIPRA
template<F3D_IDX idx_t>
F3D_FUNC auto	operator[] (idx_t index) const -> VIPRA::f_pnt
template<Concepts::Numeric data_t>
F3D_FUNC auto	operator* (data_t &&multiplier) const noexcept -> f3d
template<Concepts::Numeric data_t>
F3D_FUNC_W_DISCARD auto	operator*= (data_t &&multiplier) noexcept -> f3d &
template<Concepts::Numeric data_t>
F3D_FUNC auto	operator/ (data_t &&divisor) const noexcept -> f3d
template<Concepts::Numeric data_t>
F3D_FUNC_W_DISCARD auto	operator/= (data_t &&divisor) noexcept -> f3d &
F3D_FUNC auto	operator- (f3d const &other) const noexcept -> f3d
F3D_FUNC auto	operator- (f3d &&other) const noexcept -> f3d
F3D_FUNC auto	operator+ (f3d const &other) const noexcept -> f3d
F3D_FUNC auto	operator+ (f3d &&other) const noexcept -> f3d
F3D_FUNC_W_DISCARD auto	operator+= (f3d const &other) noexcept -> f3d &
F3D_FUNC_W_DISCARD auto	operator+= (f3d &&other) noexcept -> f3d &
F3D_FUNC_W_DISCARD auto	operator-= (f3d const &other) noexcept -> f3d &
F3D_FUNC_W_DISCARD auto	operator-= (f3d &&other) noexcept -> f3d &
F3D_FUNC auto	distance_to_sqrd (f3d const &other) const noexcept -> VIPRA::f_pnt
F3D_FUNC auto	distance_to (f3d const &other) const -> VIPRA::f_pnt
F3D_FUNC auto	distance_to (f3d &&other) const -> VIPRA::f_pnt
F3D_FUNC auto	operator== (f3d const &other) const noexcept -> bool
F3D_FUNC auto	operator== (f3d &&other) const noexcept -> bool
F3D_FUNC auto	operator!= (f3d const &other) const noexcept -> bool
F3D_FUNC auto	operator!= (f3d &&other) const noexcept -> bool
F3D_FUNC auto	operator- () const noexcept -> f3d
F3D_FUNC auto	unit () const noexcept -> f3d
	Returns the unit vector in the direction of the f3d.
F3D_FUNC auto	mag_sqrd () const noexcept -> VIPRA::f_pnt
	Returns vector magnitude^2.
F3D_FUNC auto	mag () const noexcept -> VIPRA::f_pnt
	Returns the vectors magnitude.
F3D_FUNC auto	dot (f3d const &other) const noexcept -> VIPRA::f_pnt
	Returns the dot product between two f3ds.
F3D_FUNC auto	cross (f3d const &other) const noexcept -> f3d
	Returns the cross product between two f3ds.
VIPRA_INLINE auto	to_string () const -> std::string
	Returns the string representation of the f3d.

Public Attributes
VIPRA::f_pnt	x
VIPRA::f_pnt	y
VIPRA::f_pnt	z

Member Function Documentation

cross()

F3D_FUNC auto VIPRA::f3d::cross ( f3d const & other ) const -> f3d

inlinenoexcept

Returns the cross product between two f3ds.

Parameters

other

Returns

f3d

dot()

F3D_FUNC auto VIPRA::f3d::dot ( f3d const & other ) const -> VIPRA::f_pnt

inlinenoexcept

Returns the dot product between two f3ds.

Parameters

other

:

Returns

constexpr VIPRA::f_pnt

mag()

F3D_FUNC auto VIPRA::f3d::mag ( ) const -> VIPRA::f_pnt

inlinenoexcept

Returns the vectors magnitude.

Returns

constexpr VIPRA::f_pnt

mag_sqrd()

F3D_FUNC auto VIPRA::f3d::mag_sqrd ( ) const -> VIPRA::f_pnt

inlinenoexcept

Returns vector magnitude^2.

Returns

constexpr VIPRA::f_pnt

to_string()

VIPRA_INLINE auto VIPRA::f3d::to_string ( ) const -> std::string

inlinenodiscard

Returns the string representation of the f3d.

Returns

std::string

unit()

F3D_FUNC auto VIPRA::f3d::unit ( ) const -> f3d

inlinenoexcept

Returns the unit vector in the direction of the f3d.

Returns

constexpr f3d

---

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

• include/vipra/geometry/f3d.hpp