Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Paradox.Input.PointerEvent Class Reference

A pointer event. More...

Inheritance diagram for SiliconStudio.Paradox.Input.PointerEvent:
EventArgs

Public Member Functions

PointerEvent Clone ()
 Clones this instance. More...
 
override string ToString ()
 

Properties

int PointerId [get, set]
 Gets a unique identifier of the pointer. See remarks. More...
 
Vector2 Position [get, set]
 Gets the absolute screen position of the pointer. More...
 
Vector2 DeltaPosition [get, set]
 Gets the delta position of the pointer since the previous frame. More...
 
TimeSpan DeltaTime [get, set]
 Gets the amount of time since the previous state. More...
 
PointerState State [get, set]
 Gets the state of this pointer event (down, up, move... etc.) More...
 
PointerType PointerType [get, set]
 Gets the type of the pointer. More...
 
bool IsPrimary [get, set]
 Gets a boolean indicating whether this is the default primary pointer. More...
 

Detailed Description

A pointer event.

Definition at line 12 of file PointerEvent.cs.

Member Function Documentation

PointerEvent SiliconStudio.Paradox.Input.PointerEvent.Clone ( )

Clones this instance.

Returns
PointerEvent.

Definition at line 97 of file PointerEvent.cs.

override string SiliconStudio.Paradox.Input.PointerEvent.ToString ( )

Definition at line 112 of file PointerEvent.cs.

Property Documentation

Vector2 SiliconStudio.Paradox.Input.PointerEvent.DeltaPosition
getset

Gets the delta position of the pointer since the previous frame.

The delta position.

Definition at line 67 of file PointerEvent.cs.

TimeSpan SiliconStudio.Paradox.Input.PointerEvent.DeltaTime
getset

Gets the amount of time since the previous state.

The delta time.

Definition at line 73 of file PointerEvent.cs.

bool SiliconStudio.Paradox.Input.PointerEvent.IsPrimary
getset

Gets a boolean indicating whether this is the default primary pointer.

true if this instance is primary; otherwise, false.

Definition at line 91 of file PointerEvent.cs.

int SiliconStudio.Paradox.Input.PointerEvent.PointerId
getset

Gets a unique identifier of the pointer. See remarks.

The pointer id.

The default mouse pointer will always be affected to the PointerId 0. On a tablet, a pen or each fingers will get a unique identifier.

Definition at line 55 of file PointerEvent.cs.

PointerType SiliconStudio.Paradox.Input.PointerEvent.PointerType
getset

Gets the type of the pointer.

The type of the pointer.

Definition at line 85 of file PointerEvent.cs.

Vector2 SiliconStudio.Paradox.Input.PointerEvent.Position
getset

Gets the absolute screen position of the pointer.

The position.

Definition at line 61 of file PointerEvent.cs.

PointerState SiliconStudio.Paradox.Input.PointerEvent.State
getset

Gets the state of this pointer event (down, up, move... etc.)

The state.

Definition at line 79 of file PointerEvent.cs.


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