Dali 3D User Interface Engine
List of all members | Public Member Functions
Dali::Internal::PropertyInputImpl Class Referenceabstract

An abstract interface for receiving property values, and for querying whether a property value has changed i.e. More...

#include <property-input-impl.h>

Inheritance diagram for Dali::Internal::PropertyInputImpl:
Inheritance graph
[legend]

Public Member Functions

virtual ~PropertyInputImpl ()
 Virtual destructor. More...
 
virtual Property::Type GetType () const =0
 Query the type of property input. More...
 
virtual bool InputInitialized () const =0
 Query the input value (for a constraint) has been initialized. More...
 
virtual bool InputChanged () const =0
 Query the input value (for a constraint) has changed. 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...
 

Detailed Description

An abstract interface for receiving property values, and for querying whether a property value has changed i.e.

whether a constraint needs to be reapplied.

Definition at line 44 of file property-input-impl.h.

Constructor & Destructor Documentation

virtual Dali::Internal::PropertyInputImpl::~PropertyInputImpl ( )
inlinevirtual

Virtual destructor.

Definition at line 51 of file property-input-impl.h.

Member Function Documentation

void Dali::Internal::PropertyInputImpl::DebugPrint ( std::ostream &  debugStream,
BufferIndex  bufferIndex 
) const
inline

Print the property value using a stream.

Parameters
[in]debugStreamThe output stream.
[in]bufferIndexThe buffer to read from.
Todo:
Place this far-too-large-to-be-inlined function in a cpp and remove <iostream> header dependency from this file.

Definition at line 315 of file property-input-impl.h.

References Dali::Property::BOOLEAN, Dali::Property::FLOAT, GetBoolean(), GetFloat(), GetInteger(), GetMatrix(), GetMatrix3(), GetQuaternion(), GetType(), GetVector2(), GetVector3(), GetVector4(), Dali::Property::INTEGER, Dali::Property::MATRIX, Dali::Property::MATRIX3, Dali::Property::ROTATION, Dali::Property::VECTOR2, Dali::Property::VECTOR3, and Dali::Property::VECTOR4.

Here is the call graph for this function:

virtual const bool& Dali::Internal::PropertyInputImpl::GetBoolean ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a boolean value.

Precondition
GetType() returns Property::BOOLEAN.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The boolean value.

Reimplemented in Dali::Internal::SceneGraph::GesturePropertyBool, and Dali::Internal::SceneGraph::AnimatableProperty< bool >.

Definition at line 79 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), and GetConstraintInputBoolean().

Here is the caller graph for this function:

virtual const bool& Dali::Internal::PropertyInputImpl::GetConstraintInputBoolean ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a boolean input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::BOOLEAN.
Parameters
[in]updateBufferIndexThe current update buffer index.
Returns
The boolean value.

Definition at line 200 of file property-input-impl.h.

References GetBoolean().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputBoolean().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const float& Dali::Internal::PropertyInputImpl::GetConstraintInputFloat ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a float input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::FLOAT.
Parameters
[in]updateBufferIndexThe current update buffer index.
Returns
The float value.

Definition at line 226 of file property-input-impl.h.

References GetFloat().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputFloat().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const int& Dali::Internal::PropertyInputImpl::GetConstraintInputInteger ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve an integer input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::INTEGER.
Parameters
[in]updateBufferIndexThe current update buffer index.
Returns
The integer value.

Definition at line 213 of file property-input-impl.h.

References GetInteger().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputInteger().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Matrix& Dali::Internal::PropertyInputImpl::GetConstraintInputMatrix ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a Matrix input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::Matrix.
Parameters
[in]updateBufferIndexThe buffer to read from.
Returns
The Matrix value.

Reimplemented in Dali::Internal::SceneGraph::InheritedMatrix.

Definition at line 304 of file property-input-impl.h.

References GetMatrix().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputMatrix().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Matrix3& Dali::Internal::PropertyInputImpl::GetConstraintInputMatrix3 ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a Matrix3 input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::Matrix.
Parameters
[in]updateBufferIndexThe buffer to read from.
Returns
The Matrix value.

Definition at line 291 of file property-input-impl.h.

References GetMatrix3().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputMatrix3().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Quaternion& Dali::Internal::PropertyInputImpl::GetConstraintInputQuaternion ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a Quaternion input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::Quaternion.
Parameters
[in]updateBufferIndexThe buffer to read from.
Returns
The Quaternion value.

Reimplemented in Dali::Internal::SceneGraph::InheritedQuaternion.

Definition at line 278 of file property-input-impl.h.

