Joystick input class. In charge of the behaviour of the joystick mobile touch input. Bind its actions from the inspector Handles mouse and multi touch More...

Inheritance diagram for MoreMountains.Tools.MMTouchJoystick:

Public Types
enum	MaxRangeModes { MaxRangeModes.Distance, MaxRangeModes.DistanceToTransform }

Public Member Functions
virtual void	Initialize ()
	Initializes the various parts of the stick More...

virtual void	RefreshMaxRangeDistance ()
	This method is used to compute the max range distance when in DistanceToTransform mode More...

virtual void	SetKnobTransform (Transform newTransform)
	Assigns a new transform as the joystick knob More...

virtual void	SetNeutralPosition ()
	Sets the neutral position of the joystick More...

virtual void	SetNeutralPosition (Vector3 newPosition)

virtual void	OnDrag (PointerEventData eventData)
	Handles dragging of the joystick More...

virtual void	ResetJoystick ()
	Resets the stick's position and values More...

virtual void	OnEndDrag (PointerEventData eventData)
	What happens when the stick stops being dragged More...

virtual void	OnPointerUp (PointerEventData data)
	What happens when the stick is released (even if no drag happened) More...

virtual void	OnPointerDown (PointerEventData data)
	What happens when the stick is pressed for the first time More...

Public Attributes
Camera	TargetCamera
	The camera to use as the reference for any ScreenToWorldPoint computations. More...

bool	HorizontalAxisEnabled = true
	Is horizontal axis allowed. More...

bool	VerticalAxisEnabled = true
	Is vertical axis allowed. More...

MaxRangeModes	MaxRangeMode = MaxRangeModes.Distance
	the mode in which to compute the range. Distance will be a flat value, DistanceToTransform will be a distance to a transform you can move around and potentially resize as you wish for various resolutions More...

float	MaxRange = 1.5f
	The MaxRange is the maximum distance from its initial center position you can drag the joystick to. More...

Transform	MaxRangeTransform
	in DistanceToTransform mode, the object whose distance to the center will be used to compute the max range. Note that this is computed once, at init. Call RefreshMaxRangeDistance() to recompute it. More...

JoystickEvent	JoystickValue
	An event to use the raw value of the joystick. More...

JoystickEvent	JoystickNormalizedValue
	An event to use the normalized value of the joystick. More...

JoystickFloatEvent	JoystickMagnitudeValue

UnityEvent	OnPointerDownEvent
	An event triggered when tapping the joystick for the first time. More...

UnityEvent	OnDragEvent
	An event triggered when dragging the stick. More...

UnityEvent	OnPointerUpEvent
	An event triggered when releasing the stick. More...

Transform	RotatingIndicator
	an object you can rotate to show the direction of the joystick. Will only be visible if the movement is above a threshold More...

float	RotatingIndicatorThreshold = 0.1f
	the threshold above which the rotating indicator will appear More...

float	PressedOpacity = 0.5f
	the new opacity to apply to the canvas group when the button is pressed More...

bool	InterpolateOpacity = true
	whether or not to interpolate opacity changes on the knob's canvas group More...

float	InterpolateOpacitySpeed = 1f
	the speed at which to interpolate opacity More...

Vector2	RawValue
	the raw value of the joystick, from 0 to 1 on each axis More...

Vector2	NormalizedValue
	the normalized value of the joystick More...

float	Magnitude
	the magnitude of the stick's vector More...

bool	DrawGizmos = true
	whether or not to draw gizmos associated to this stick More...

Protected Member Functions
virtual void	Start ()
	On Start we initialize our stick More...

virtual void	Update ()
	On Update we check for an orientation change if needed, and send our input values. More...

virtual void	HandleOpacity ()
	Changes or interpolates the opacity of the knob More...

virtual void	RotateIndicator ()
	Rotates an indicator to match the rotation of the stick More...

virtual void	ClampToBounds ()
	Clamps the stick to the specified range More...

virtual Vector3	ConvertToWorld (Vector3 position)
	Converts a position to world position More...

virtual float	EvaluateInputValue (float vectorPosition)
	We compute the axis value from the interval between neutral position, current stick position (vectorPosition) and max range More...

