Frame of Reference Game API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
FrameOfReference.World.Components.Circle Class Reference

Collision-detection using a simple uniform circle. More...

Inheritance diagram for FrameOfReference.World.Components.Circle:

Public Member Functions

override bool CollisionTest (Vector2 point, float rotation)
 Determines whether a certain point lies within a circle. More...
 
override bool CollisionTest (Quadrangle area, float rotation)
 Determines whether a certain area lies within a circle. More...
 

Properties

float Radius [get, set]
 The radius of the circle. More...
 

Detailed Description

Collision-detection using a simple uniform circle.

Member Function Documentation

override bool FrameOfReference.World.Components.Circle.CollisionTest ( Vector2  point,
float  rotation 
)
inline

Determines whether a certain point lies within a circle.

Parameters
pointThe point to check for collision in entity space.
rotationThis is ignored for circles.
Returns
true if the point does collide with the circle, false.
override bool FrameOfReference.World.Components.Circle.CollisionTest ( Quadrangle  area,
float  rotation 
)
inline

Determines whether a certain area lies within a circle.

Parameters
areaThe area to check for collision in entity space.
rotationThis is ignored for circles.
Returns
true if area does collide with the circle, false.

Property Documentation

float FrameOfReference.World.Components.Circle.Radius
getset

The radius of the circle.


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