MoreMountains.Tools.MMLineRendererCircle Class Reference

Inheritance diagram for MoreMountains.Tools.MMLineRendererCircle:

Public Types
enum	DrawAxis { X , Y , Z }
	the possible axis More...

Public Member Functions
virtual void	DrawCircle ()
	Sets all point positions for our line renderer More...

Public Attributes
DrawAxis	Axis = DrawAxis.Z
	the axis on which to draw the circle More...
float	NormalOffset = 0
	the distance by which to push the circle on the draw axis More...
int	PositionsCount = 60
	the amount of segments on the line renderer. More segments, more smoothness, more performance cost More...
float	HorizontalRadius = 10
	the length of the circle's horizontal radius More...
float	VerticalRadius = 10
	the length of the circle's vertical radius More...
bool	AutoRedrawOnValuesChange = false
	if this is true, the circle will be redrawn every time you change a value in the inspector, otherwise you'll have to call the DrawCircle method (or press the debug button below) More...
bool	DrawCircleButton
	a test button used to call the DrawCircle method More...

Protected Member Functions
virtual void	Awake ()
	On Awake we initialize our line renderer and draw our circle More...
virtual void	Initialization ()
	Grabs the line renderer and sets it up More...
virtual float	ComputeX ()
	Computes the x position of the new point More...
virtual float	ComputeY ()
	Computes the y position of the new point More...
virtual void	DrawCircleX ()
	Draws a circle on the x axis More...
virtual void	DrawCircleY ()
	Draws a circle on the y axis More...
virtual void	DrawCircleZ ()
	Draws a circle on the z axis More...
virtual void	OnValidate ()
	On Validate we redraw our circle if needed More...

Protected Attributes
LineRenderer	_line
Vector3	_newPosition
float	_angle
float	_x
float	_y
float	_z

Member Enumeration Documentation

DrawAxis

enum MoreMountains.Tools.MMLineRendererCircle.DrawAxis

the possible axis

Enumerator
X
Y
Z

Member Function Documentation

Awake()

virtual void MoreMountains.Tools.MMLineRendererCircle.Awake ( )

protectedvirtual

On Awake we initialize our line renderer and draw our circle

ComputeX()

virtual float MoreMountains.Tools.MMLineRendererCircle.ComputeX ( )

protectedvirtual

Computes the x position of the new point

Returns

ComputeY()

virtual float MoreMountains.Tools.MMLineRendererCircle.ComputeY ( )

protectedvirtual

Computes the y position of the new point

Returns

DrawCircle()

virtual void MoreMountains.Tools.MMLineRendererCircle.DrawCircle ( )

virtual

Sets all point positions for our line renderer

DrawCircleX()

virtual void MoreMountains.Tools.MMLineRendererCircle.DrawCircleX ( )

protectedvirtual

Draws a circle on the x axis

DrawCircleY()

virtual void MoreMountains.Tools.MMLineRendererCircle.DrawCircleY ( )

protectedvirtual

Draws a circle on the y axis

DrawCircleZ()

virtual void MoreMountains.Tools.MMLineRendererCircle.DrawCircleZ ( )

protectedvirtual

Draws a circle on the z axis

Initialization()

virtual void MoreMountains.Tools.MMLineRendererCircle.Initialization ( )

protectedvirtual

Grabs the line renderer and sets it up

OnValidate()

virtual void MoreMountains.Tools.MMLineRendererCircle.OnValidate ( )

protectedvirtual

On Validate we redraw our circle if needed

Member Data Documentation

_angle

float MoreMountains.Tools.MMLineRendererCircle._angle

protected

_line

LineRenderer MoreMountains.Tools.MMLineRendererCircle._line

protected

_newPosition

Vector3 MoreMountains.Tools.MMLineRendererCircle._newPosition

protected

_x

float MoreMountains.Tools.MMLineRendererCircle._x

protected

_y

float MoreMountains.Tools.MMLineRendererCircle._y

protected

_z

float MoreMountains.Tools.MMLineRendererCircle._z

protected

AutoRedrawOnValuesChange

bool MoreMountains.Tools.MMLineRendererCircle.AutoRedrawOnValuesChange = false

if this is true, the circle will be redrawn every time you change a value in the inspector, otherwise you'll have to call the DrawCircle method (or press the debug button below)

Axis

DrawAxis MoreMountains.Tools.MMLineRendererCircle.Axis = DrawAxis.Z

the axis on which to draw the circle

DrawCircleButton

bool MoreMountains.Tools.MMLineRendererCircle.DrawCircleButton

a test button used to call the DrawCircle method

HorizontalRadius

float MoreMountains.Tools.MMLineRendererCircle.HorizontalRadius = 10

the length of the circle's horizontal radius

NormalOffset

float MoreMountains.Tools.MMLineRendererCircle.NormalOffset = 0

the distance by which to push the circle on the draw axis

PositionsCount

int MoreMountains.Tools.MMLineRendererCircle.PositionsCount = 60

the amount of segments on the line renderer. More segments, more smoothness, more performance cost

VerticalRadius

float MoreMountains.Tools.MMLineRendererCircle.VerticalRadius = 10

the length of the circle's vertical radius

---

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

• E:/Github/Store/HighroadEngine/Assets/HighroadEngine/MMTools/Tools/MMSprites/MMLineRendererCircle.cs