virtual void	OnEnable ()
	On enable, we initialize our stick More...

Protected Attributes
Vector2	_neutralPosition

Vector2	_newTargetPosition

Vector3	_newJoystickPosition

float	_initialZPosition

float	_targetOpacity

CanvasGroup	_canvasGroup

float	_initialOpacity

Transform	_knobTransform

bool	_rotatingIndicatorIsNotNull = false

float	_maxRangeTransformDistance

Properties
float?	ComputedMaxRange `[get]`

virtual RenderMode	ParentCanvasRenderMode `[get, protected set]`
	the render mode of the parent canvas this stick is on More...

Detailed Description

Joystick input class. In charge of the behaviour of the joystick mobile touch input. Bind its actions from the inspector Handles mouse and multi touch

Member Enumeration Documentation

◆ MaxRangeModes

enum MoreMountains.Tools.MMTouchJoystick.MaxRangeModes

strong

Enumerator
Distance
DistanceToTransform

Member Function Documentation

◆ ClampToBounds()

virtual void MoreMountains.Tools.MMTouchJoystick.ClampToBounds ( )

protectedvirtual

Clamps the stick to the specified range

Reimplemented in MoreMountains.Tools.MMTouchFollowerJoystick.

◆ ConvertToWorld()

virtual Vector3 MoreMountains.Tools.MMTouchJoystick.ConvertToWorld ( Vector3 position )

protectedvirtual

Converts a position to world position

Parameters

position

Returns

◆ EvaluateInputValue()

virtual float MoreMountains.Tools.MMTouchJoystick.EvaluateInputValue ( float vectorPosition )

protectedvirtual

We compute the axis value from the interval between neutral position, current stick position (vectorPosition) and max range

Returns: The axis value, a float between -1 and 1

Parameters

vectorPosition stick position.

◆ HandleOpacity()

virtual void MoreMountains.Tools.MMTouchJoystick.HandleOpacity ( )

protectedvirtual

Changes or interpolates the opacity of the knob

◆ Initialize()

virtual void MoreMountains.Tools.MMTouchJoystick.Initialize ( )

virtual

Initializes the various parts of the stick

Exceptions

Exception

Reimplemented in MoreMountains.Tools.MMTouchFollowerJoystick, and MoreMountains.Tools.MMTouchRepositionableJoystick.

◆ OnDrag()

virtual void MoreMountains.Tools.MMTouchJoystick.OnDrag ( PointerEventData eventData )

virtual

Handles dragging of the joystick

Reimplemented in MoreMountains.Tools.MMTouchFollowerJoystick.

◆ OnEnable()

virtual void MoreMountains.Tools.MMTouchJoystick.OnEnable ( )

protectedvirtual

On enable, we initialize our stick

◆ OnEndDrag()

virtual void MoreMountains.Tools.MMTouchJoystick.OnEndDrag ( PointerEventData eventData )

virtual

What happens when the stick stops being dragged

◆ OnPointerDown()

virtual void MoreMountains.Tools.MMTouchJoystick.OnPointerDown ( PointerEventData data )

virtual

What happens when the stick is pressed for the first time

Parameters

data

Reimplemented in MoreMountains.Tools.MMTouchFollowerJoystick, and MoreMountains.Tools.MMTouchRepositionableJoystick.

◆ OnPointerUp()

virtual void MoreMountains.Tools.MMTouchJoystick.OnPointerUp ( PointerEventData data )

virtual

What happens when the stick is released (even if no drag happened)

Parameters

data

Reimplemented in MoreMountains.Tools.MMTouchRepositionableJoystick, and MoreMountains.Tools.MMTouchFollowerJoystick.

◆ RefreshMaxRangeDistance()

virtual void MoreMountains.Tools.MMTouchJoystick.RefreshMaxRangeDistance ( )

virtual

This method is used to compute the max range distance when in DistanceToTransform mode

◆ ResetJoystick()

virtual void MoreMountains.Tools.MMTouchJoystick.ResetJoystick ( )

virtual

Resets the stick's position and values

◆ RotateIndicator()

virtual void MoreMountains.Tools.MMTouchJoystick.RotateIndicator ( )

protectedvirtual

