ToyMaker Game Engine 0.0.2
ToyMaker is a game engine developed and maintained by Zoheb Shujauddin.
Loading...
Searching...
No Matches
ToyMaker::AreaCircle Struct Reference

A set of numbers representing a single circle situated somewhere in the world. More...

#include <types.hpp>

Public Member Functions

bool isSensible () const
 Tests whether the circle described by these parameters is valid (as opposed to invalid or infinite).
bool isPositiveStrict () const
 Tests whether the circle's parameters are strictly positive, and hence whether the circle encloses some real region in space.

Public Attributes

float mRadius { 0.f }
 The radius of the circle.
glm::vec3 mCenter { 0.f }
 The real-world coordinates of the center of the circle.
glm::vec3 mNormal { 0.f, -1.f, 0.f }
 A vector normal to the surface of the circle, in whose direction it may be assumed the circle is facing.

Detailed Description

A set of numbers representing a single circle situated somewhere in the world.

Member Function Documentation

◆ isPositiveStrict()

bool ToyMaker::AreaCircle::isPositiveStrict ( ) const
inline

Tests whether the circle's parameters are strictly positive, and hence whether the circle encloses some real region in space.

Return values
trueThe circle is strictly positive;
falseThe circle is not strictly positive;

◆ isSensible()

bool ToyMaker::AreaCircle::isSensible ( ) const
inline

Tests whether the circle described by these parameters is valid (as opposed to invalid or infinite).

Return values
trueThe circle is sensible;
falseThe circle is not sensible;

The documentation for this struct was generated from the following file:
  • ToyMaker_Main/include/toymaker/engine/spatial_query/types.hpp