TouchPad Class

A touch pad control.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Rewired.ComponentControlsComponentControl
            Rewired.ComponentControlsCustomControllerControl
              Rewired.ComponentControlsTouchControl
                Rewired.ComponentControlsTouchInteractable
                  Rewired.ComponentControlsTouchPad

Namespace: Rewired.ComponentControls
Assembly: Rewired_Core (in Rewired_Core.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Copy

[SerializableAttribute]
public sealed class TouchPad : TouchInteractable, 
	IPointerDownHandler, IEventSystemHandler, IPointerUpHandler

The TouchPad type exposes the following members.

Properties

	Name	Description
	activateOnSwipeIn	If true, the touch pad can be activated by a touch swipe that began in an area outside the touch pad region. If false, the touch pad can only be activated by a direct touch.
	allowedMouseButtons	The mouse buttons that are allowed to interact with this control. (Inherited from TouchInteractable)
	allowPress	Should presses (continual press like a button) on the touch pad be processed?
	allowTap	Should taps on the touch pad be processed?
	animation	(Inherited from Component) Obsolete
	animator	Gets the Animator component on this GameObject. Returns null if no Animator component is found. (Inherited from TouchInteractable)
	audio	(Inherited from Component) Obsolete
	axesToUse	The axis directions in which movement is allowed. You can restrict movement to one or both axes.
	axis2DCalibration	The calibration settings for the 2D axis.
	camera	(Inherited from Component) Obsolete
	collider	(Inherited from Component) Obsolete
	collider2D	(Inherited from Component) Obsolete
	constantForce	(Inherited from Component) Obsolete
	enabled	(Inherited from Behaviour)
	gameObject	(Inherited from Component)
	guiElement	(Inherited from Component) Obsolete
	guiText	(Inherited from Component) Obsolete
	guiTexture	(Inherited from Component) Obsolete
	hasPointer	Is this control currently being controlled by a touch or pointer?
	hideAtRuntime	If enabled, the control will be hidden when gameplay starts.
	hideFlags	(Inherited from Object)
	hideWhenIdle	Sets visibility to False when the control is idle. When the control is no longer idle, visibility will be set to True again. (Inherited from TouchInteractable)
	hingeJoint	(Inherited from Component) Obsolete
	horizontalAxisCalibration	The calibration settings for the horizontal axis.
	horizontalAxisCustomControllerElement	The Custom Controller element that will receive input values from the touch pad's X axis.
	image	Gets the Target Graphic as an Image. If the Target Graphic is not an Image, this will return null. (Inherited from TouchInteractable)
	inertiaFriction	Determines how quickly a swipe value will fall toward zero when useInertia is True.
	interactable	Can the control can be interacted with by the user? (Inherited from TouchInteractable)
	interactionState	The current interaction state. (Inherited from TouchInteractable)
	isActiveAndEnabled	(Inherited from Behaviour)
	light	(Inherited from Component) Obsolete
	name	(Inherited from Object)
	networkView	(Inherited from Component) Obsolete
	particleSystem	(Inherited from Component) Obsolete
	pointerId	The pointer id that currently has control of this control. If there is no pointer id, the value is TouchControl.POINTER_ID_NULL. Only one pointer id (touch, mouse, etc.) may be in control of this button at any time.
	pressCustomControllerElement	The Custom Controller element that will receive input values from touch pad presses.
	pressDistanceLimit	The maximum movement distance allowed in pixels since the touch began for the touch to be considered a press. Any movement beyond this value will cancel the press. [-1 = no limit]
	pressStartDelay	Time the touch pad must be touched before it will be considered a press.
	renderer	(Inherited from Component) Obsolete
	rigidbody	(Inherited from Component) Obsolete
	rigidbody2D	(Inherited from Component) Obsolete
	runInEditMode	(Inherited from MonoBehaviour)
	stayActiveOnSwipeOut	If true, the touch pad will stay engaged even if the touch that activated it moves outside the touch pad region. If false, the touch pad will be released once the touch that activated it moves outside the touch pad region.
	tag	(Inherited from Component)
	tapCustomControllerElement	The Custom Controller element that will receive input values from touch pad taps.
	tapDistanceLimit	The maximum movement distance allowed in pixels since the touch began for the touch to be considered a tap. [-1 = no limit]
	tapTimeout	The maximum touch duration allowed for the touch to be considered a tap.
	targetGraphic	The target Graphic component for interaction state transitions. (Inherited from TouchInteractable)
	touchPadMode	The mode of the touch pad.
	touchPosition	The current position of the touch.
	touchStartPosition	The position of the initial touch.
	transform	(Inherited from Component)
	transitionAnimationTriggers	Settings using for Animation Trigger transitions. (Inherited from TouchInteractable)
	transitionColorTint	Settings using for Color Tins transitions. (Inherited from TouchInteractable)
	transitionSpriteState	Settings using for Sprite State transitions. (Inherited from TouchInteractable)
	transitionType	The transition type(s) to be used when transitioning to various states. Multiple transition types can be used simultaneously. Denote multiple transition types using bitwise operations. (Inherited from TouchInteractable)
	useGUILayout	(Inherited from MonoBehaviour)
	useInertia	If enabled, when swiped and released, the value will slowly fall toward zero based on the Friction value. This only has an effect if touchPadMode is set to TouchPadMode.PositionDelta.
	valueFormat	The format of the resulting data generated by the touch pad.
	verticalAxisCalibration	The calibration settings for the vertical axis.
	verticalAxisCustomControllerElement	The Custom Controller element that will receive input values from the touch pad's Y axis.
	visible	Is the control visible? An invisible control can still be interacted with. This property only has any effect when used with an Image Component. (Inherited from TouchInteractable)

Top

Methods

	Name	Description
	BroadcastMessage(String)	(Inherited from Component)
	BroadcastMessage(String, Object)	(Inherited from Component)
	BroadcastMessage(String, SendMessageOptions)	(Inherited from Component)
	BroadcastMessage(String, Object, SendMessageOptions)	(Inherited from Component)
	CancelInvoke	(Inherited from MonoBehaviour)
	CancelInvoke(String)	(Inherited from MonoBehaviour)
	ClearValue	(Overrides ComponentControlClearValue)
	CompareTag	(Inherited from Component)
	Equals	(Inherited from Object)
	GetComponent(String)	(Inherited from Component)
	GetComponent(Type)	(Inherited from Component)
	GetComponent``1	(Inherited from Component)
	GetComponentInChildren(Type)	(Inherited from Component)
	GetComponentInChildren(Type, Boolean)	(Inherited from Component)
	GetComponentInChildren``1	(Inherited from Component)
	GetComponentInChildren``1(Boolean)	(Inherited from Component)
	GetComponentInParent(Type)	(Inherited from Component)
	GetComponentInParent``1	(Inherited from Component)
	GetComponents(Type)	(Inherited from Component)
	GetComponents(Type, ListComponent)	(Inherited from Component)
	GetComponents``1	(Inherited from Component)
	GetComponents``1(ListUMP)	(Inherited from Component)
	GetComponentsInChildren(Type)	(Inherited from Component)
	GetComponentsInChildren(Type, Boolean)	(Inherited from Component)
	GetComponentsInChildren``1	(Inherited from Component)
	GetComponentsInChildren``1(Boolean)	(Inherited from Component)
	GetComponentsInChildren``1(ListUMP)	(Inherited from Component)
	GetComponentsInChildren``1(Boolean, ListUMP)	(Inherited from Component)
	GetComponentsInParent(Type)	(Inherited from Component)
	GetComponentsInParent(Type, Boolean)	(Inherited from Component)
	GetComponentsInParent``1	(Inherited from Component)
	GetComponentsInParent``1(Boolean)	(Inherited from Component)
	GetComponentsInParent``1(Boolean, ListUMP)	(Inherited from Component)
	GetHashCode	(Inherited from Object)
	GetInstanceID	(Inherited from Object)
	Invoke	(Inherited from MonoBehaviour)
	InvokeRepeating	(Inherited from MonoBehaviour)
	IsInteractable	(Inherited from TouchInteractable)
	IsInvoking	(Inherited from MonoBehaviour)
	IsInvoking(String)	(Inherited from MonoBehaviour)
	SendMessage(String)	(Inherited from Component)
	SendMessage(String, Object)	(Inherited from Component)
	SendMessage(String, SendMessageOptions)	(Inherited from Component)
	SendMessage(String, Object, SendMessageOptions)	(Inherited from Component)
	SendMessageUpwards(String)	(Inherited from Component)
	SendMessageUpwards(String, Object)	(Inherited from Component)
	SendMessageUpwards(String, SendMessageOptions)	(Inherited from Component)
	SendMessageUpwards(String, Object, SendMessageOptions)	(Inherited from Component)
	StartCoroutine(IEnumerator)	(Inherited from MonoBehaviour)
	StartCoroutine(String)	(Inherited from MonoBehaviour)
	StartCoroutine(String, Object)	(Inherited from MonoBehaviour)
	StartCoroutine_Auto	(Inherited from MonoBehaviour) Obsolete
	StopAllCoroutines	(Inherited from MonoBehaviour)
	StopCoroutine(Coroutine)	(Inherited from MonoBehaviour)
	StopCoroutine(IEnumerator)	(Inherited from MonoBehaviour)
	StopCoroutine(String)	(Inherited from MonoBehaviour)
	ToString	(Inherited from Object)

Top

Events

	Name	Description
	InteractionStateChangedToDisabled	Event sent when interaction state changes to Disabled. (Inherited from TouchInteractable)
	InteractionStateChangedToHighlighted	Event sent when interaction state changes to Highlighted. (Inherited from TouchInteractable)
	InteractionStateChangedToNormal	Event sent when interaction state changes to Normal. (Inherited from TouchInteractable)
	InteractionStateChangedToPressed	Event sent when interaction state changes to Pressed. (Inherited from TouchInteractable)
	InteractionStateSetEvent	Event sent when the Interaction State changes. (Inherited from TouchInteractable)
	PressDownEvent	Event sent when the touch pad is initally pressed. This event is for the Press button simulation which must be enabled by setting Press Allowed to True. This event will only be sent if allowPress is True.
	PressUpEvent	Event sent when the touch pad is released after a press. This event is for the Press button simulation which must be enabled by setting Press Allowed to True. This event will only be sent if allowPress is True.
	TapEvent	Event sent when the touch pad is tapped. This event will only be sent if allowTap is True.
	ValueChangedEvent	Event sent when the value changes.
	VisibilityChangedEvent	Event sent when visibility changes. (Inherited from TouchInteractable)

Top

Reference

Rewired.ComponentControls Namespace