Harlinn::Math::Segment< T, N > Struct Template Reference

#include <Segment.h>

Collaboration diagram for Harlinn::Math::Segment< T, N >:

Public Types
using	Point = Math::Point<T, N>
using	Vector = Math::Vector<T, N>
using	ArrayType = Point::ArrayType
using	Simd = SegmentSimd<T, N>
using	value_type = T
using	PointDistanceResult = typename Simd::PointDistanceResult

Public Member Functions
	Segment () noexcept
	Segment (const std::array< Point, 2 > &pts) noexcept
	Segment (const Point &p1, const Point &p2) noexcept
	Segment (const Simd &simd) noexcept
Simd	ToSimd () const noexcept
void	Assign (const Point &center, const Vector &direction, value_type extent) noexcept
void	Extract (Point &center, Vector &direction, value_type &extent) const noexcept
template<PointOrPointSimdType PT> requires ( PT::Size == N )
PointDistanceResult	Distance (const PT &point) const noexcept
	Retrieves the closest point and distance from point to the segment.

Public Attributes
std::array< Point, 2 >	points

Static Public Attributes
static constexpr value_type	Zero = static_cast< value_type >( 0 )
static constexpr value_type	One = static_cast< value_type >( 1 )
static constexpr value_type	Half = static_cast< value_type >( .5 )

Member Typedef Documentation

ArrayType

template<FloatingPointType T, size_t N>

using Harlinn::Math::Segment< T, N >::ArrayType = Point::ArrayType

Point

template<FloatingPointType T, size_t N>

using Harlinn::Math::Segment< T, N >::Point = Math::Point<T, N>

PointDistanceResult

template<FloatingPointType T, size_t N>

using Harlinn::Math::Segment< T, N >::PointDistanceResult = typename Simd::PointDistanceResult

Simd

template<FloatingPointType T, size_t N>

using Harlinn::Math::Segment< T, N >::Simd = SegmentSimd<T, N>

value_type

template<FloatingPointType T, size_t N>

using Harlinn::Math::Segment< T, N >::value_type = T

Vector

template<FloatingPointType T, size_t N>

using Harlinn::Math::Segment< T, N >::Vector = Math::Vector<T, N>

Constructor & Destructor Documentation

Segment() [1/4]

template<FloatingPointType T, size_t N>

Harlinn::Math::Segment< T, N >::Segment ( )

inlinenoexcept

Segment() [2/4]

template<FloatingPointType T, size_t N>

Harlinn::Math::Segment< T, N >::Segment ( const std::array< Point, 2 > & pts )

inlinenoexcept

Segment() [3/4]

template<FloatingPointType T, size_t N>

Harlinn::Math::Segment< T, N >::Segment ( const Point & p1, const Point & p2 )

inlinenoexcept

Segment() [4/4]

template<FloatingPointType T, size_t N>

Harlinn::Math::Segment< T, N >::Segment ( const Simd & simd )

inlinenoexcept

Member Function Documentation

Assign()

template<FloatingPointType T, size_t N>

void Harlinn::Math::Segment< T, N >::Assign ( const Point & center, const Vector & direction, value_type extent )

inlinenoexcept

Distance()

template<FloatingPointType T, size_t N>

template<PointOrPointSimdType PT>
requires ( PT::Size == N )

PointDistanceResult Harlinn::Math::Segment< T, N >::Distance ( const PT & point ) const

inlinenoexcept

Retrieves the closest point and distance from point to the segment.

Extract()

template<FloatingPointType T, size_t N>

void Harlinn::Math::Segment< T, N >::Extract ( Point & center, Vector & direction, value_type & extent ) const

inlinenoexcept

ToSimd()

template<FloatingPointType T, size_t N>

Simd Harlinn::Math::Segment< T, N >::ToSimd ( ) const

inlinenoexcept

Member Data Documentation

Half

template<FloatingPointType T, size_t N>

value_type Harlinn::Math::Segment< T, N >::Half = static_cast< value_type >( .5 )

staticconstexpr

One

template<FloatingPointType T, size_t N>

value_type Harlinn::Math::Segment< T, N >::One = static_cast< value_type >( 1 )

staticconstexpr

points

template<FloatingPointType T, size_t N>

std::array<Point, 2> Harlinn::Math::Segment< T, N >::points

Zero

template<FloatingPointType T, size_t N>

value_type Harlinn::Math::Segment< T, N >::Zero = static_cast< value_type >( 0 )

staticconstexpr

---

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

• include/Harlinn/Math/Segment.h