< Home

< Table of Contents

REFERENCE MANUAL

HPS.MouseState Class Reference

The MouseState class represents the state of the mouse or similar pointer device for a particular event. More...

Inheritance diagram for HPS.MouseState:
HPS.Object

Public Member Functions

void Assign (HPS.MouseState in_that)
 Copies the source MouseState into this MouseState. More...
 
override void Dispose ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.MouseState in_that)
 Check if the source MouseState is equivalent to this MouseState. More...
 
HPS.MouseEvent GetActiveEvent ()
 Get the active event for this MouseState. More...
 
HPS.MouseButtons GetButtons ()
 Get the current state of the mouse buttons immediately after the active event. More...
 
HPS.Key[] GetEventPath ()
 Get the relevant list of keys up to the window which had focus when the mouse represented by this MouseState underwent the active action. More...
 
HPS.WindowKey GetEventSource ()
 Get the window which had focus when the mouse represented by this MouseState underwent the active action. More...
 
override int GetHashCode ()
 
HPS.WindowPoint GetLocation ()
 Get the current mouse position. More...
 
HPS.ModifierKeys GetModifierKeys ()
 Get an object representing the state of modifier keys for this TouchState. More...
 
 MouseState ()
 The default constructor creates an empty MouseState object. More...
 
 MouseState (HPS.MouseState in_that)
 The copy constructor creates a new MouseState object that contains the same settings as the source MouseState. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Static Public Member Functions

static bool operator!= (HPS.MouseState a, HPS.MouseState b)
 
static bool operator== (HPS.MouseState a, HPS.MouseState b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The MouseState class represents the state of the mouse or similar pointer device for a particular event.

Constructor & Destructor Documentation

HPS.MouseState.MouseState ( )

The default constructor creates an empty MouseState object.

HPS.MouseState.MouseState ( HPS.MouseState  in_that)

The copy constructor creates a new MouseState object that contains the same settings as the source MouseState.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_mouse_state" kindref="compound">MouseState</ref> to copy.

Member Function Documentation

void HPS.MouseState.Assign ( HPS.MouseState  in_that)

Copies the source MouseState into this MouseState.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_mouse_state" kindref="compound">MouseState</ref> to copy.
bool HPS.MouseState.Equals ( HPS.MouseState  in_that)

Check if the source MouseState is equivalent to this MouseState.

Returns
true if the objects are equivalent, false otherwise.
HPS.MouseEvent HPS.MouseState.GetActiveEvent ( )

Get the active event for this MouseState.

This will throw an exception if there is no active action for this MouseState.

Returns
The action for this MouseState.
HPS.MouseButtons HPS.MouseState.GetButtons ( )

Get the current state of the mouse buttons immediately after the active event.

Returns
The state of the mouse buttons.
HPS.Key [] HPS.MouseState.GetEventPath ( )

Get the relevant list of keys up to the window which had focus when the mouse represented by this MouseState underwent the active action.

This will throw an exception if there is no event path for this MouseState.

Returns
The relevant list of keys up to the window which had focus when the mouse represented by this MouseState underwent the active action.
HPS.WindowKey HPS.MouseState.GetEventSource ( )

Get the window which had focus when the mouse represented by this MouseState underwent the active action.

This will throw an exception if there is no event source for this MouseState.

Returns
The window which had focus when the mouse represented by this MouseState underwent the active action.
HPS.WindowPoint HPS.MouseState.GetLocation ( )

Get the current mouse position.

Returns
The location, in window space of the mouse cursor.
HPS.ModifierKeys HPS.MouseState.GetModifierKeys ( )

Get an object representing the state of modifier keys for this TouchState.

Returns
An object representing the state of modifier keys.
override HPS.Type HPS.MouseState.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.


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