Frame of Reference Game API  1.0.3
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:
AlphaFramework.World.Components.Collision< Vector2 >

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...
 
- Public Member Functions inherited from AlphaFramework.World.Components.Collision< Vector2 >
override string ToString ()
 
abstract bool CollisionTest (TCoordinates point, float rotation)
 
abstract bool CollisionTest (Quadrangle area, float rotation)
 
Collision< TCoordinates > Clone ()
 

Properties

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

Detailed Description

Collision-detection using a simple uniform circle.

Member Function Documentation

◆ CollisionTest() [1/2]

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.

◆ CollisionTest() [2/2]

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

◆ Radius

float FrameOfReference.World.Components.Circle.Radius
getset

The radius of the circle.


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