Rotates an indicator to match the rotation of the stick

◆ SetKnobTransform()

virtual void MoreMountains.Tools.MMTouchJoystick.SetKnobTransform ( Transform newTransform )

virtual

Assigns a new transform as the joystick knob

Parameters

newTransform

◆ SetNeutralPosition() [1/2]

virtual void MoreMountains.Tools.MMTouchJoystick.SetNeutralPosition ( )

virtual

Sets the neutral position of the joystick

◆ SetNeutralPosition() [2/2]

virtual void MoreMountains.Tools.MMTouchJoystick.SetNeutralPosition ( Vector3 newPosition )

virtual

◆ Start()

virtual void MoreMountains.Tools.MMTouchJoystick.Start ( )

protectedvirtual

On Start we initialize our stick

Reimplemented in MoreMountains.Tools.MMTouchFollowerJoystick, and MoreMountains.Tools.MMTouchRepositionableJoystick.

◆ Update()

virtual void MoreMountains.Tools.MMTouchJoystick.Update ( )

protectedvirtual

On Update we check for an orientation change if needed, and send our input values.

Reimplemented in MoreMountains.Tools.MMTouchFollowerJoystick.

Member Data Documentation

◆ _canvasGroup

CanvasGroup MoreMountains.Tools.MMTouchJoystick._canvasGroup

protected

◆ _initialOpacity

float MoreMountains.Tools.MMTouchJoystick._initialOpacity

protected

◆ _initialZPosition

float MoreMountains.Tools.MMTouchJoystick._initialZPosition

protected

◆ _knobTransform

Transform MoreMountains.Tools.MMTouchJoystick._knobTransform

protected

◆ _maxRangeTransformDistance

float MoreMountains.Tools.MMTouchJoystick._maxRangeTransformDistance

protected

◆ _neutralPosition

Vector2 MoreMountains.Tools.MMTouchJoystick._neutralPosition

protected

◆ _newJoystickPosition

Vector3 MoreMountains.Tools.MMTouchJoystick._newJoystickPosition

protected

◆ _newTargetPosition

Vector2 MoreMountains.Tools.MMTouchJoystick._newTargetPosition

protected

◆ _rotatingIndicatorIsNotNull

bool MoreMountains.Tools.MMTouchJoystick._rotatingIndicatorIsNotNull = false

protected

◆ _targetOpacity

float MoreMountains.Tools.MMTouchJoystick._targetOpacity

protected

◆ DrawGizmos

bool MoreMountains.Tools.MMTouchJoystick.DrawGizmos = true

whether or not to draw gizmos associated to this stick

◆ HorizontalAxisEnabled

bool MoreMountains.Tools.MMTouchJoystick.HorizontalAxisEnabled = true

Is horizontal axis allowed.

◆ InterpolateOpacity

bool MoreMountains.Tools.MMTouchJoystick.InterpolateOpacity = true

whether or not to interpolate opacity changes on the knob's canvas group

◆ InterpolateOpacitySpeed

float MoreMountains.Tools.MMTouchJoystick.InterpolateOpacitySpeed = 1f

the speed at which to interpolate opacity

◆ JoystickMagnitudeValue

JoystickFloatEvent MoreMountains.Tools.MMTouchJoystick.JoystickMagnitudeValue

◆ JoystickNormalizedValue

JoystickEvent MoreMountains.Tools.MMTouchJoystick.JoystickNormalizedValue

An event to use the normalized value of the joystick.

◆ JoystickValue

JoystickEvent MoreMountains.Tools.MMTouchJoystick.JoystickValue

An event to use the raw value of the joystick.

◆ Magnitude

float MoreMountains.Tools.MMTouchJoystick.Magnitude

the magnitude of the stick's vector

◆ MaxRange

float MoreMountains.Tools.MMTouchJoystick.MaxRange = 1.5f

The MaxRange is the maximum distance from its initial center position you can drag the joystick to.

◆ MaxRangeMode

MaxRangeModes MoreMountains.Tools.MMTouchJoystick.MaxRangeMode = MaxRangeModes.Distance

the mode in which to compute the range. Distance will be a flat value, DistanceToTransform will be a distance to a transform you can move around and potentially resize as you wish for various resolutions

