Class GraphicRaycaster

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
UIBehaviour
BaseRaycaster
GraphicRaycaster
Inherited Members
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
UnityEngine.Object.FindFirstObjectByType<T>()
UnityEngine.Object.FindAnyObjectByType<T>()
UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)
UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)
Namespace: UnityEngine.UI
Syntax
[AddComponentMenu("Event/Graphic Raycaster")]
[RequireComponent(typeof(Canvas))]
public class GraphicRaycaster : BaseRaycaster

Constructors

GraphicRaycaster()

Declaration
protected GraphicRaycaster()

Fields

kNoEventMaskSet

Declaration
protected const int kNoEventMaskSet = -1
Field Value
Type Description
Int32

m_BlockingMask

Declaration
[SerializeField]
protected LayerMask m_BlockingMask
Field Value
Type Description
LayerMask

Properties

blockingMask

The type of objects specified through LayerMask that are checked to determine if they block graphic raycasts.

Declaration
public LayerMask blockingMask { get; set; }
Property Value
Type Description
LayerMask

blockingObjects

The type of objects that are checked to determine if they block graphic raycasts.

Declaration
public GraphicRaycaster.BlockingObjects blockingObjects { get; set; }
Property Value
Type Description
GraphicRaycaster.BlockingObjects

eventCamera

The camera that will generate rays for this raycaster.

Declaration
public override Camera eventCamera { get; }
Property Value
Type Description
Camera
  • Null if Camera mode is ScreenSpaceOverlay or ScreenSpaceCamera and has no camera.
  • canvas.worldCanvas if not null
  • Camera.main.
Overrides

ignoreReversedGraphics

Whether Graphics facing away from the raycaster are checked for raycasts.

Declaration
public bool ignoreReversedGraphics { get; set; }
Property Value
Type Description
Boolean

renderOrderPriority

Priority of the raycaster based upon render order.

Declaration
public override int renderOrderPriority { get; }
Property Value
Type Description
Int32

The renderOrder priority.
Overrides

sortOrderPriority

Priority of the raycaster based upon sort order.

Declaration
public override int sortOrderPriority { get; }
Property Value
Type Description
Int32

The sortOrder priority.
Overrides

Methods

Raycast(PointerEventData, List<RaycastResult>)

Perform the raycast against the list of graphics associated with the Canvas.

Declaration
public override void Raycast(PointerEventData eventData, List<RaycastResult> resultAppendList)
Parameters
Type Name Description
PointerEventData eventData

Current event data
List<RaycastResult> resultAppendList

List of hit objects to append new results to.
Overrides

Extension Methods