Holds the parameters describing the spatial query volume of a simple three-dimensionsal box. More...

#include <types.hpp>

Inheritance diagram for ToyMaker::VolumeBox:

Public Member Functions
std::array< glm::vec3, 8 >	getVolumeRelativeBoxCorners () const
	Returns an array of coordinates corresponding to the corners of the box.
bool	isSensible () const
	Tests whether the values representing the box are valid (as opposed to invalid or infinite).
bool	isPositiveStrict () const
	Tests whether the values representing the box are strictly positive.
Public Member Functions inherited from ToyMaker::Volume< VolumeBox >
std::array< glm::vec3, 8 >	getVolumeRelativeBoxCorners () const
	Poor man's vtable cont'd.
bool	isSensible () const
	Poor man's vtable cont'd.
bool	isPositiveStrict () const
	Poor man's vtable cont'd.
Public Member Functions inherited from ToyMaker::VolumeBase_
template<typename TDerived>
std::array< glm::vec3, 8 >	getVolumeRelativeBoxCorners () const
	Gets corners of the object-relative bounding box that encapsulates the derived volume.
template<typename TDerived>
bool	isSensible () const
	Returns whether or not the derived volume has sensible parameters (i.e., isn't infinite or invalid).
template<typename TDerived>
bool	isPositiveStrict () const
	Returns whether or not the derived volume has strictly positive parameters.

Public Attributes
glm::vec3	mDimensions {0.f, 0.f, 0.f}
	The dimensions of the box, its width, height, and depth.

Additional Inherited Members
Static Public Member Functions inherited from ToyMaker::VolumeBase_
static constexpr std::array< glm::vec3, 8 >	GetCornerSignsArray ()
	Returns an array populated with axis-wise sign multipliers, where the positions on the array correspond to the corner of a box.
static std::array< glm::vec3, 8 >	ComputeBoxCorners (const glm::vec3 &boxDimensions)
	Computes the model relative corners of a box, given the dimensions of the box.

Detailed Description

Holds the parameters describing the spatial query volume of a simple three-dimensionsal box.

Member Function Documentation

std::array< glm::vec3, 8 > ToyMaker::VolumeBox::getVolumeRelativeBoxCorners ( ) const

inline

Returns an array of coordinates corresponding to the corners of the box.

bool ToyMaker::VolumeBox::isPositiveStrict ( ) const

inline

Tests whether the values representing the box are strictly positive.

Return values

true	The box's parameters are all strictly positive;
false	The box's parameters are not all strictly positive;

bool ToyMaker::VolumeBox::isSensible ( ) const

inline

Tests whether the values representing the box are valid (as opposed to invalid or infinite).

Return values

true	The box is sensible;
false	The box is not sensible;

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