POINTER_INFO Struct Reference

List of all members.

Public Types
enum	INPUT_EVENT {   NO_CHANGE, PRESS, RELEASE, TAP,   MOVE, MOVE_OFF, RELEASE_OFF, DRAG }
enum	POINTER_TYPE { MOUSE = 0x01, TOUCHPAD = 0x02, MOUSE_TOUCHPAD = 0x03, RAY = 0x04 }
Public Attributes
POINTER_TYPE	type
	The type of pointer this is.
Camera	camera
	The camera with which this pointer was used. This indicates which camera generated the ray information.
int	id
	ID of the pointer.
int	actionID
	ID of the current action. A new action ID is assigned each time the pointer goes "active" anew.
INPUT_EVENT	evt
	The type of event the state of this pointer has generated.
RaycastHit	hitInfo
	Struct that holds info about the raycast hit (if any) against a UI element.
bool	active
	A touch is currently active (finger is still on the pad, mouse button is held, etc).
Vector3	devicePos
	Current position of the input device (mouse, finger, whatever). When using a mouse or touchpad, this is the screen position. When using a ray, this is the position of the pointer in world space as projected from the camera a distance specified by the UIManager's "Ray Depth" value.
Vector3	origPos
	Original position where the touch/click began. When using a mouse or touchpad, this is the screen position. When using a ray, this is the position of the pointer in world space as projected from the camera a distance specified by the UIManager's "Ray Depth" value.
Vector3	inputDelta
	Change in the devicePos since the last polling.
bool	isTap
	Gets set to false after a touch/click moves beyond the drag threshold.
Ray	ray
	The ray projecting into the world for this pointing device.
Ray	prevRay
	The ray from the previous polling.
float	rayDepth
	Depth into the scene the ray is to be/was cast.
IUIObject	targetObj
	The IUIObject that this pointer is affecting, if any.
int	layerMask
	The layer mask for this pointer.
bool	callerIsControl
	Signals whether the caller that is sending this pointer info is a control or not.
float	activeTime
	The time (based on Time.time) that the pointer went active. This value is 0 when the pointer is not active.

---

Detailed Description

Tracks important information about the status of a pointing device (mouse, finger, arbitrary ray)

---

Member Enumeration Documentation

enum POINTER_INFO::INPUT_EVENT

Enum IDs of various input events

Enumerator:

NO_CHANGE	Nothing happened from the last time we polled the device
PRESS	The device has been pressed (mouse button down, screen touched, etc)
RELEASE	The device has been released within the control's area but was not a TAP because the touch traveled beyond the drag threshold. (mouse button up, touch ended, etc)
TAP	The device has been released as a tap (mouse button up, touch ended, etc)
MOVE	The device was moved (mouse moved with no buttons down)
MOVE_OFF	The device has left the area of the control.
RELEASE_OFF	The device was released (mouse button was released/finger was let go, etc) outside of the control's area.
DRAG	The device was moved while being pressed (mouse moved with button down, touch was dragged, etc)

enum POINTER_INFO::POINTER_TYPE

Enumerator:

MOUSE	The pointer type is a mouse.
TOUCHPAD	The pointer type is a touchpad touch.
MOUSE_TOUCHPAD	The pointer type is either mouse or touchpad.
RAY	The pointer is a ray pointer.

---

Member Data Documentation

int POINTER_INFO.actionID

ID of the current action. A new action ID is assigned each time the pointer goes "active" anew.

bool POINTER_INFO.active

A touch is currently active (finger is still on the pad, mouse button is held, etc).

float POINTER_INFO.activeTime

The time (based on Time.time) that the pointer went active. This value is 0 when the pointer is not active.

bool POINTER_INFO.callerIsControl

Signals whether the caller that is sending this pointer info is a control or not.

Camera POINTER_INFO.camera

The camera with which this pointer was used. This indicates which camera generated the ray information.

Vector3 POINTER_INFO.devicePos

Current position of the input device (mouse, finger, whatever). When using a mouse or touchpad, this is the screen position. When using a ray, this is the position of the pointer in world space as projected from the camera a distance specified by the UIManager's "Ray Depth" value.

INPUT_EVENT POINTER_INFO.evt

The type of event the state of this pointer has generated.

RaycastHit POINTER_INFO.hitInfo

Struct that holds info about the raycast hit (if any) against a UI element.

int POINTER_INFO.id

ID of the pointer.

Vector3 POINTER_INFO.inputDelta

Change in the devicePos since the last polling.

bool POINTER_INFO.isTap

Gets set to false after a touch/click moves beyond the drag threshold.

int POINTER_INFO.layerMask

The layer mask for this pointer.

Vector3 POINTER_INFO.origPos

Original position where the touch/click began. When using a mouse or touchpad, this is the screen position. When using a ray, this is the position of the pointer in world space as projected from the camera a distance specified by the UIManager's "Ray Depth" value.

Ray POINTER_INFO.prevRay

The ray from the previous polling.

Ray POINTER_INFO.ray

The ray projecting into the world for this pointing device.

float POINTER_INFO.rayDepth

Depth into the scene the ray is to be/was cast.

IUIObject POINTER_INFO.targetObj

The IUIObject that this pointer is affecting, if any.

POINTER_TYPE POINTER_INFO.type

The type of pointer this is.

---

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

• UIManager.cs