kanzi::InputManipulator::InputMessageArguments Class Reference

Message arguments for input manipulator messages. More...

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

Inheritance diagram for kanzi::InputManipulator::InputMessageArguments:
kanzi::MessageArguments kanzi::ClickManipulator::ClickBeginMessageArguments kanzi::DragAndDropManipulator::MovedMessageArguments kanzi::PanManipulator::FinishedMessageArguments kanzi::PanManipulator::MovedMessageArguments

Public Member Functions

Vector2 getPoint () const
 The position of the primary touch point. More...
 
void setPoint (Vector2 value)
 
Vector3 getRayOrigin () const
 The origin of the pick ray in the local space of the enclosing viewport node. More...
 
void setRayOrigin (Vector3 value)
 
Vector3 getRayDirection () const
 Pick ray direction vector (normalized) in the local space of the enclosing viewport node. More...
 
void setRayDirection (Vector3 value)
 
Vector2 getHitTestPoint () const
 The position of the primary touch point in the object space of the node that generated the hit test. More...
 
void setHitTestPoint (Vector2 value)
 
Vector3 getHitTestRayOrigin () const
 Origin of the hit test ray in the local space of the hit test camera. Provided when hitting a 3D node. More...
 
void setHitTestRayOrigin (Vector3 value)
 
Vector3 getHitTestRayDirection () const
 Hit test ray direction vector (normalized) in the local space of the hit test camera. Provided when hitting a 3D node. More...
 
void setHitTestRayDirection (Vector3 value)
 
- Public Member Functions inherited from kanzi::MessageArguments
 MessageArguments ()
 
 MessageArguments (AbstractMessageType messageType)
 
 ~MessageArguments ()
 
template<typename TDataType >
TDataType getArgument (const PropertyType< TDataType > &argumentType) const
 
bool getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
 
template<typename TDataType >
void setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
 
void setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
 
bool isFrom (const Node &source) const
 
shared_ptr< NodegetSource () const
 
void setHandled (bool handled)
 
bool isHandled () const
 
chrono::milliseconds getTimestamp () const
 
KzuMessageDispatchergetDispatcher () const
 
AbstractMessageType getType () const
 
void setSource (Node *source)
 
void setTimestamp (chrono::milliseconds timestamp)
 
void setValid (bool valid)
 
bool isValid () const
 
void setDispatcher_internal (KzuMessageDispatcher *dispatcher)
 Internal function. More...
 
void setType_internal (AbstractMessageType type)
 Internal function. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::MessageArguments
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

static PropertyType< Vector2ManipulatorPointProperty
 ManipulatorPoint property. More...
 
static PropertyType< Vector3ManipulatorRayOriginProperty
 ManipulatorRayOrigin property. More...
 
static PropertyType< Vector3ManipulatorRayDirectionProperty
 ManipulatorRayDirection property. More...
 
static PropertyType< Vector2HitTestPointProperty
 HitTestPoint property. More...
 
static PropertyType< Vector3HitTestRayOriginProperty
 HitTestRayOrigin property. More...
 
static PropertyType< Vector3HitTestRayDirectionProperty
 HitTestRayDirection property. More...
 
static PropertyType< void * > HitTestObjectProperty
 HitTestObject property. More...
 

Detailed Description

Message arguments for input manipulator messages.

Member Function Documentation

static PropertyTypeEditorInfoSharedPtr kanzi::InputManipulator::InputMessageArguments::makeEditorInfo ( )
static
Vector2 kanzi::InputManipulator::InputMessageArguments::getPoint ( ) const
inline

The position of the primary touch point.

When hitting a 2D node, the value is in local space of the attached node or the provided reference node (see InputManipulator::setReferenceNode) When hitting a 3D node, the value is in local space of the enclosing viewport node.

void kanzi::InputManipulator::InputMessageArguments::setPoint ( Vector2  value)
inline
Vector3 kanzi::InputManipulator::InputMessageArguments::getRayOrigin ( ) const
inline

The origin of the pick ray in the local space of the enclosing viewport node.

ManipulatorRayOriginProperty is Provided when hitting a 3D node.

void kanzi::InputManipulator::InputMessageArguments::setRayOrigin ( Vector3  value)
inline
Vector3 kanzi::InputManipulator::InputMessageArguments::getRayDirection ( ) const
inline

Pick ray direction vector (normalized) in the local space of the enclosing viewport node.

ManipulatorRayDirectionProperty is provided when hitting a 3D node.

void kanzi::InputManipulator::InputMessageArguments::setRayDirection ( Vector3  value)
inline
Vector2 kanzi::InputManipulator::InputMessageArguments::getHitTestPoint ( ) const
inline

The position of the primary touch point in the object space of the node that generated the hit test.

When hitting a 2D node, the value is in screen space. When hitting a 3D node, the value is in local space of the hit test camera.

void kanzi::InputManipulator::InputMessageArguments::setHitTestPoint ( Vector2  value)
inline
Vector3 kanzi::InputManipulator::InputMessageArguments::getHitTestRayOrigin ( ) const
inline

Origin of the hit test ray in the local space of the hit test camera. Provided when hitting a 3D node.

void kanzi::InputManipulator::InputMessageArguments::setHitTestRayOrigin ( Vector3  value)
inline
Vector3 kanzi::InputManipulator::InputMessageArguments::getHitTestRayDirection ( ) const
inline

Hit test ray direction vector (normalized) in the local space of the hit test camera. Provided when hitting a 3D node.

void kanzi::InputManipulator::InputMessageArguments::setHitTestRayDirection ( Vector3  value)
inline

Member Data Documentation

PropertyType<Vector2> kanzi::InputManipulator::InputMessageArguments::ManipulatorPointProperty
static

ManipulatorPoint property.

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

See also
setManipulatorPoint(), getManipulatorPoint()
PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::ManipulatorRayOriginProperty
static

ManipulatorRayOrigin property.

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

See also
setManipulatorRayOrigin(), getManipulatorRayOrigin()
PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::ManipulatorRayDirectionProperty
static

ManipulatorRayDirection property.

The default value is Vector3(0.0f, 0.0f, -1.0f).

See also
setManipulatorRayDirection(), getManipulatorRayDirection()
PropertyType<Vector2> kanzi::InputManipulator::InputMessageArguments::HitTestPointProperty
static

HitTestPoint property.

The default value is Vector2(KZS_NAN, KZS_NAN).

See also
setHitTestPoint(), getHitTestPoint()
PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::HitTestRayOriginProperty
static

HitTestRayOrigin property.

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

See also
setHitTestRayOrigin(), getHitTestRayOrigin()
PropertyType<Vector3> kanzi::InputManipulator::InputMessageArguments::HitTestRayDirectionProperty
static

HitTestRayDirection property.

The default value is Vector3(0.0f, 0.0f, -1.0f).

See also
setHitTestRayDirection(), getHitTestRayDirection()
PropertyType<void*> kanzi::InputManipulator::InputMessageArguments::HitTestObjectProperty
static

HitTestObject property.

The default value is 0.

See also
setHitTestObject(), getHitTestObject()

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