TesseractBasic.Reticle Class Reference

Draws a circular reticle in front of any object that the user points at. More...

Inheritance diagram for TesseractBasic.Reticle:

Public Member Functions
void	ShowReticleForSeconds (float seconds, float distance)
	Shows the reticle for given seconds at the given distance More...
void	UpdatePosition (float distance)
	Updates the position of the reticle More...
void	PointReticle ()
	Show Point Reticle More...
void	EnableReticle ()
	Enables the reticle. Any reticle based animation and interactions are only visible if the reticle is enabled. More...
void	DisableReticle ()
	Disables the reticle. Any reticle based animation and interactions are only visible if the reticle is enabled. More...
void	SetReticleSize (bool small)
	Sets the size of the reticle. More...
void	SetReticleColor (Color color)
	Sets the color of the reticle. More...
void	HideReticle ()
	Hides the reticle unless activated otherwise. More...

Public Attributes
float	maxReticleDistance = 10.0f
	Maximum distance of the reticle (in meters). More...
float	defaultReticleDistance = 2f
	The default reticle distance ( in meters). More...
int	reticleSegments = 40
	Number of segments making the reticle circle. More...
float	reticleGrowthSpeed = 8.0f
	Growth speed multiplier for the reticle/ More...

Static Public Attributes
static Reticle	Instance
	Static reference to this class More...

Detailed Description

Draws a circular reticle in front of any object that the user points at.

Member Function Documentation

DisableReticle()

void TesseractBasic.Reticle.DisableReticle

(

)

Disables the reticle. Any reticle based animation and interactions are only visible if the reticle is enabled.

EnableReticle()

void TesseractBasic.Reticle.EnableReticle

(

)

Enables the reticle. Any reticle based animation and interactions are only visible if the reticle is enabled.

HideReticle()

void TesseractBasic.Reticle.HideReticle

(

)

Hides the reticle unless activated otherwise.

PointReticle()

void TesseractBasic.Reticle.PointReticle

(

)

Show Point Reticle

SetReticleColor()

void TesseractBasic.Reticle.SetReticleColor

(

Color

color

)

Sets the color of the reticle.

Parameters

color

Color to set the reticle to.

SetReticleSize()

void TesseractBasic.Reticle.SetReticleSize

(

bool

small

)

Sets the size of the reticle.

Parameters

small

If set to true smaller reticle is show otherwise normal size is shown.

ShowReticleForSeconds()

void TesseractBasic.Reticle.ShowReticleForSeconds	(	float	seconds,
		float	distance
	)

Shows the reticle for given seconds at the given distance

Parameters

seconds	Seconds for which the reticle is visible
distance	Distance at which reticle is visible from the camera (in meters).

UpdatePosition()

void TesseractBasic.Reticle.UpdatePosition

(

float

distance

)

Updates the position of the reticle

Parameters

distance

New distance of the reticle from the camera (in meters).

Member Data Documentation

defaultReticleDistance

float TesseractBasic.Reticle.defaultReticleDistance = 2f

The default reticle distance ( in meters).

Instance

Reticle TesseractBasic.Reticle.Instance

static

Static reference to this class

maxReticleDistance

float TesseractBasic.Reticle.maxReticleDistance = 10.0f

Maximum distance of the reticle (in meters).

reticleGrowthSpeed

float TesseractBasic.Reticle.reticleGrowthSpeed = 8.0f

Growth speed multiplier for the reticle/

reticleSegments

int TesseractBasic.Reticle.reticleSegments = 40

Number of segments making the reticle circle.

---

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

• Reticle.cs