References GetQuaternion().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputQuaternion().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Vector2& Dali::Internal::PropertyInputImpl::GetConstraintInputVector2 ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a Vector2 input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::VECTOR2.
Parameters
[in]updateBufferIndexThe buffer to read from.
Returns
The Vector2 value.

Definition at line 239 of file property-input-impl.h.

References GetVector2().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputFloat(), and Dali::Internal::PropertyInputAccessor::GetConstraintInputVector2().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Vector3& Dali::Internal::PropertyInputImpl::GetConstraintInputVector3 ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a Vector3 input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::VECTOR3.
Parameters
[in]updateBufferIndexThe buffer to read from.
Returns
The Vector3 value.

Reimplemented in Dali::Internal::SceneGraph::InheritedVector3.

Definition at line 252 of file property-input-impl.h.

References GetVector3().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputFloat(), and Dali::Internal::PropertyInputAccessor::GetConstraintInputVector3().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const Vector4& Dali::Internal::PropertyInputImpl::GetConstraintInputVector4 ( BufferIndex  updateBufferIndex) const
inlinevirtual

Retrieve a Vector4 input for a constraint function.

Note
For inherited properties, this method should be overriden to return the value from the previous frame i.e. not from the current update buffer.
Precondition
GetType() returns Property::VECTOR4.
Parameters
[in]updateBufferIndexThe buffer to read from.
Returns
The Vector4 value.

Reimplemented in Dali::Internal::SceneGraph::InheritedColor.

Definition at line 265 of file property-input-impl.h.

References GetVector4().

Referenced by Dali::Internal::PropertyInputAccessor::GetConstraintInputFloat(), and Dali::Internal::PropertyInputAccessor::GetConstraintInputVector4().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual const float& Dali::Internal::PropertyInputImpl::GetFloat ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a float value.

Precondition
GetType() returns Property::FLOAT.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The float value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< float >.

Definition at line 105 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputFloat(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual const int& Dali::Internal::PropertyInputImpl::GetInteger ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve an integer value.

Precondition
GetType() returns Property::INTEGER.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The integer value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< int >.

Definition at line 92 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputInteger(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual const Matrix& Dali::Internal::PropertyInputImpl::GetMatrix ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a Matrix value.

Precondition
GetType() returns Property::Matrix.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The Matrix value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< Matrix >, and Dali::Internal::SceneGraph::InheritedMatrix.

Definition at line 183 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputMatrix(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual const Matrix3& Dali::Internal::PropertyInputImpl::GetMatrix3 ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a Matrix value.

Precondition
GetType() returns Property::Matrix.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The Matrix value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< Matrix3 >.

Definition at line 170 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputMatrix3(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual const Quaternion& Dali::Internal::PropertyInputImpl::GetQuaternion ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a Quaternion value.

Precondition
GetType() returns Property::Quaternion.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The Quaternion value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< Quaternion >, and Dali::Internal::SceneGraph::InheritedQuaternion.

Definition at line 157 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputQuaternion(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual Property::Type Dali::Internal::PropertyInputImpl::GetType ( ) const
pure virtual
virtual const Vector2& Dali::Internal::PropertyInputImpl::GetVector2 ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a Vector2 value.

Precondition
GetType() returns Property::VECTOR2.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The Vector2 value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< Vector2 >, and Dali::Internal::SceneGraph::GesturePropertyVector2.

Definition at line 118 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputVector2(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual const Vector3& Dali::Internal::PropertyInputImpl::GetVector3 ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a Vector3 value.

Precondition
GetType() returns Property::VECTOR3.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The Vector3 value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< Vector3 >, Dali::Internal::SceneGraph::InheritedVector3, and Dali::Internal::SceneGraph::PropertyVector3.

Definition at line 131 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputVector3(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual const Vector4& Dali::Internal::PropertyInputImpl::GetVector4 ( BufferIndex  bufferIndex) const
inlinevirtual

Retrieve a Vector4 value.

Precondition
GetType() returns Property::VECTOR4.
Parameters
[in]bufferIndexThe buffer to read from.
Returns
The Vector4 value.

Reimplemented in Dali::Internal::SceneGraph::AnimatableProperty< Vector4 >, and Dali::Internal::SceneGraph::InheritedColor.

Definition at line 144 of file property-input-impl.h.

References DALI_ASSERT_ALWAYS.

Referenced by DebugPrint(), GetConstraintInputVector4(), and Dali::Internal::Render::Renderer::SetUniformFromProperty().

Here is the caller graph for this function:

virtual bool Dali::Internal::PropertyInputImpl::InputChanged ( ) const
pure virtual
virtual bool Dali::Internal::PropertyInputImpl::InputInitialized ( ) const
pure virtual

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