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

An inherited Color property. More...

#include <inherited-property.h>

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

Public Member Functions

 InheritedColor (const Vector4 &initialValue)
 Create an inherited property. More...
 
virtual ~InheritedColor ()
 Virtual destructor. More...
 
virtual Dali::Property::Type GetType () const
 Query the type of property input. More...
 
void CopyPrevious (BufferIndex updateBufferIndex)
 Called once per Update (only) if the property did not need to be re-inherited. 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...
 
virtual const Vector4GetVector4 (BufferIndex bufferIndex) const
 Retrieve a Vector4 value. More...
 
virtual const Vector4GetConstraintInputVector4 (BufferIndex bufferIndex) const
  More...
 
void Set (BufferIndex bufferIndex, const Vector4 &value)
 Set the property value. More...
 
void Set (BufferIndex bufferIndex, float r, float g, float b, float a)
 Set the property value. More...
 
Vector4Get (size_t bufferIndex)
 Retrieve an enumerated property type. More...
 
const Vector4Get (size_t bufferIndex) const
 Retrieve an enumerated property type. More...
 
const Vector4operator[] (size_t bufferIndex) const
 Retrieve 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 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 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

 InheritedColor (const InheritedColor &property)
 
InheritedColoroperator= (const InheritedColor &rhs)
 

Private Attributes

DoubleBuffered< Vector4mValue
 The double-buffered property value. More...
 
bool mInheritedFlag:1
 Flag whether the value has ever been inherited. More...
 
bool mReinheritedFlag:1
 Flag whether value was re-inherited in previous frame. More...
 

Detailed Description

An inherited Color property.

Definition at line 204 of file inherited-property.h.

Constructor & Destructor Documentation

Dali::Internal::SceneGraph::InheritedColor::InheritedColor ( const Vector4 initialValue)
inline

Create an inherited property.

Parameters
[in]initialValueThe initial value of the property.

Definition at line 212 of file inherited-property.h.

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

Virtual destructor.

Definition at line 222 of file inherited-property.h.

Dali::Internal::SceneGraph::InheritedColor::InheritedColor ( const InheritedColor property)
private

Member Function Documentation

void Dali::Internal::SceneGraph::InheritedColor::CopyPrevious ( BufferIndex  updateBufferIndex)
inline

Called once per Update (only) if the property did not need to be re-inherited.

Parameters
[in]updateBufferIndexThe current update buffer index.

Definition at line 238 of file inherited-property.h.

References mReinheritedFlag, and mValue.

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

Here is the caller graph for this function:

Vector4& Dali::Internal::SceneGraph::InheritedColor::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 333 of file inherited-property.h.

References mValue.

const Vector4& Dali::Internal::SceneGraph::InheritedColor::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 341 of file inherited-property.h.

References mValue.

virtual const Vector4& Dali::Internal::SceneGraph::InheritedColor::GetConstraintInputVector4 ( BufferIndex  bufferIndex) const
inlinevirtual

Reimplemented from Dali::Internal::PropertyInputImpl.

Definition at line 285 of file inherited-property.h.

References mValue.

virtual Dali::Property::Type Dali::Internal::SceneGraph::InheritedColor::GetType ( ) const
inlinevirtual

Query the type of property input.

Returns
The property type.

Implements Dali::Internal::PropertyInputImpl.

Definition at line 229 of file inherited-property.h.

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

Here is the call graph for this function:

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

Retrieve a Vector4 value.

.0

Returns
The Vector4 value.
Precondition
GetType() returns Property::VECTOR4.

Reimplemented from Dali::Internal::PropertyInputImpl.

Definition at line 277 of file inherited-property.h.

References mValue.

virtual bool Dali::Internal::SceneGraph::InheritedColor::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 269 of file inherited-property.h.

References IsClean().

Here is the call graph for this function:

virtual bool Dali::Internal::SceneGraph::InheritedColor::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 259 of file inherited-property.h.

References mInheritedFlag.

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

Query whether the property has changed.

Returns
True if the property has not changed.

Definition at line 251 of file inherited-property.h.

References mReinheritedFlag.

Referenced by InputChanged().

Here is the caller graph for this function:

InheritedColor& Dali::Internal::SceneGraph::InheritedColor::operator= ( const InheritedColor rhs)
private
const Vector4& Dali::Internal::SceneGraph::InheritedColor::operator[] ( size_t  bufferIndex) const
inline

Retrieve the property value.

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

Definition at line 351 of file inherited-property.h.

References mValue.

void Dali::Internal::SceneGraph::InheritedColor::Set ( BufferIndex  bufferIndex,
const Vector4 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 300 of file inherited-property.h.

References Dali::Clamp(), mInheritedFlag, mReinheritedFlag, and mValue.

Referenced by Dali::Internal::SceneGraph::Node::InheritWorldColor(), and Dali::Internal::SceneGraph::Node::SetWorldColor().

Here is the call graph for this function:

Here is the caller graph for this function:

void Dali::Internal::SceneGraph::InheritedColor::Set ( BufferIndex  bufferIndex,
float  r,
float  g,
float  b,
float  a 
)
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]rThe new red value.
[in]gThe new green value.
[in]bThe new blue value.
[in]aThe new alpha value.

Definition at line 318 of file inherited-property.h.

References Dali::Clamp(), mInheritedFlag, mReinheritedFlag, and mValue.

Here is the call graph for this function:

Member Data Documentation

bool Dali::Internal::SceneGraph::InheritedColor::mInheritedFlag
private

Flag whether the value has ever been inherited.

Definition at line 367 of file inherited-property.h.

Referenced by InputInitialized(), and Set().

bool Dali::Internal::SceneGraph::InheritedColor::mReinheritedFlag
private

Flag whether value was re-inherited in previous frame.

Definition at line 368 of file inherited-property.h.

Referenced by CopyPrevious(), IsClean(), and Set().

DoubleBuffered<Vector4> Dali::Internal::SceneGraph::InheritedColor::mValue
private

The double-buffered property value.

Definition at line 365 of file inherited-property.h.

Referenced by CopyPrevious(), Get(), GetConstraintInputVector4(), GetVector4(), operator[](), and Set().


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