◆ MaxRangeTransform

Transform MoreMountains.Tools.MMTouchJoystick.MaxRangeTransform

in DistanceToTransform mode, the object whose distance to the center will be used to compute the max range. Note that this is computed once, at init. Call RefreshMaxRangeDistance() to recompute it.

◆ NormalizedValue

Vector2 MoreMountains.Tools.MMTouchJoystick.NormalizedValue

the normalized value of the joystick

◆ OnDragEvent

UnityEvent MoreMountains.Tools.MMTouchJoystick.OnDragEvent

An event triggered when dragging the stick.

◆ OnPointerDownEvent

UnityEvent MoreMountains.Tools.MMTouchJoystick.OnPointerDownEvent

An event triggered when tapping the joystick for the first time.

◆ OnPointerUpEvent

UnityEvent MoreMountains.Tools.MMTouchJoystick.OnPointerUpEvent

An event triggered when releasing the stick.

◆ PressedOpacity

float MoreMountains.Tools.MMTouchJoystick.PressedOpacity = 0.5f

the new opacity to apply to the canvas group when the button is pressed

◆ RawValue

Vector2 MoreMountains.Tools.MMTouchJoystick.RawValue

the raw value of the joystick, from 0 to 1 on each axis

◆ RotatingIndicator

Transform MoreMountains.Tools.MMTouchJoystick.RotatingIndicator

an object you can rotate to show the direction of the joystick. Will only be visible if the movement is above a threshold

◆ RotatingIndicatorThreshold

float MoreMountains.Tools.MMTouchJoystick.RotatingIndicatorThreshold = 0.1f

the threshold above which the rotating indicator will appear

◆ TargetCamera

Camera MoreMountains.Tools.MMTouchJoystick.TargetCamera

The camera to use as the reference for any ScreenToWorldPoint computations.

◆ VerticalAxisEnabled

bool MoreMountains.Tools.MMTouchJoystick.VerticalAxisEnabled = true

Is vertical axis allowed.

Property Documentation

◆ ComputedMaxRange

float? MoreMountains.Tools.MMTouchJoystick.ComputedMaxRange

get

◆ ParentCanvasRenderMode

virtual RenderMode MoreMountains.Tools.MMTouchJoystick.ParentCanvasRenderMode

getprotected set

the render mode of the parent canvas this stick is on

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

F:/Github/Store/TopDownEngine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMTools/Tools/MMControls/MMTouchJoystick.cs

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ MaxRangeModes

Member Function Documentation

◆ ClampToBounds()

◆ ConvertToWorld()

◆ EvaluateInputValue()

◆ HandleOpacity()

◆ Initialize()

◆ OnDrag()

◆ OnEnable()

◆ OnEndDrag()

◆ OnPointerDown()

◆ OnPointerUp()

◆ RefreshMaxRangeDistance()

◆ ResetJoystick()

◆ RotateIndicator()

◆ SetKnobTransform()

◆ SetNeutralPosition() [1/2]

◆ SetNeutralPosition() [2/2]

◆ Start()

◆ Update()

Member Data Documentation

◆ _canvasGroup

◆ _initialOpacity

◆ _initialZPosition

◆ _knobTransform

◆ _maxRangeTransformDistance

◆ _neutralPosition

◆ _newJoystickPosition

◆ _newTargetPosition

◆ _rotatingIndicatorIsNotNull

◆ _targetOpacity

◆ DrawGizmos

◆ HorizontalAxisEnabled

◆ InterpolateOpacity

◆ InterpolateOpacitySpeed

◆ JoystickMagnitudeValue

◆ JoystickNormalizedValue

◆ JoystickValue

◆ Magnitude

◆ MaxRange

◆ MaxRangeMode

◆ MaxRangeTransform

◆ NormalizedValue

◆ OnDragEvent

◆ OnPointerDownEvent

◆ OnPointerUpEvent

◆ PressedOpacity

◆ RawValue

◆ RotatingIndicator

◆ RotatingIndicatorThreshold

◆ TargetCamera

◆ VerticalAxisEnabled

Property Documentation

◆ ComputedMaxRange

◆ ParentCanvasRenderMode