Murl::Input::ITouchArea Interface Reference

The ITouchArea interface. More...

#include "murl_input_i_touch_area.h"

Inherited by Murl::Input::TouchArea.

Public Member Functions
virtual Bool	SetActiveFaces (IEnums::PolygonFaces faces)=0
	Set which faces of the touch area are active. More...
virtual IEnums::PolygonFaces	GetActiveFaces () const =0
	Check which faces of the touch area are active. More...
virtual Bool	SetOutCoord (Real x1, Real y1, Real x2, Real y2)=0
	Set the button's output coordinate range. More...
virtual Bool	SetOutCoord1 (Real x1, Real y1)=0
	Set the button's output coordinate start. More...
virtual Bool	SetOutCoord2 (Real x2, Real y2)=0
	Set the button's output coordinate end. More...
virtual Bool	SetOutCoordX1 (Real x1)=0
	Set the button's horizontal start output coordinate. More...
virtual Bool	SetOutCoordY1 (Real y1)=0
	Set the button's vertical start output coordinates. More...
virtual Bool	SetOutCoordX2 (Real x2)=0
	Set the button's horizontal end output coordinate. More...
virtual Bool	SetOutCoordY2 (Real y2)=0
	Set the button's vertical end output coordinates. More...
virtual Real	GetOutCoordX1 () const =0
	Get the button's horizontal start output coordinate. More...
virtual Real	GetOutCoordY1 () const =0
	Get the button's vertical start output coordinate. More...
virtual Real	GetOutCoordX2 () const =0
	Get the button's horizontal end output coordinate. More...
virtual Real	GetOutCoordY2 () const =0
	Get the button's vertical end output coordinate. More...
virtual Bool	SetOutCoordClippingEnabled (Bool enable)=0
	Enable or disable output coordinate clipping. More...
virtual Bool	IsOutCoordClippingEnabled () const =0
	Check if output coordinate clipping is enabled. More...
virtual void	SetResponseTarget (Graph::ITouchReporter *node)=0
	Set the response target object. More...
virtual Graph::ITouchReporter *	GetResponseTarget () const =0
	Get the response target object. More...
virtual void	SetResponseButton (IEnums::MouseButton button)=0
	Set the response button. More...
virtual IEnums::MouseButton	GetResponseButton () const =0
	Get the response button. More...
virtual void	SetPassEventsEnabled (Bool enable)=0
	Set the pass events state. More...
virtual Bool	IsPassEventsEnabled () const =0
	Check the pass events state. More...

Detailed Description

The ITouchArea interface.

The ITouchArea object can be created by the ITouchableHandler object.

Member Function Documentation

SetActiveFaces()

virtual Bool Murl::Input::ITouchArea::SetActiveFaces ( IEnums::PolygonFaces  faces )

pure virtual

Set which faces of the touch area are active.

Parameters

faces

One of the available IEnums::PolygonFaces enumeration values.

Returns

true if successful.

GetActiveFaces()

virtual IEnums::PolygonFaces Murl::Input::ITouchArea::GetActiveFaces ( ) const

pure virtual

Check which faces of the touch area are active.

Returns

One of the available IEnums::PolygonFaces enumeration values.

SetOutCoord()

virtual Bool Murl::Input::ITouchArea::SetOutCoord ( Real  x1, Real  y1, Real  x2, Real  y2  )

pure virtual

Set the button's output coordinate range.

This method sets the button's start and end output coordinates. In contrast to a button event's local intersection point, which always represents the actual intersection in object-space 3D coordinates, an event's output coordinate represents a 2D intersection on the button's clickable surface. This can be interpreted analogously to a renderable geometry, with 3D vertex coordinates and 2D texture coordinates.

Parameters

x1	The start coordinate in X direction.
y1	The start coordinate in Y direction.
x2	The end coordinate in X direction.
y2	The end coordinate in Y direction.

Returns

true if successful.

SetOutCoord1()

virtual Bool Murl::Input::ITouchArea::SetOutCoord1 ( Real  x1, Real  y1  )

pure virtual

Set the button's output coordinate start.

See SetOutCoord().

Parameters

x1	The start coordinate in X direction.
y1	The start coordinate in Y direction.

