OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | List of all members
OmegaEngine.Input.IInputReceiver Interface Reference

An object that receives input procesed into navigational commands from an InputProvider. More...

Inheritance diagram for OmegaEngine.Input.IInputReceiver:
OmegaEngine.Input.UpdateReceiver

Public Member Functions

void PerspectiveChange (Point pan, int rotation, int zoom)
 Called when the user changes the view perspective. More...
 
void Hover (Point target)
 Called when the user is hovering above a point on the screen. More...
 
void AreaSelection (Rectangle area, bool accumulate, bool done)
 Called when the user is selecting an area on the screen. More...
 
void Click (MouseEventArgs e, bool accumulate)
 Called when the user clicked something (not dragged!). More...
 
void DoubleClick (MouseEventArgs e)
 Called when the user double-clicked something. More...
 

Detailed Description

An object that receives input procesed into navigational commands from an InputProvider.

Member Function Documentation

void OmegaEngine.Input.IInputReceiver.AreaSelection ( Rectangle  area,
bool  accumulate,
bool  done 
)

Called when the user is selecting an area on the screen.

Parameters
areaThe selected area in pixels. The bottom-right corner is always the last point selected by the user, therefore the box may be inverted.
accumulatetrue when the user wants the new selection to be added to the old one.
doneTrue when the user has finished his selection (e.g. released the mouse).

Implemented in OmegaEngine.Input.UpdateReceiver.

void OmegaEngine.Input.IInputReceiver.Click ( MouseEventArgs  e,
bool  accumulate 
)

Called when the user clicked something (not dragged!).

Parameters
eThe original event arguments from the click.
accumulatetrue when the user wants the action to have an accumulative effect (usually for selections).

Implemented in OmegaEngine.Input.UpdateReceiver.

void OmegaEngine.Input.IInputReceiver.DoubleClick ( MouseEventArgs  e)

Called when the user double-clicked something.

Parameters
eThe original event arguments from the click.

Implemented in OmegaEngine.Input.UpdateReceiver.

void OmegaEngine.Input.IInputReceiver.Hover ( Point  target)

Called when the user is hovering above a point on the screen.

Parameters
targetThe point the user is hovering over in pixels.

Implemented in OmegaEngine.Input.UpdateReceiver.

void OmegaEngine.Input.IInputReceiver.PerspectiveChange ( Point  pan,
int  rotation,
int  zoom 
)

Called when the user changes the view perspective.

Parameters
panHorizontal XY-panning in pixels.
rotationHorizontal rotation in pixels.
zoomVertical zooming in pixels. Greater than 0 to zoom in; less than 0 to zoom out.

Implemented in OmegaEngine.Input.UpdateReceiver.


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