Files
file	math.hpp
	Geometrical, mathematical functions and related structs used to answer some simple questions about shapes situated somewhere in the world.
file	octree.hpp
	Data structures, functions, and methods relating to the hierarchical organization and representation of spatial data.
file	system.hpp
	The file containing classes related to the spatial query system, which uses simplified geometrical data and spatial indexing data structures to answer spatial queries generated by other parts of the program.
file	types.hpp
	Classes and structs representing data related to the engine's spatial query system (the precursor to a full-fledged physics system).

Classes
class	ToyMaker::OctreeNode
	A single node of an octree, representing a single octant of the 8 that make up its parent region. More...
class	ToyMaker::Octree
	A data structure used for speeding up spatial queries about 3-dimensional objects in the scene. More...
class	ToyMaker::SpatialQuerySystem
	The spatial query system, an ECS System that tracks and updates spatial query data for objects in the scene, and which exposes spatial query methods. More...
class	ToyMaker::SpatialQuerySystem::LightBoundsComputeSystem
	A subsystem of the spatial query system responsible for tracking light volumes and recomputing their ObjectBounds accordingly. More...
struct	ToyMaker::VolumeBase_
	The base class of all spatial query volumes. More...
struct	ToyMaker::Volume< TDerived >
struct	ToyMaker::VolumeBox
	Holds the parameters describing the spatial query volume of a simple three-dimensionsal box. More...
struct	ToyMaker::VolumeCapsule
	Holds the parameters describing the spatial query volume of a simple three-dimensionsal capsule (or pill, or whatever you like). More...
struct	ToyMaker::VolumeSphere
	Holds parameters describing a spherical spatial query volume. More...
struct	ToyMaker::AreaTriangle
	A set of 3 points located in the world forming a (hopefully sensible) triangle. More...
struct	ToyMaker::AreaCircle
	A set of numbers representing a single circle situated somewhere in the world. More...
struct	ToyMaker::Ray
	A set of numbers describing a ray with its source at some finite point in the world, projected in a direction for some positive length. More...
struct	ToyMaker::Plane
	A set of numbers describing a plane situated somewhere in the world. More...
struct	ToyMaker::ObjectBounds
	A component defining the true bounds of a spatially queryable object situated somewhere in the world. More...
class	ToyMaker::AxisAlignedBounds
	An object containing a coarse simplified representation, AABB, of spatially queryable objects. More...

Typedefs
using	ToyMaker::BoxCorner = uint8_t
	Type used to represent the name of the corner of a box.

Enumerations
enum	ToyMaker::BoxCornerSpecifier : BoxCorner { RIGHT =0x1 , TOP =0x2 , FRONT =0x4 }
	Enum values correspond to bits on a BoxCorner which help specify which side of the box on each axis is being indicated.

Functions
std::pair< bool, glm::vec3 >	ToyMaker::computeIntersection (const Ray &ray, const Plane &plane)
	Returns a bool-vector pair, with bool indicating whether a point of intersection was found, and the vector containing the point of intersection.
std::pair< bool, glm::vec3 >	ToyMaker::computeIntersection (const Ray &ray, const AreaTriangle &triangle)
	Returns a bool-vector pair, with bool indicating whether a point of intersection was found, and the vector containing the point of intersection.
std::pair< uint8_t, std::pair< glm::vec3, glm::vec3 > >	ToyMaker::computeIntersections (const Ray &ray, const AxisAlignedBounds &axisAlignedBounds)
	Returns an unsigned int and vector-pair pair, with unsigned indicating whether any and how many points of intersection were found with the AABB, and the vector containing the points of intersection.
std::pair< uint8_t, std::pair< glm::vec3, glm::vec3 > >	ToyMaker::computeIntersections (const Ray &ray, const ObjectBounds &objectbounds)
	Returns an unsigned int and vector pair pair, with int indicating whether and how many points of intersection were found, and the vector containing the points of intersection.
bool	ToyMaker::overlaps (const glm::vec3 &point, const ObjectBounds &bounds)
	Returns a bool value indicating whether point is contained by bounds.
bool	ToyMaker::overlaps (const ObjectBounds &bounds, const glm::vec3 &point)
	Returns a bool value indicating whether point is contained by bounds.
bool	ToyMaker::overlaps (const Ray &ray, const ObjectBounds &bounds)
	Returns a bool value indicating whether the ray passes through the object volume.
bool	ToyMaker::overlaps (const ObjectBounds &bounds, const Ray &ray)
	Returns a bool value indicating whether the ray passes through the object volume.
bool	ToyMaker::overlaps (const glm::vec3 &point, const AxisAlignedBounds &bounds)
	Returns whether point is contained by bounds.
bool	ToyMaker::overlaps (const AxisAlignedBounds &bounds, const glm::vec3 &point)
	Returns whether point is contained by bounds.
