A Check to determine whether a point fits inside an Arc. More...

Inheritance diagram for Gestures.ArcCheck:

Public Types
enum	ARC_ORIENTATION { ARC_ORIENTATION.XY, ARC_ORIENTATION.YZ, ARC_ORIENTATION.XZ }
	Enum describing the orientation of the Arc along the three axes. More...

Public Member Functions
	ArcCheck (Vector3 startPosition, float degrees, Vector3 center, float tolerance=0.4f, ARC_ORIENTATION orientation=ARC_ORIENTATION.XY)
	Create an Arc Check used to determine whether a point fits inside the defined Arc. More...

override float	CheckPasses (GTransform g)
	Determine whether a single GTransform fits inside the area defined by the Arc More...

Detailed Description

A Check to determine whether a point fits inside an Arc.

Member Enumeration Documentation

Enum describing the orientation of the Arc along the three axes.

Enumerator
XY
YZ	Arc orientation is in the XY-plane
XZ	Arc orientation is in the YZ-plane

Gestures.ArcCheck.ArcCheck	(	Vector3	startPosition,
		float	degrees,
		Vector3	center,
		float	tolerance = `0.4f`,
		ARC_ORIENTATION	orientation = `ARC_ORIENTATION.XY`
	)

inline

Create an Arc Check used to determine whether a point fits inside the defined Arc.

Parameters

startPosition	The starting position of the arc.
degrees	Number of degrees to extent. MUST be between -90 and 90 degrees, otherwise unpredictable consequences occur.
center	The center point of circle on which the Arc lies.
tolerance	The distance tolerance from which a point can be considered within the arc
orientation	ARC_ORIENTATION enum, specifying which plane the arc resides in

override float Gestures.ArcCheck.CheckPasses ( GTransform g )

inlinevirtual

Determine whether a single GTransform fits inside the area defined by the Arc

Parameters

g	GTransform to check position against

Returns: Returns a float (between 0 and 1) representing the distance from the center of the arc, or -1 if the check fails

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