Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::Circle Class Reference

A generic circle class for geometry calculations. More...

#include <circle.h>

+ Collaboration diagram for Mezzanine::Circle:

Public Member Functions

 Circle ()
 Class constructor.
 
 Circle (const Vector2 &CircleCenter, const Real CircleRadius)
 Descriptive constructor. More...
 
 Circle (const Vector2 &Point1, const Vector2 &Point2, const Vector2 &Point3)
 Vector constructor. More...
 
 ~Circle ()
 Class destructor.
 
Boole IsInside (const Vector2 &Point) const
 Gets whether or not a point is inside this circle. More...
 

Public Attributes

Vector2 Center
 The center point of the circle.
 
Real Radius
 The radius of the circle.
 

Detailed Description

A generic circle class for geometry calculations.

Definition at line 52 of file circle.h.

Constructor & Destructor Documentation

Mezzanine::Circle::Circle ( const Vector2 CircleCenter,
const Real  CircleRadius 
)

Descriptive constructor.

Parameters
CircleCenterThe center point of the circle.
CircleRadiusThe radius of the circle.

Definition at line 54 of file circle.cpp.

Mezzanine::Circle::Circle ( const Vector2 Point1,
const Vector2 Point2,
const Vector2 Point3 
)

Vector constructor.

Parameters
Point1The first point determining the circles bounds.
Point2The second point determining the circles bounds.
Point3The third point determining the circles bounds.

Definition at line 59 of file circle.cpp.

Member Function Documentation

Boole Mezzanine::Circle::IsInside ( const Vector2 Point) const

Gets whether or not a point is inside this circle.

Parameters
PointThe point to check against this circle.
Returns
Returns true if the specified point is inside this circle, false otherwise.

Definition at line 88 of file circle.cpp.


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