Murl::Input::IScreenArea Interface Referenceabstract

The IScreenArea interface. More...

#include "murl_input_i_screen_area.h"

Inherited by Murl::Input::ScreenArea.

Public Member Functions

virtual Bool SetInCoord (Real x1, Real y1, Real x2, Real y2)=0
 Set the area's input coordinate range. More...
 
virtual Bool SetInCoord1 (Real x1, Real y1)=0
 Set the area's input coordinate start. More...
 
virtual Bool SetInCoord2 (Real x2, Real y2)=0
 Set the area's input coordinate end. More...
 
virtual Bool SetInCoordX1 (Real x1)=0
 Set the area's horizontal start input coordinate. More...
 
virtual Bool SetInCoordY1 (Real y1)=0
 Set the area's vertical start input coordinates. More...
 
virtual Bool SetInCoordX2 (Real x2)=0
 Set the area's horizontal end input coordinate. More...
 
virtual Bool SetInCoordY2 (Real y2)=0
 Set the area's vertical end input coordinates. More...
 
virtual Real GetInCoordX1 () const =0
 Get the area's horizontal start input coordinate. More...
 
virtual Real GetInCoordY1 () const =0
 Get the area's vertical start input coordinate. More...
 
virtual Real GetInCoordX2 () const =0
 Get the area's horizontal end input coordinate. More...
 
virtual Real GetInCoordY2 () const =0
 Get the area's vertical end input coordinate. More...
 

Detailed Description

The IScreenArea interface.

The IScreenArea object can be created by the ITouchableHandler object.

Member Function Documentation

◆ SetInCoord()

virtual Bool Murl::Input::IScreenArea::SetInCoord ( Real  x1,
Real  y1,
Real  x2,
Real  y2 
)
pure virtual

Set the area's input coordinate range.

This method sets the area's start and end input coordinates.

Parameters
x1The start coordinate in X direction.
y1The start coordinate in Y direction.
x2The end coordinate in X direction.
y2The end coordinate in Y direction.
Returns
true if successful.

◆ SetInCoord1()

virtual Bool Murl::Input::IScreenArea::SetInCoord1 ( Real  x1,
Real  y1 
)
pure virtual

Set the area's input coordinate start.

See SetInCoord().

Parameters
x1The start coordinate in X direction.
y1The start coordinate in Y direction.
Returns
true if successful.

◆ SetInCoord2()

virtual Bool Murl::Input::IScreenArea::SetInCoord2 ( Real  x2,
Real  y2 
)
pure virtual

Set the area's input coordinate end.

See SetInCoord().

Parameters
x2The end coordinate in X direction.
y2The end coordinate in Y direction.
Returns
true if successful.

◆ SetInCoordX1()

virtual Bool Murl::Input::IScreenArea::SetInCoordX1 ( Real  x1)
pure virtual

Set the area's horizontal start input coordinate.

See SetInCoord().

Parameters
x1The start coordinate in X direction.
Returns
true if successful.

◆ SetInCoordY1()

virtual Bool Murl::Input::IScreenArea::SetInCoordY1 ( Real  y1)
pure virtual

Set the area's vertical start input coordinates.

See SetInCoord().

Parameters
y1The start coordinate in Y direction.
Returns
true if successful.

◆ SetInCoordX2()

virtual Bool Murl::Input::IScreenArea::SetInCoordX2 ( Real  x2)
pure virtual

Set the area's horizontal end input coordinate.

See SetInCoord().

Parameters
x2The end coordinate in X direction.
Returns
true if successful.

◆ SetInCoordY2()

virtual Bool Murl::Input::IScreenArea::SetInCoordY2 ( Real  y2)
pure virtual

Set the area's vertical end input coordinates.

See SetInCoord().

Parameters
y2The end coordinate in Y direction.
Returns
true if successful.

◆ GetInCoordX1()

virtual Real Murl::Input::IScreenArea::GetInCoordX1 ( ) const
pure virtual

Get the area's horizontal start input coordinate.

See SetInCoord().

Returns
The start coordinate in X direction.

◆ GetInCoordY1()

virtual Real Murl::Input::IScreenArea::GetInCoordY1 ( ) const
pure virtual

Get the area's vertical start input coordinate.

See SetInCoord().

Returns
The start coordinate in Y direction.

◆ GetInCoordX2()

virtual Real Murl::Input::IScreenArea::GetInCoordX2 ( ) const
pure virtual

Get the area's horizontal end input coordinate.

See SetInCoord().

Returns
The end coordinate in X direction.

◆ GetInCoordY2()

virtual Real Murl::Input::IScreenArea::GetInCoordY2 ( ) const
pure virtual

Get the area's vertical end input coordinate.

See SetInCoord().

Returns
The end coordinate in Y direction.

The documentation for this interface was generated from the following file:
  • murl_input_i_screen_area.h


Copyright © 2011-2018 Spraylight GmbH.