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

An boolean animatable property of a scene-graph object. More...

#include <animatable-property.h>

Inheritance diagram for Dali::Internal::SceneGraph::AnimatableProperty< bool >:
Inheritance graph
[legend]
Collaboration diagram for Dali::Internal::SceneGraph::AnimatableProperty< bool >:
Collaboration graph
[legend]

Public Member Functions

 AnimatableProperty (bool initialValue)
 Create an animatable property. More...
 
virtual ~AnimatableProperty ()
 Virtual destructor. More...
 
virtual Dali::Property::Type GetType () const
 Query the type of property input. More...
 
virtual void ResetToBaseValue (BufferIndex updateBufferIndex)
 Reset the property to a base value; only required if the property is animated. More...
 
virtual const bool & GetBoolean (BufferIndex bufferIndex) const
 Retrieve a boolean value. More...
 
void Set (BufferIndex bufferIndex, bool value)
 Set the property value. More...
 
void SetRelative (BufferIndex bufferIndex, bool delta)
 Change the property value by a relative amount. More...
 
bool & Get (size_t bufferIndex)
 Retrieve an enumerated property type. More...
 
const bool & Get (size_t bufferIndex) const
 Retrieve an enumerated property type. More...
 
bool & operator[] (size_t bufferIndex)
 Retrieve the property value. More...
 
const bool & operator[] (size_t bufferIndex) const
 Retrieve the property value. More...
 
void Bake (BufferIndex bufferIndex, bool value)
 Set both the property value & base value. More...
 
void BakeRelative (BufferIndex bufferIndex, bool delta)
 Change the property value & base value by a relative amount. More...
 
- Public Member Functions inherited from Dali::Internal::SceneGraph::AnimatablePropertyBase
 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 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 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...
 

Private Member Functions

 AnimatableProperty (const AnimatableProperty &property)
 
AnimatablePropertyoperator= (const AnimatableProperty &rhs)
 

Private Attributes

DoubleBuffered< bool > mValue
 The double-buffered property value. More...
 
bool mBaseValue
 Reset to this base value at the beginning of each frame. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::Internal::SceneGraph::AnimatablePropertyBase
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 inherited from Dali::Internal::SceneGraph::AnimatablePropertyBase
unsigned int mDirtyFlags
 Flag whether value changed during previous 2 frames. More...
 

Detailed Description

template<>
class Dali::Internal::SceneGraph::AnimatableProperty< bool >

An boolean animatable property of a scene-graph object.

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

Constructor & Destructor Documentation

Create an animatable property.

Parameters
[in]initialValueThe initial value of the property.

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

Virtual destructor.

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

Member Function Documentation

void Dali::Internal::SceneGraph::AnimatableProperty< bool >::Bake ( BufferIndex  bufferIndex,
bool  value 
)
inline

Set both the property value & base value.

Parameters
[in]bufferIndexThe buffer to write for the property value.
[in]valueThe new property value.

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

void Dali::Internal::SceneGraph::AnimatableProperty< bool >::BakeRelative ( BufferIndex  bufferIndex,
bool  delta 
)
inline

Change the property value & base value by a relative amount.

Parameters
[in]bufferIndexThe buffer to write for the local property value.
[in]deltaThe property will change by this amount.

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

bool& Dali::Internal::SceneGraph::AnimatableProperty< bool >::Get ( size_t  bufferIndex)
inline

Retrieve an enumerated property type.

New versions of this templated function must be defined for future types. .0

Returns
The property type.

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

const bool& Dali::Internal::SceneGraph::AnimatableProperty< bool >::Get ( size_t  bufferIndex) const
inline

Retrieve an enumerated property type.

New versions of this templated function must be defined for future types. .0

Returns
The property type.

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

virtual const bool& Dali::Internal::SceneGraph::AnimatableProperty< bool >::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 from Dali::Internal::PropertyInputImpl.

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

virtual Dali::Property::Type Dali::Internal::SceneGraph::AnimatableProperty< bool >::GetType ( ) const
inlinevirtual

Query the type of property input.

Returns
The property type.

Implements Dali::Internal::PropertyInputImpl.

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

References Dali::PropertyTypes::Get< bool >().

Here is the call graph for this function:

AnimatableProperty& Dali::Internal::SceneGraph::AnimatableProperty< bool >::operator= ( const AnimatableProperty< bool > &  rhs)
private
bool& Dali::Internal::SceneGraph::AnimatableProperty< bool >::operator[] ( size_t  bufferIndex)
inline

Retrieve the property value.

Parameters
[in]bufferIndexThe buffer to read.
Returns
The property value.

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

const bool& Dali::Internal::SceneGraph::AnimatableProperty< bool >::operator[] ( size_t  bufferIndex) const
inline

Retrieve the property value.

Parameters
[in]bufferIndexThe buffer to read.
Returns
The property value.

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

virtual void Dali::Internal::SceneGraph::AnimatableProperty< bool >::ResetToBaseValue ( BufferIndex  updateBufferIndex)
inlinevirtual

Reset the property to a base value; only required if the property is animated.

Parameters
[in]currentBufferIndexThe current buffer index.

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

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

References Dali::Internal::SceneGraph::CLEAN_FLAG.

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

Here is the caller graph for this function:

void Dali::Internal::SceneGraph::AnimatableProperty< bool >::Set ( BufferIndex  bufferIndex,
bool  value 
)
inline

Set the property value.

This will only persist for the current frame; the property will be reset with the base value, at the beginning of the next frame.

Parameters
[in]bufferIndexThe buffer to write.
[in]valueThe new property value.

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

void Dali::Internal::SceneGraph::AnimatableProperty< bool >::SetRelative ( BufferIndex  bufferIndex,
bool  delta 
)
inline

Change the property value by a relative amount.

Parameters
[in]bufferIndexThe buffer to write.
[in]deltaThe property will change by this amount.

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

Member Data Documentation

bool Dali::Internal::SceneGraph::AnimatableProperty< bool >::mBaseValue
private

Reset to this base value at the beginning of each frame.

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

The double-buffered property value.

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


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