Dali 3D User Interface Engine
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
Dali::Internal::SceneGraph::AnimatablePropertyBase Class Reference

Base class to reduce code size from the templates. More...

#include <animatable-property.h>

Inheritance diagram for Dali::Internal::SceneGraph::AnimatablePropertyBase:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::SceneGraph::AnimatablePropertyBase:
Collaboration graph
[legend]

Public Member Functions

 AnimatablePropertyBase ()
 Constructor, initialize the dirty flag. More...
 
virtual ~AnimatablePropertyBase ()
 Virtual destructor. 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...
 
- Public Member Functions inherited from Dali::Internal::SceneGraph::PropertyBase
 PropertyBase ()
 Default constructor. More...
 
virtual ~PropertyBase ()
 Virtual destructor. More...
 
virtual void ResetToBaseValue (BufferIndex updateBufferIndex)=0
 Reset the property to a base value; only required if the property is animated. More...
 
virtual bool InputChanged () const
 Query the input value (for a constraint) has changed. More...
 
- Public Member Functions inherited from Dali::Internal::PropertyInputImpl
virtual ~PropertyInputImpl ()
 Virtual destructor. More...
 
virtual Property::Type GetType () const =0
 Query the type of property input. 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 Member Functions

void OnSet ()
 Flag that the property has been Set during the current frame. More...
 
void OnBake ()
 Flag that the property has been Baked during the current frame. More...
 

Protected Attributes

unsigned int mDirtyFlags
 Flag whether value changed during previous 2 frames. More...
 

Detailed Description

Base class to reduce code size from the templates.

Definition at line 65 of file animatable-property.h.

Constructor & Destructor Documentation

Dali::Internal::SceneGraph::AnimatablePropertyBase::AnimatablePropertyBase ( )
inline

Constructor, initialize the dirty flag.

Definition at line 72 of file animatable-property.h.

virtual Dali::Internal::SceneGraph::AnimatablePropertyBase::~AnimatablePropertyBase ( )
inlinevirtual

Virtual destructor.

Definition at line 80 of file animatable-property.h.

Member Function Documentation

virtual bool Dali::Internal::SceneGraph::AnimatablePropertyBase::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 114 of file animatable-property.h.

virtual bool Dali::Internal::SceneGraph::AnimatablePropertyBase::IsClean ( ) const
inlinevirtual

Query whether the property has changed.

Returns
True if the property has not changed.

Implements Dali::Internal::SceneGraph::PropertyBase.

Definition at line 106 of file animatable-property.h.

References Dali::Internal::SceneGraph::CLEAN_FLAG, and mDirtyFlags.

Referenced by Dali::Internal::SceneGraph::Node::GetDirtyFlags().

Here is the caller graph for this function:

void Dali::Internal::SceneGraph::AnimatablePropertyBase::OnBake ( )
inlineprotected

Flag that the property has been Baked during the current frame.

Definition at line 96 of file animatable-property.h.

References Dali::Internal::SceneGraph::BAKED_FLAG, and mDirtyFlags.

void Dali::Internal::SceneGraph::AnimatablePropertyBase::OnSet ( )
inlineprotected

Flag that the property has been Set during the current frame.

Definition at line 88 of file animatable-property.h.

References mDirtyFlags, and Dali::Internal::SceneGraph::SET_FLAG.

Member Data Documentation

unsigned int Dali::Internal::SceneGraph::AnimatablePropertyBase::mDirtyFlags
protected

Flag whether value changed during previous 2 frames.

Definition at line 121 of file animatable-property.h.

Referenced by IsClean(), OnBake(), and OnSet().


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