VR Development Framework
v 1.0.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Pages
Public Member Functions | Public Attributes | Properties | Private Member Functions | Static Private Attributes | List of all members
AVR.UI.AVR_Canvas Class Reference

Represents a canvas for VR interaction purposes. Allows for interaction with the AVR_UIInteractionProvider. More...

Inheritance diagram for AVR.UI.AVR_Canvas:
AVR.Core.AVR_Behaviour

Public Member Functions

override void OnDestroy ()
 
void anchor_to_world ()
 Anchors this canvas to the world. (Sets parent to null) More...
 
void anchor_to_player ()
 Anchors this canvas to the players HMD. Intended for HUD UI elements. More...
 
void anchor_to_controller (AVR_ControllerInputManager controller)
 Anchors the canvas to a given vr controller. More...
 
void anchor_to_transform (Transform t)
 Anchor this canvas to a given transform. Effectively the same as calling transform.SetParent(...) More...
 
Plane GetPlane ()
 Returns the 3d plane this canvas lies in More...
 
void OnPointerEnter (PointerEventData eventData)
 
void OnPointerExit (PointerEventData eventData)
 

Public Attributes

bool isInteractible = true
 If set to false, the UIInteractionprovider will disregard this canvas entirely. More...
 

Properties

static List< AVR_Canvasall_canvases [get, set]
 A list of all AVR_Canvases that have at some point been active and not destroyed since More...
 
static List< AVR_Canvasactive_canvases [get, set]
 A list of all AVR_Canvases that the user is currently interacting with. NOTE: This is not the same as all canvases that are active in the scene. More...
 
Canvas canvas [get, set]
 The UnityEngine.Canvas Component this object is attatched to. More...
 

Private Member Functions

void Awake ()
 
void OnDisable ()
 

Static Private Attributes

static List< AVR_Canvas_all_canvases = new List<AVR_Canvas>()
 
static List< AVR_Canvas_active_canvases = new List<AVR_Canvas>()
 

Additional Inherited Members

- Protected Attributes inherited from AVR.Core.AVR_Behaviour
AVR_PlayerRig playerRig => AVR_PlayerRig.Instance
 The current AVR_PlayerRig instance in the scene More...
 
AVR_Root root => AVR_Root.Instance
 The current AVR_Root instance in the scene More...
 
bool vrEnabled => UnityEngine.XR.XRSettings.enabled
 True if the application is running as a VR/XR application More...
 

Detailed Description

Represents a canvas for VR interaction purposes. Allows for interaction with the AVR_UIInteractionProvider.

Definition at line 17 of file AVR_Canvas.cs.