Kanzi  3.9.4
Kanzi Engine API
kanzi::PanManipulator::BaseMessageArguments Class Reference

Base message arguments for pan gestures that contain movement information. More...

#include <kanzi/core.ui/input/pan_manipulator.hpp>

Inheritance diagram for kanzi::PanManipulator::BaseMessageArguments:
[legend]

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Properties

static PropertyType< Vector2PanDeltaProperty
 Holds the change in pan position since the last update in global screen coordinates. More...
 
static PropertyType< Vector2PanVelocityProperty
 Holds the current estimate of the pan velocity in global screen coordinates. More...
 
Vector2 getDelta () const
 Gets the value of the PanDeltaProperty. More...
 
void setDelta (Vector2 value)
 Sets the value of the PanDeltaProperty. More...
 
Vector2 getVelocity () const
 Gets the value of the PanVelocityProperty. More...
 
void setVelocity (Vector2 value)
 Sets the value of the PanVelocityProperty. More...
 

Detailed Description

Base message arguments for pan gestures that contain movement information.

Inherits argument properties from InputManipulator::InputMessageArguments.

Member Function Documentation

◆ getDelta()

Vector2 kanzi::PanManipulator::BaseMessageArguments::getDelta ( ) const
inline

Gets the value of the PanDeltaProperty.

Returns
The value of the pan delta property.
See also
setDelta()

◆ setDelta()

void kanzi::PanManipulator::BaseMessageArguments::setDelta ( Vector2  value)
inline

Sets the value of the PanDeltaProperty.

Parameters
valueThe new value of the pan delta property.
See also
getDelta()

◆ getVelocity()

Vector2 kanzi::PanManipulator::BaseMessageArguments::getVelocity ( ) const
inline

Gets the value of the PanVelocityProperty.

Returns
The value of the pan velocity property.
See also
setVelocity()

◆ setVelocity()

void kanzi::PanManipulator::BaseMessageArguments::setVelocity ( Vector2  value)
inline

Sets the value of the PanVelocityProperty.

Parameters
valueThe new value of the pan velocity property.
See also
getVelocity()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::PanManipulator::BaseMessageArguments::makeEditorInfo ( )
static

Member Data Documentation

◆ PanDeltaProperty

PropertyType<Vector2> kanzi::PanManipulator::BaseMessageArguments::PanDeltaProperty
static

Holds the change in pan position since the last update in global screen coordinates.

The default value is Vector2(0.0f, 0.0f).

See also
setDelta(), getDelta()

◆ PanVelocityProperty

PropertyType<Vector2> kanzi::PanManipulator::BaseMessageArguments::PanVelocityProperty
static

Holds the current estimate of the pan velocity in global screen coordinates.

The default value is Vector2(0.0f, 0.0f).

See also
setVelocity(), getVelocity()

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