TouchInteractable Class

Base class for interactable touch controls.

Inheritance Hierarchy

System.Object
  Object
    Component
      Behaviour
        MonoBehaviour
          Rewired.ComponentControls.ComponentControl
            Rewired.ComponentControls.CustomControllerControl
              Rewired.ComponentControls.TouchControl
                Rewired.ComponentControls.TouchInteractable
                  Rewired.ComponentControls.TouchButton
                  Rewired.ComponentControls.TouchJoystick
                  Rewired.ComponentControls.TouchPad
                  Rewired.ComponentControls.TouchRegion

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

Syntax

Copy

[SerializableAttribute]
public abstract class TouchInteractable : TouchControl, 
	IPointerDownHandler, IEventSystemHandler, IPointerUpHandler, IPointerEnterHandler, IPointerExitHandler, 
	IBeginDragHandler, IDragHandler, IEndDragHandler

The TouchInteractable type exposes the following members.

Properties

	Name	Description
	allowedMouseButtons	The mouse buttons that are allowed to interact with this control.
	animation	(Inherited from Component) Obsolete
	animator	Gets the Animator component on this GameObject. Returns null if no Animator component is found.
	audio	(Inherited from Component) Obsolete
	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
	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.
	hingeJoint	(Inherited from Component) Obsolete
	image	Gets the Target Graphic as an Image. If the Target Graphic is not an Image, this will return null.
	interactable	Can the control can be interacted with by the user?
	interactionState	The current interaction state.
	isActiveAndEnabled	(Inherited from Behaviour)
	light	(Inherited from Component) Obsolete
	name	(Inherited from Object)
	networkView	(Inherited from Component) Obsolete
	particleSystem	(Inherited from Component) Obsolete
	renderer	(Inherited from Component) Obsolete
	rigidbody	(Inherited from Component) Obsolete
	rigidbody2D	(Inherited from Component) Obsolete
	runInEditMode	(Inherited from MonoBehaviour)
	tag	(Inherited from Component)
	targetGraphic	The target Graphic component for interaction state transitions.
	transform	(Inherited from Component)
	transitionAnimationTriggers	Settings using for Animation Trigger transitions.
	transitionColorTint	Settings using for Color Tins transitions.
	transitionSpriteState	Settings using for Sprite State transitions.
	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.
	useGUILayout	(Inherited from MonoBehaviour)
	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.

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	(Inherited from ComponentControl)
	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, List<Component>)	(Inherited from Component)
	GetComponents``1()	(Inherited from Component)
	GetComponents``1(List<UMP>)	(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(List<UMP>)	(Inherited from Component)
	GetComponentsInChildren``1(Boolean, List<UMP>)	(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, List<UMP>)	(Inherited from Component)
	GetHashCode	(Inherited from Object)
	GetInstanceID	(Inherited from Object)
	Invoke	(Inherited from MonoBehaviour)
	InvokeRepeating	(Inherited from MonoBehaviour)
	IsInteractable
	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.
	InteractionStateChangedToHighlighted	Event sent when interaction state changes to Highlighted.
	InteractionStateChangedToNormal	Event sent when interaction state changes to Normal.
	InteractionStateChangedToPressed	Event sent when interaction state changes to Pressed.
	InteractionStateSetEvent	Event sent when the Interaction State changes.
	VisibilityChangedEvent	Event sent when visibility changes.

Top

Fields

	Name	Description
	POINTER_ID_MOUSE_LEFT_BUTTON
	POINTER_ID_MOUSE_MIDDLE_BUTTON
	POINTER_ID_MOUSE_RIGHT_BUTTON
	POINTER_ID_NULL

Top

Reference

Rewired.ComponentControls Namespace