Returns

true if successful.

SetOutCoord2()

virtual Bool Murl::Input::ITouchArea::SetOutCoord2 ( Real  x2, Real  y2  )

pure virtual

Set the button's output coordinate end.

See SetOutCoord().

Parameters

x2	The end coordinate in X direction.
y2	The end coordinate in Y direction.

Returns

true if successful.

SetOutCoordX1()

virtual Bool Murl::Input::ITouchArea::SetOutCoordX1 ( Real  x1 )

pure virtual

Set the button's horizontal start output coordinate.

See SetOutCoord().

Parameters

x1	The start coordinate in X direction.

Returns

true if successful.

SetOutCoordY1()

virtual Bool Murl::Input::ITouchArea::SetOutCoordY1 ( Real  y1 )

pure virtual

Set the button's vertical start output coordinates.

See SetOutCoord().

Parameters

y1	The start coordinate in Y direction.

Returns

true if successful.

SetOutCoordX2()

virtual Bool Murl::Input::ITouchArea::SetOutCoordX2 ( Real  x2 )

pure virtual

Set the button's horizontal end output coordinate.

See SetOutCoord().

Parameters

x2	The end coordinate in X direction.

Returns

true if successful.

SetOutCoordY2()

virtual Bool Murl::Input::ITouchArea::SetOutCoordY2 ( Real  y2 )

pure virtual

Set the button's vertical end output coordinates.

See SetOutCoord().

Parameters

y2	The end coordinate in Y direction.

Returns

true if successful.

GetOutCoordX1()

virtual Real Murl::Input::ITouchArea::GetOutCoordX1 ( ) const

pure virtual

Get the button's horizontal start output coordinate.

See SetOutCoord().

Returns

The start coordinate in X direction.

GetOutCoordY1()

virtual Real Murl::Input::ITouchArea::GetOutCoordY1 ( ) const

pure virtual

Get the button's vertical start output coordinate.

See SetOutCoord().

Returns

The start coordinate in Y direction.

GetOutCoordX2()

virtual Real Murl::Input::ITouchArea::GetOutCoordX2 ( ) const

pure virtual

Get the button's horizontal end output coordinate.

See SetOutCoord().

Returns

The end coordinate in X direction.

GetOutCoordY2()

virtual Real Murl::Input::ITouchArea::GetOutCoordY2 ( ) const

pure virtual

Get the button's vertical end output coordinate.

See SetOutCoord().

Returns

The end coordinate in Y direction.

SetOutCoordClippingEnabled()

virtual Bool Murl::Input::ITouchArea::SetOutCoordClippingEnabled ( Bool  enable )

pure virtual

Enable or disable output coordinate clipping.

Parameters

enable

If true, output coordinates are being clipped.

Returns

true if successful.

IsOutCoordClippingEnabled()

virtual Bool Murl::Input::ITouchArea::IsOutCoordClippingEnabled ( ) const

pure virtual

Check if output coordinate clipping is enabled.

Returns

true if enabled.

SetResponseTarget()

virtual void Murl::Input::ITouchArea::SetResponseTarget ( Graph::ITouchReporter *  node )

pure virtual

Set the response target object.

Parameters

node	The response target object.

GetResponseTarget()

virtual Graph::ITouchReporter* Murl::Input::ITouchArea::GetResponseTarget ( ) const

pure virtual

Get the response target object.

Returns

The response target object.

SetResponseButton()

virtual void Murl::Input::ITouchArea::SetResponseButton ( IEnums::MouseButton  button )

pure virtual

Set the response button.

Parameters

button

The response button.

GetResponseButton()

virtual IEnums::MouseButton Murl::Input::ITouchArea::GetResponseButton ( ) const

pure virtual

Get the response button.

Returns

The response button.

SetPassEventsEnabled()

virtual void Murl::Input::ITouchArea::SetPassEventsEnabled ( Bool  enable )

pure virtual

Set the pass events state.

Parameters

enable

true for enable passing events.

IsPassEventsEnabled()

virtual Bool Murl::Input::ITouchArea::IsPassEventsEnabled ( ) const

pure virtual

Check the pass events state.

Returns

true if enabled.

---

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

• murl_input_i_touch_area.h