bool	ToyMaker::overlaps (const Ray &ray, const AxisAlignedBounds &bounds)
	Returns whether ray overlaps with bounds.
bool	ToyMaker::overlaps (const AxisAlignedBounds &bounds, const Ray &ray)
	Returns whether ray overlaps with bounds.
bool	ToyMaker::overlaps (const AxisAlignedBounds &one, const AxisAlignedBounds &two)
	Returns whether one overlaps two.
bool	ToyMaker::overlaps (const ObjectBounds &one, const ObjectBounds &two)
	Returns whether one overlaps two.
bool	ToyMaker::overlaps (const AxisAlignedBounds &one, const ObjectBounds &two)
	Returns whether one overlaps two.
bool	ToyMaker::overlaps (const ObjectBounds &one, const AxisAlignedBounds &two)
	Returns whether one overlaps two.
bool	ToyMaker::contains (const glm::vec3 &point, const ObjectBounds &bounds)
	Returns whether point is contained by bounds.
bool	ToyMaker::contains (const glm::vec3 &point, const AxisAlignedBounds &bounds)
	Returns whether point is contained by bounds.
bool	ToyMaker::contains (const Ray &ray, const AxisAlignedBounds &bounds)
	Returns whether ray is contained by bounds.
bool	ToyMaker::contains (const Ray &ray, const ObjectBounds &bounds)
	Returns whether ray is contained by bounds.
bool	ToyMaker::contains (const AxisAlignedBounds &one, const AxisAlignedBounds &two)
	Returns whether one is contained by two.
bool	ToyMaker::contains (const ObjectBounds &one, const AxisAlignedBounds &two)
	Returns whether one is contained by two.
std::pair< glm::vec3, glm::vec3 >	ToyMaker::deriveTangents (const glm::vec3 &vector)
	Returns a pair of tangents to an input vector.
template<typename T, typename U>
glm::vec3	ToyMaker::minkowskiDifference (const T &one, const U &two, const glm::vec3 &along)
	Closely associated with GJK; finds the Minkowski difference between two shapes situated somewhere in the world.
template<typename T, typename U>
std::tuple< glm::vec3, glm::vec3, glm::vec3 >	ToyMaker::minkowskiDifferenceFull (const T &one, const U &two, const glm::vec3 &along)
	Closely associated with GJK; finds the Minkowski difference between two shapes situated somewhere in the world.
bool	ToyMaker::isFinite (float number)
	Tests whether a given number is finite.
bool	ToyMaker::isFinite (const glm::vec3 &vector)
	Tests whether a set of 3 numbers is finite.
bool	ToyMaker::isPositiveStrict (float number)
	Tests whether a number is strictly positive.
bool	ToyMaker::isPositiveStrict (const glm::vec3 &vector)
	Tests whether a set of 3 numbers is strictly positive.
bool	ToyMaker::isNonNegative (float number)
	Tests whether a number is non-negative.
bool	ToyMaker::isNonNegative (const glm::vec3 &vector)
	Tests whether a set of numbers is non-negative.
std::array< AreaTriangle, 12 >	ToyMaker::computeBoxFaceTriangles (const std::array< glm::vec3, 8 > &boxCorners)
	Generates a list of triangles making up the surface of a box situated somewhere in the world, given the coordinates of its corners.
