AABBComponent Class Template

Generic AABB value component with dirty-state tracking. More...

Declaration

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args> class helios::engine::core::components::AABBComponent<TDomainTag, TNumericType, THandle, Args> { ... }

Public Member Typedefs Index

template < ... >
using	Value_type = helios::math::aabb< TNumericType >
template < ... >
using	Handle_type = THandle

Public Constructors Index

template < ... >
AABBComponent ()=default
template < ... >
AABBComponent (const Value_type &value)
	Constructs the component with an initial value. More...
template < ... >
AABBComponent (const AABBComponent &other)
	Copy constructor. More...
template < ... >
AABBComponent (AABBComponent &&) noexcept=default
	Default move constructor. More...

Public Operators Index

template < ... >
AABBComponent &	operator= (const AABBComponent &)=default
	Default copy assignment. More...
template < ... >
AABBComponent &	operator= (AABBComponent &&) noexcept=default
	Default move assignment. More...

Public Member Functions Index

template < ... >
Value_type &	value () noexcept
	Returns the current value. More...
template < ... >
const Value_type &	value () const noexcept
template < ... >
void	setValue (const Value_type &value) noexcept
	Updates the value and marks the component dirty on change. More...

Private Member Attributes Index

template < ... >
helios::math::aabb< TNumericType >	value_ {}

Description

Generic AABB value component with dirty-state tracking.

Template Parameters

TDomainTag	Semantic domain tag.
THandle	Owning entity handle type.
TNumericType	Scalar type for AABB values.

Definition at line 22 of file AABBComponent.ixx.

Public Member Typedefs

Handle_type

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

using helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::Handle_type = THandle

Definition at line 29 of file AABBComponent.ixx.

29 using Handle_type = THandle;

Value_type

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

using helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::Value_type = helios::math::aabb<TNumericType>

Definition at line 28 of file AABBComponent.ixx.

28 using Value_type = helios::math::aabb<TNumericType>;

Public Constructors

AABBComponent()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::AABBComponent ()

default

Definition at line 31 of file AABBComponent.ixx.

AABBComponent()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::AABBComponent (const Value_type & value)

inline explicit

Constructs the component with an initial value.

Parameters

value

Initial value vector.

Definition at line 38 of file AABBComponent.ixx.

38 explicit AABBComponent(const Value_type& value) : value_(value) {}

AABBComponent()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::AABBComponent (const AABBComponent & other)

inline

Copy constructor.

Copies the value and forces the copied component into a dirty state to ensure dependent systems refresh cached data.

Parameters

other

The component to copy from.

Definition at line 48 of file AABBComponent.ixx.

48 AABBComponent(const AABBComponent& other) :

49 value_(other.value_) {}

AABBComponent()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::AABBComponent (AABBComponent &&)

noexcept default

Default move constructor.

Definition at line 54 of file AABBComponent.ixx.

Public Operators

operator=()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

AABBComponent & helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::operator= (const AABBComponent &)

default

Default copy assignment.

Definition at line 52 of file AABBComponent.ixx.

operator=()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

AABBComponent & helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::operator= (AABBComponent &&)

noexcept default

Default move assignment.

Definition at line 56 of file AABBComponent.ixx.

Public Member Functions

setValue()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

void helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::setValue (const Value_type & value)

inline noexcept

Updates the value and marks the component dirty on change.

Parameters

value

New value vector.

Definition at line 77 of file AABBComponent.ixx.

77 void setValue(const Value_type& value) noexcept {

78 value_ = value;

79 };

Reference helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::value.

value()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

Value_type & helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::value ()

inline noexcept

Returns the current value.

Returns

Current axis-aligned bounding box value.

Definition at line 64 of file AABBComponent.ixx.

64 [[nodiscard]] Value_type& value() noexcept {

65 return value_;

66 }

Referenced by helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::setValue.

value()

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

const Value_type & helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::value ()

inline noexcept

Definition at line 68 of file AABBComponent.ixx.

68 [[nodiscard]] const Value_type& value() const noexcept {

69 return value_;

70 }

Private Member Attributes

value_

template <typename TDomainTag, typename TNumericType, typename THandle, typename ... Args>

helios::math::aabb<TNumericType> helios::engine::core::components::AABBComponent< TDomainTag, TNumericType, THandle, Args >::value_ {}

Definition at line 24 of file AABBComponent.ixx.

24 helios::math::aabb<TNumericType> value_{};

---

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

• AABBComponent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.