Dali 3D User Interface Engine
List of all members | Public Member Functions | Protected Attributes | Private Member Functions
Dali::Internal::SceneGraph::GestureProperty< T > Class Template Reference

A template for a read only properties used by Gestures. More...

#include <gesture-properties.h>

Inheritance diagram for Dali::Internal::SceneGraph::GestureProperty< T >:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::SceneGraph::GestureProperty< T >:
Collaboration graph
[legend]

Public Member Functions

 GestureProperty (const T &initialValue)
 Create a read-only gesture property. More...
 
 GestureProperty ()
 Create a read-only gesture property. More...
 
virtual ~GestureProperty ()
 Virtual destructor. More...
 
virtual Dali::Property::Type GetType () const
 Query the type of property input. More...
 
virtual bool IsClean () const
 Query whether the property has changed. More...
 
virtual bool InputInitialized () const
 Query the input value (for a constraint) has been initialized. More...
 
virtual bool InputChanged () const
 Query the input value (for a constraint) has changed. More...
 
void Reset ()
 Resets mInputChanged back to false. More...
 
void Set (const T &value)
 Set the property value. More...
 
const T & Get () const
 Get the property value. More...
 
- Public Member Functions inherited from Dali::Internal::PropertyInputImpl
virtual ~PropertyInputImpl ()
 Virtual destructor. More...
 
virtual const bool & GetBoolean (BufferIndex bufferIndex) const
 Retrieve a boolean value. More...
 
virtual const int & GetInteger (BufferIndex bufferIndex) const
 Retrieve an integer value. More...
 
virtual const float & GetFloat (BufferIndex bufferIndex) const
 Retrieve a float value. More...
 
virtual const Vector2GetVector2 (BufferIndex bufferIndex) const
 Retrieve a Vector2 value. More...
 
virtual const Vector3GetVector3 (BufferIndex bufferIndex) const
 Retrieve a Vector3 value. More...
 
virtual const Vector4GetVector4 (BufferIndex bufferIndex) const
 Retrieve a Vector4 value. More...
 
virtual const QuaternionGetQuaternion (BufferIndex bufferIndex) const
 Retrieve a Quaternion value. More...
 
virtual const Matrix3GetMatrix3 (BufferIndex bufferIndex) const
 Retrieve a Matrix value. More...
 
virtual const MatrixGetMatrix (BufferIndex bufferIndex) const
 Retrieve a Matrix value. More...
 
virtual const bool & GetConstraintInputBoolean (BufferIndex updateBufferIndex) const
 Retrieve a boolean input for a constraint function. More...
 
virtual const int & GetConstraintInputInteger (BufferIndex updateBufferIndex) const
 Retrieve an integer input for a constraint function. More...
 
virtual const float & GetConstraintInputFloat (BufferIndex updateBufferIndex) const
 Retrieve a float input for a constraint function. More...
 
virtual const Vector2GetConstraintInputVector2 (BufferIndex updateBufferIndex) const
 Retrieve a Vector2 input for a constraint function. More...
 
virtual const Vector3GetConstraintInputVector3 (BufferIndex updateBufferIndex) const
 Retrieve a Vector3 input for a constraint function. More...
 
virtual const Vector4GetConstraintInputVector4 (BufferIndex updateBufferIndex) const
 Retrieve a Vector4 input for a constraint function. More...
 
virtual const QuaternionGetConstraintInputQuaternion (BufferIndex updateBufferIndex) const
 Retrieve a Quaternion input for a constraint function. More...
 
virtual const Matrix3GetConstraintInputMatrix3 (BufferIndex updateBufferIndex) const
 Retrieve a Matrix3 input for a constraint function. More...
 
virtual const MatrixGetConstraintInputMatrix (BufferIndex updateBufferIndex) const
 Retrieve a Matrix input for a constraint function. More...
 
void DebugPrint (std::ostream &debugStream, BufferIndex bufferIndex) const
 Print the property value using a stream. More...
 

Protected Attributes

