ModelAabbComponent Class

Component that stores the canonical Axis-Aligned Bounding Box (AABB) of a model. More...

Declaration

class helios::engine::modules::rendering::model::components::ModelAabbComponent { ... }

Public Constructors Index

	ModelAabbComponent ()=default
	Default constructor. More...
	ModelAabbComponent (const ModelAabbComponent &other)
	ModelAabbComponent (ModelAabbComponent &&) noexcept=default

Public Operators Index

ModelAabbComponent &	operator= (const ModelAabbComponent &)=default
ModelAabbComponent &	operator= (ModelAabbComponent &&) noexcept=default

Public Member Functions Index

bool	isEnabled () const noexcept
	Checks whether this component is enabled. More...
void	enable () noexcept
	Enables this component. More...
void	disable () noexcept
	Disables this component. More...
void	setAabb (const helios::math::aabbf &aabb)
	Sets the AABB for this component. More...
const helios::math::aabbf &	aabb () const noexcept
	Retrieves the stored AABB. More...

Private Member Attributes Index

helios::math::aabbf	aabb_ {}
	The stored AABB. More...
bool	isEnabled_ = true
	Whether this component is enabled. More...

Description

Component that stores the canonical Axis-Aligned Bounding Box (AABB) of a model.

This component is used to associate spatial bounds with an entity, typically derived from a 3D model or mesh. It is essential for culling, collision detection, and other spatial queries.

Definition at line 23 of file ModelAabbComponent.ixx.

Public Constructors

ModelAabbComponent()

helios::engine::modules::rendering::model::components::ModelAabbComponent::ModelAabbComponent ()

default

Default constructor.

Definition at line 63 of file ModelAabbComponent.ixx.

Referenced by ModelAabbComponent, ModelAabbComponent, operator= and operator=.

ModelAabbComponent()

helios::engine::modules::rendering::model::components::ModelAabbComponent::ModelAabbComponent (const ModelAabbComponent & other)

inline

Definition at line 65 of file ModelAabbComponent.ixx.

65 ModelAabbComponent(const ModelAabbComponent& other) :

66 aabb_(other.aabb_) {}

Reference ModelAabbComponent.

ModelAabbComponent()

helios::engine::modules::rendering::model::components::ModelAabbComponent::ModelAabbComponent (ModelAabbComponent &&)

noexcept default

Definition at line 69 of file ModelAabbComponent.ixx.

Reference ModelAabbComponent.

Public Operators

operator=()

ModelAabbComponent & helios::engine::modules::rendering::model::components::ModelAabbComponent::operator= (const ModelAabbComponent &)

default

Definition at line 68 of file ModelAabbComponent.ixx.

Reference ModelAabbComponent.

operator=()

ModelAabbComponent & helios::engine::modules::rendering::model::components::ModelAabbComponent::operator= (ModelAabbComponent &&)

noexcept default

Definition at line 70 of file ModelAabbComponent.ixx.

Reference ModelAabbComponent.

Public Member Functions

aabb()

const helios::math::aabbf & helios::engine::modules::rendering::model::components::ModelAabbComponent::aabb ()

inline nodiscard noexcept

Retrieves the stored AABB.

Returns

Constant reference to the AABB.

Definition at line 87 of file ModelAabbComponent.ixx.

87 [[nodiscard]] const helios::math::aabbf& aabb() const noexcept {

88 return aabb_;

89 }

Referenced by setAabb.

disable()

void helios::engine::modules::rendering::model::components::ModelAabbComponent::disable ()

inline noexcept

Disables this component.

Definition at line 56 of file ModelAabbComponent.ixx.

56 void disable() noexcept {

57 isEnabled_ = false;

58 }

enable()

void helios::engine::modules::rendering::model::components::ModelAabbComponent::enable ()

inline noexcept

Enables this component.

Definition at line 49 of file ModelAabbComponent.ixx.

49 void enable() noexcept {

50 isEnabled_ = true;

51 }

isEnabled()

bool helios::engine::modules::rendering::model::components::ModelAabbComponent::isEnabled ()

inline nodiscard noexcept

Checks whether this component is enabled.

Returns

True if enabled, false otherwise.

Definition at line 42 of file ModelAabbComponent.ixx.

42 [[nodiscard]] bool isEnabled() const noexcept {

43 return isEnabled_;

44 }

setAabb()

void helios::engine::modules::rendering::model::components::ModelAabbComponent::setAabb (const helios::math::aabbf & aabb)

inline

Sets the AABB for this component.

Parameters

aabb	The new AABB to store.

Definition at line 77 of file ModelAabbComponent.ixx.

77 void setAabb(const helios::math::aabbf& aabb) {

78 aabb_ = aabb;

79 }

References aabb and setAabb.

Referenced by setAabb.

Private Member Attributes

aabb_

helios::math::aabbf helios::engine::modules::rendering::model::components::ModelAabbComponent::aabb_ {}

The stored AABB.

Definition at line 28 of file ModelAabbComponent.ixx.

28 helios::math::aabbf aabb_{};

isEnabled_

bool helios::engine::modules::rendering::model::components::ModelAabbComponent::isEnabled_ = true

Whether this component is enabled.

Definition at line 33 of file ModelAabbComponent.ixx.

33 bool isEnabled_ = true;

---

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

• ModelAabbComponent.ixx

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.15.0.