UFO 1.0.0
An Efficient Probabilistic 3D Mapping Framework That Embraces the Unknown
Loading...
Searching...
No Matches
ufo::OBB< 4, T > Struct Template Reference

Public Types

using value_type = T
 

Public Member Functions

constexpr OBB (OBB const &) noexcept=default
 
template<std::convertible_to< T > U>
constexpr OBB (OBB< 4, U > const &other) noexcept
 
constexpr OBB (Vec< 4, T > const &center, Vec< 4, T > const &half_length) noexcept
 
constexpr OBB (Vec< 4, T > const &center, Vec< 4, T > const &half_length, Mat< 4, 4, T > const &rotation) noexcept
 
constexpr OBB (Vec< 4, T > const &start, Vec< 4, T > const &end, Vec< 3, T > const &half_length)
 
constexpr AABB< 4, T > aabb () const noexcept
 Returns the AABB of the OBB.
 
constexpr Vec< 4, T > const & center () const noexcept
 Returns the center of the OBB.
 
constexpr Vec< 4, T > & center () noexcept
 Returns the center of the OBB.
 
constexpr T diagonal () const noexcept
 Returns the diagonal length of the OBB.
 
constexpr bool isDegenerate () const noexcept
 Returns whether the OBB is degenerate.
 
bool operator== (OBB const &) const =default
 Equality operator.
 
constexpr Vec< 4, T > rotatedHalfLength () const
 Returns the rotated half-length vector.
 
constexpr T volume () const noexcept
 Returns the volume of the OBB.
 

Static Public Member Functions

static constexpr std::size_t dimension () noexcept
 Returns the dimensionality of the OBB.
 

Public Attributes

Vec< 4, T > center_
 
Vec< 4, T > half_length
 
Mat< 4, 4, T > rotation
 

Detailed Description

template<std::floating_point T>
struct ufo::OBB< 4, T >

Definition at line 438 of file obb.hpp.

Member Typedef Documentation

◆ value_type

template<std::floating_point T>
using ufo::OBB< 4, T >::value_type = T

Definition at line 439 of file obb.hpp.

Constructor & Destructor Documentation

◆ OBB() [1/4]

template<std::floating_point T>
constexpr ufo::OBB< 4, T >::OBB ( Vec< 4, T > const &  start,
Vec< 4, T > const &  end,
Vec< 3, T > const &  half_length 
)
inlineconstexpr

Definition at line 447 of file obb.hpp.

◆ OBB() [2/4]

template<std::floating_point T>
constexpr ufo::OBB< 4, T >::OBB ( Vec< 4, T > const &  center,
Vec< 4, T > const &  half_length 
)
inlineconstexprnoexcept

Definition at line 456 of file obb.hpp.

◆ OBB() [3/4]

template<std::floating_point T>
constexpr ufo::OBB< 4, T >::OBB ( Vec< 4, T > const &  center,
Vec< 4, T > const &  half_length,
Mat< 4, 4, T > const &  rotation 
)
inlineconstexprnoexcept

Definition at line 461 of file obb.hpp.

◆ OBB() [4/4]

template<std::floating_point T>
template<std::convertible_to< T > U>
constexpr ufo::OBB< 4, T >::OBB ( OBB< 4, U > const &  other)
inlineexplicitconstexprnoexcept

Definition at line 470 of file obb.hpp.

Member Function Documentation

◆ aabb()

template<std::floating_point T>
constexpr AABB< 4, T > ufo::OBB< 4, T >::aabb ( ) const
inlineconstexprnoexcept

Returns the AABB of the OBB.

Returns
The AABB.

Definition at line 512 of file obb.hpp.

◆ center() [1/2]

template<std::floating_point T>
constexpr Vec< 4, T > const & ufo::OBB< 4, T >::center ( ) const
inlineconstexprnoexcept

Returns the center of the OBB.

Returns
The center.

Definition at line 487 of file obb.hpp.

◆ center() [2/2]

template<std::floating_point T>
constexpr Vec< 4, T > & ufo::OBB< 4, T >::center ( )
inlineconstexprnoexcept

Returns the center of the OBB.

Returns
The center.

Definition at line 481 of file obb.hpp.

◆ diagonal()

template<std::floating_point T>
constexpr T ufo::OBB< 4, T >::diagonal ( ) const
inlineconstexprnoexcept

Returns the diagonal length of the OBB.

Definition at line 498 of file obb.hpp.

◆ dimension()

template<std::floating_point T>
static constexpr std::size_t ufo::OBB< 4, T >::dimension ( )
inlinestaticconstexprnoexcept

Returns the dimensionality of the OBB.

Returns
The dimensionality.

Definition at line 493 of file obb.hpp.

◆ isDegenerate()

template<std::floating_point T>
constexpr bool ufo::OBB< 4, T >::isDegenerate ( ) const
inlineconstexprnoexcept

Returns whether the OBB is degenerate.

Definition at line 527 of file obb.hpp.

◆ rotatedHalfLength()

template<std::floating_point T>
constexpr Vec< 4, T > ufo::OBB< 4, T >::rotatedHalfLength ( ) const
inlineconstexpr

Returns the rotated half-length vector.

Definition at line 535 of file obb.hpp.

◆ volume()

template<std::floating_point T>
constexpr T ufo::OBB< 4, T >::volume ( ) const
inlineconstexprnoexcept

Returns the volume of the OBB.

Definition at line 503 of file obb.hpp.

Member Data Documentation

◆ center_

template<std::floating_point T>
Vec<4, T> ufo::OBB< 4, T >::center_

Definition at line 441 of file obb.hpp.

◆ half_length

template<std::floating_point T>
Vec<4, T> ufo::OBB< 4, T >::half_length

Definition at line 442 of file obb.hpp.

◆ rotation

template<std::floating_point T>
Mat<4, 4, T> ufo::OBB< 4, T >::rotation

Definition at line 443 of file obb.hpp.


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