mValue
 The property value. More...
 
bool mInputChanged:1
 Whether the property has been modified. More...
 

Private Member Functions

 GestureProperty (const GestureProperty &property)
 
GesturePropertyoperator= (const GestureProperty &rhs)
 

Detailed Description

template<class T>
class Dali::Internal::SceneGraph::GestureProperty< T >

A template for a read only properties used by Gestures.

Definition at line 39 of file gesture-properties.h.

Constructor & Destructor Documentation

template<class T>
Dali::Internal::SceneGraph::GestureProperty< T >::GestureProperty ( const T &  initialValue)
inline

Create a read-only gesture property.

Parameters
[in]initialValueThe initial value of the property.

Definition at line 47 of file gesture-properties.h.

Create a read-only gesture property.

Definition at line 56 of file gesture-properties.h.

template<class T>
virtual Dali::Internal::SceneGraph::GestureProperty< T >::~GestureProperty ( )
inlinevirtual

Virtual destructor.

Definition at line 65 of file gesture-properties.h.

template<class T>
Dali::Internal::SceneGraph::GestureProperty< T >::GestureProperty ( const GestureProperty< T > &  property)
private

Member Function Documentation

template<class T>
const T& Dali::Internal::SceneGraph::GestureProperty< T >::Get ( ) const
inline

Get the property value.

Returns
The property value.

Definition at line 125 of file gesture-properties.h.

Referenced by Dali::Internal::PanGestureDetector::GetDefaultProperty().

Here is the caller graph for this function:

template<class T>
virtual Dali::Property::Type Dali::Internal::SceneGraph::GestureProperty< T >::GetType ( ) const
inlinevirtual

Query the type of property input.

Returns
The property type.

Implements Dali::Internal::PropertyInputImpl.

Definition at line 72 of file gesture-properties.h.

template<class T>
virtual bool Dali::Internal::SceneGraph::GestureProperty< T >::InputChanged ( ) const
inlinevirtual

Query the input value (for a constraint) has changed.

Returns
True if the input value has changed.

Implements Dali::Internal::PropertyInputImpl.

Definition at line 98 of file gesture-properties.h.

Referenced by Dali::Internal::SceneGraph::GestureProperty< bool >::IsClean().

Here is the caller graph for this function:

template<class T>
virtual bool Dali::Internal::SceneGraph::GestureProperty< T >::InputInitialized ( ) const
inlinevirtual

Query the input value (for a constraint) has been initialized.

Returns
True if initialized, otherwise the constraint should be skipped.

Implements Dali::Internal::PropertyInputImpl.

Definition at line 88 of file gesture-properties.h.

template<class T>
virtual bool Dali::Internal::SceneGraph::GestureProperty< T >::IsClean ( ) const
inlinevirtual

Query whether the property has changed.

Returns
True if the property has not changed.

Definition at line 80 of file gesture-properties.h.

template<class T>
GestureProperty& Dali::Internal::SceneGraph::GestureProperty< T >::operator= ( const GestureProperty< T > &  rhs)
private
template<class T>
void Dali::Internal::SceneGraph::GestureProperty< T >::Reset ( )
inline

Resets mInputChanged back to false.

Definition at line 106 of file gesture-properties.h.

Referenced by Dali::Internal::SceneGraph::PanGesture::ResetDefaultProperties().

Here is the caller graph for this function:

template<class T>
void Dali::Internal::SceneGraph::GestureProperty< T >::Set ( const T &  value)
inline

Set the property value.

Parameters
[in]valueThe new property value.

Definition at line 115 of file gesture-properties.h.

Referenced by Dali::Internal::SceneGraph::PanGesture::UpdateProperties().

Here is the caller graph for this function:

Member Data Documentation

template<class T>
bool Dali::Internal::SceneGraph::GestureProperty< T >::mInputChanged
protected
template<class T>
T Dali::Internal::SceneGraph::GestureProperty< T >::mValue
protected

The documentation for this class was generated from the following file:
Dali Docs Home
Read more about Dali