bool	ToyMaker::ObjectBounds::isPositiveStrict () const
	Checks whether underlying bounds is non-trivial, as in each important parameter that represents the volume is greater than 0.
	ToyMaker::NLOHMANN_JSON_SERIALIZE_ENUM (ObjectBounds::TrueVolumeType, { {ObjectBounds::TrueVolumeType::BOX, "box"}, {ObjectBounds::TrueVolumeType::SPHERE, "sphere"}, {ObjectBounds::TrueVolumeType::CAPSULE, "capsule"}, }) inline void to_json(nlohmann
void	ToyMaker::from_json (const nlohmann::json &json, ObjectBounds &objectBounds)
void	ToyMaker::to_json (nlohmann::json &json, const AxisAlignedBounds &axisAlignedBounds)
void	ToyMaker::from_json (const nlohmann::json &json, AxisAlignedBounds &objectBounds)

Detailed Description

Function Documentation

◆ computeBoxFaceTriangles()

std::array< AreaTriangle, 12 > ToyMaker::computeBoxFaceTriangles ( const std::array< glm::vec3, 8 > & boxCorners )

Generates a list of triangles making up the surface of a box situated somewhere in the world, given the coordinates of its corners.

Parameters

boxCorners An array containing coordinates for the corners of a box located somewhere in the world.

Returns: std::array<AreaTriangle, 12> The triangles representing the faces of the box.

◆ computeIntersection() [1/2]

std::pair< bool, glm::vec3 > ToyMaker::computeIntersection	(	const Ray &	ray,
		const AreaTriangle &	triangle )

Returns a bool-vector pair, with bool indicating whether a point of intersection was found, and the vector containing the point of intersection.

Warning: Error if invalid ray or triangle specified (triangle with no area, or ray with no direction)

◆ computeIntersection() [2/2]

std::pair< bool, glm::vec3 > ToyMaker::computeIntersection	(	const Ray &	ray,
		const Plane &	plane )

Returns a bool-vector pair, with bool indicating whether a point of intersection was found, and the vector containing the point of intersection.

Warning: Error if invalid ray or plane specified (plane with no normal, or ray with no direction)

◆ computeIntersections() [1/2]

std::pair< uint8_t, std::pair< glm::vec3, glm::vec3 > > ToyMaker::computeIntersections	(	const Ray &	ray,
		const AxisAlignedBounds &	axisAlignedBounds )

Returns an unsigned int and vector-pair pair, with unsigned indicating whether any and how many points of intersection were found with the AABB, and the vector containing the points of intersection.

(if the ray "glances off" the volume, it does not count as an intersection per my implementation)

Warning: Error if invalid ray or AABB specified, which includes an AABB with negative or zero volume.

◆ computeIntersections() [2/2]

std::pair< uint8_t, std::pair< glm::vec3, glm::vec3 > > ToyMaker::computeIntersections	(	const Ray &	ray,
		const ObjectBounds &	objectbounds )

Returns an unsigned int and vector pair pair, with int indicating whether and how many points of intersection were found, and the vector containing the points of intersection.

Object bounds only supports convex shapes, and so one can expect that if a point of intersection exists, then there will be a second to go with it. (provided the ray is long enough) (and also unless the ray "glances off" the volume, which counts as no intersection per my implementation)

◆ deriveTangents()

std::pair< glm::vec3, glm::vec3 > ToyMaker::deriveTangents ( const glm::vec3 & vector )

inline

Returns a pair of tangents to an input vector.

See Erin Catto's blog post for the method used here to derive consistent tangents to a vector efficiently.

◆ isFinite() [1/2]

bool ToyMaker::isFinite ( const glm::vec3 & vector )

inline

Tests whether a set of 3 numbers is finite.

Parameters

vector The numbers being tested.

Return values

true	The numbers are (all) finite;
false	One or more numbers are not finite;

◆ isFinite() [2/2]

bool ToyMaker::isFinite ( float number )

inline

Tests whether a given number is finite.

Parameters

number The number being tested.

Return values

true	The number is finite;
false	The number is not finite;

◆ isNonNegative() [1/2]

bool ToyMaker::isNonNegative ( const glm::vec3 & vector )

inline

Tests whether a set of numbers is non-negative.

Parameters

vector The numbers being tested.

Return values

true	The numbers are (all) non-negative.
false	One or more of the numbers are negative.

◆ isNonNegative() [2/2]

bool ToyMaker::isNonNegative ( float number )

inline

Tests whether a number is non-negative.

Parameters

number The number being tested.

Return values

true	The number is non-negative;
false	The number is negative;

◆ isPositiveStrict() [1/2]

bool ToyMaker::isPositiveStrict ( const glm::vec3 & vector )

inline

Tests whether a set of 3 numbers is strictly positive.

Parameters

vector The numbers being tested.

Return values

true	The numbers are (all) strictly positive;
false	One or more numbers are not positive;

◆ isPositiveStrict() [2/2]

bool ToyMaker::isPositiveStrict ( float number )

inline

Tests whether a number is strictly positive.

Parameters

number The number being tested.

Return values

true	The number is strictly positive;
false	The number is not positive;

◆ minkowskiDifference()

template<typename T, typename U>

glm::vec3 ToyMaker::minkowskiDifference	(	const T &	one,
		const U &	two,
		const glm::vec3 &	along )

inline

Closely associated with GJK; finds the Minkowski difference between two shapes situated somewhere in the world.

See also: gjkOverlaps

◆ minkowskiDifferenceFull()

template<typename T, typename U>

std::tuple< glm::vec3, glm::vec3, glm::vec3 > ToyMaker::minkowskiDifferenceFull	(	const T &	one,
		const U &	two,
		const glm::vec3 &	along )

inline

Closely associated with GJK; finds the Minkowski difference between two shapes situated somewhere in the world.

See also: gjkOverlaps

Returns: std::tuple<glm::vec3, glm::vec3, glm::vec3> 0. Minkowski difference; 1. SupportA; 2. SupportB

Files

Classes

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ computeBoxFaceTriangles()

◆ computeIntersection() [1/2]

◆ computeIntersection() [2/2]

◆ computeIntersections() [1/2]

◆ computeIntersections() [2/2]

◆ deriveTangents()

◆ isFinite() [1/2]

◆ isFinite() [2/2]

◆ isNonNegative() [1/2]

◆ isNonNegative() [2/2]

◆ isPositiveStrict() [1/2]

◆ isPositiveStrict() [2/2]

◆ minkowskiDifference()

◆ minkowskiDifferenceFull()