ToyMaker::VolumeSphere Struct Reference

Holds parameters describing a spherical spatial query volume. More...

#include <spatial_query_basic_types.hpp>

Inheritance diagram for ToyMaker::VolumeSphere:

Public Member Functions
std::array< glm::vec3, 8 >	getVolumeRelativeBoxCorners () const
	Gets an array of coordinates of corners of a box just encapsulating the sphere.
bool	isSensible () const
	Tests whether this volumes parameters are sensible (as opposed to invalid, infinite, or degenerate).
Public Member Functions inherited from ToyMaker::Volume< VolumeSphere >
std::array< glm::vec3, 8 >	getVolumeRelativeBoxCorners () const
	Poor man's vtable cont'd.
Public Member Functions inherited from ToyMaker::VolumeBase_
template<typename TDerived>
std::array< glm::vec3, 8 >	getVolumeRelativeBoxCorners () const
	Poor man's vtable which doesn't break Volume's ability to be aggregate initialized.

Public Attributes
float	mRadius {0.f}
	The radius of the sphere.

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 parameters describing a spherical spatial query volume.

Member Function Documentation

getVolumeRelativeBoxCorners()

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

inline

Gets an array of coordinates of corners of a box just encapsulating the sphere.

Returns

std::array<glm::vec3, 8> An array of coordinates of a box containing the sphere.

isSensible()

bool ToyMaker::VolumeSphere::isSensible ( ) const

inline

Tests whether this volumes parameters are sensible (as opposed to invalid, infinite, or degenerate).

Return values

true	The sphere is sensible;
false	The sphere is not sensible;

---

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

• src/engine/spatial_query_basic_types.hpp