Kanzi  3.9.4
Kanzi Engine API
Public Member Functions | Protected Attributes | Friends | List of all members
kanzi::TouchEvent::TouchPoint Class Reference

The TouchPoint class holds information about a touch point, such as a finger. More...

#include <kanzi/core.ui/platform/input/common/events.hpp>

Public Member Functions

size_t getId () const
 Returns the identifier of the touch point. More...
 
Vector2 getPoint () const
 Returns the the touch point. More...
 
float getPressure () const
 Returns the pressure of the touch point. More...
 
float getRadius () const
 Returns the radius of the touch point. More...
 
TouchPointState getState () const
 Returns the state of the touch point. More...
 
float getX () const
 Returns the x axis coordinate of the touch point. More...
 
float getY () const
 Returns the y axis coordinate of the touch point. More...
 
 TouchPoint ()
 Constructor. More...
 
 TouchPoint (size_t id, TouchPointState state, float x, float y, float pressure=1.0f, float radius=1.0f)
 Constructs a touch point with the given data. More...
 

Protected Attributes

size_t m_id
 Holds the identifier of the touch point. More...
 
Vector2 m_point
 Holds the x and y axis coordinates of the touch point. More...
 
float m_pressure
 Holds the pressure of the touch point. More...
 
float m_radius
 Holds the radius of the touch point. More...
 
TouchPointState m_state
 Holds the state of the touch point. More...
 

Friends

class TouchEvent
 Friendship required to access members in transformation. More...
 

Detailed Description

The TouchPoint class holds information about a touch point, such as a finger.

Constructor & Destructor Documentation

◆ TouchPoint() [1/2]

kanzi::TouchEvent::TouchPoint::TouchPoint ( )
explicit

Constructor.

◆ TouchPoint() [2/2]

kanzi::TouchEvent::TouchPoint::TouchPoint ( size_t  id,
TouchPointState  state,
float  x,
float  y,
float  pressure = 1.0f,
float  radius = 1.0f 
)
explicit

Constructs a touch point with the given data.

Member Function Documentation

◆ getId()

size_t kanzi::TouchEvent::TouchPoint::getId ( ) const
inline

Returns the identifier of the touch point.

◆ getX()

float kanzi::TouchEvent::TouchPoint::getX ( ) const
inline

Returns the x axis coordinate of the touch point.

◆ getY()

float kanzi::TouchEvent::TouchPoint::getY ( ) const
inline

Returns the y axis coordinate of the touch point.

◆ getPoint()

Vector2 kanzi::TouchEvent::TouchPoint::getPoint ( ) const
inline

Returns the the touch point.

Since
Kanzi 3.9.0

◆ getPressure()

float kanzi::TouchEvent::TouchPoint::getPressure ( ) const
inline

Returns the pressure of the touch point.

◆ getRadius()

float kanzi::TouchEvent::TouchPoint::getRadius ( ) const
inline

Returns the radius of the touch point.

◆ getState()

TouchPointState kanzi::TouchEvent::TouchPoint::getState ( ) const
inline

Returns the state of the touch point.

Friends And Related Function Documentation

◆ TouchEvent

friend class TouchEvent
friend

Friendship required to access members in transformation.

Member Data Documentation

◆ m_point

Vector2 kanzi::TouchEvent::TouchPoint::m_point
protected

Holds the x and y axis coordinates of the touch point.

◆ m_pressure

float kanzi::TouchEvent::TouchPoint::m_pressure
protected

Holds the pressure of the touch point.

◆ m_radius

float kanzi::TouchEvent::TouchPoint::m_radius
protected

Holds the radius of the touch point.

◆ m_id

size_t kanzi::TouchEvent::TouchPoint::m_id
protected

Holds the identifier of the touch point.

◆ m_state

TouchPointState kanzi::TouchEvent::TouchPoint::m_state
protected

Holds the state of the touch point.

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