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

#include <property-input-accessor.h>

Collaboration diagram for Dali::Internal::PropertyInputAccessor:
Collaboration graph
[legend]

Public Member Functions

 PropertyInputAccessor ()
 Create the PropertyInputAccessor. More...
 
 PropertyInputAccessor (const PropertyInputImpl *input, int componentIndex)
 Create the PropertyInputAccessor. More...
 
 PropertyInputAccessor (const PropertyInputAccessor &accessor)
 Copy from a PropertyInputAccessor. More...
 
PropertyInputAccessoroperator= (const PropertyInputAccessor &accessor)
 Copy from a PropertyInputAccessor. More...
 
void SetInput (const PropertyInputImpl &input, int componentIndex)
 Set the property input. More...
 
const PropertyInputImplGetInput () const
 Retrieve the property input. More...
 
Property::Type GetType () const
 Query the type of property input. More...
 
const bool & GetConstraintInputBoolean (BufferIndex updateBufferIndex) const
 Retrieve a boolean input for a constraint function. More...
 
const int & GetConstraintInputInteger (BufferIndex updateBufferIndex) const
  More...
 
const float & GetConstraintInputFloat (BufferIndex updateBufferIndex) const
 Retrieve a float input for a constraint function. More...
 
const Vector2GetConstraintInputVector2 (BufferIndex updateBufferIndex) const
 Retrieve a Vector2 input for a constraint function. More...
 
const Vector3GetConstraintInputVector3 (BufferIndex updateBufferIndex) const
 Retrieve a Vector3 input for a constraint function. More...
 
const Vector4GetConstraintInputVector4 (BufferIndex updateBufferIndex) const
 Retrieve a Vector4 input for a constraint function. More...
 
const QuaternionGetConstraintInputQuaternion (BufferIndex updateBufferIndex) const
 Retrieve a Quaternion input for a constraint function. More...
 
const Matrix3GetConstraintInputMatrix3 (BufferIndex updateBufferIndex) const
 Retrieve a Matrix3 input for a constraint function. More...
 
const MatrixGetConstraintInputMatrix (BufferIndex updateBufferIndex) const
 Retrieve a Matrix input for a constraint function. More...
 

Public Attributes

const PropertyInputImplmInput
 
int mComponentIndex
 

Detailed Description

Definition at line 31 of file property-input-accessor.h.

Constructor & Destructor Documentation

Dali::Internal::PropertyInputAccessor::PropertyInputAccessor ( )
inline

Create the PropertyInputAccessor.

Definition at line 38 of file property-input-accessor.h.

Dali::Internal::PropertyInputAccessor::PropertyInputAccessor ( const PropertyInputImpl input,
int  componentIndex 
)
inline

Create the PropertyInputAccessor.

Definition at line 47 of file property-input-accessor.h.

Dali::Internal::PropertyInputAccessor::PropertyInputAccessor ( const PropertyInputAccessor accessor)
inline

Copy from a PropertyInputAccessor.

Definition at line 56 of file property-input-accessor.h.

Member Function Documentation

const bool& Dali::Internal::PropertyInputAccessor::GetConstraintInputBoolean ( BufferIndex  updateBufferIndex) const
inline

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 100 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputBoolean(), and mInput.

Here is the call graph for this function:

const float& Dali::Internal::PropertyInputAccessor::GetConstraintInputFloat ( BufferIndex  updateBufferIndex) const
inline

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 118 of file property-input-accessor.h.

References DALI_ASSERT_DEBUG, Dali::PropertyTypes::Get< Vector2 >(), Dali::PropertyTypes::Get< Vector3 >(), Dali::Internal::PropertyInputImpl::GetConstraintInputFloat(), Dali::Internal::PropertyInputImpl::GetConstraintInputVector2(), Dali::Internal::PropertyInputImpl::GetConstraintInputVector3(), Dali::Internal::PropertyInputImpl::GetConstraintInputVector4(), Dali::Internal::PropertyInputImpl::GetType(), mComponentIndex, mInput, Dali::Vector4::w, Dali::Vector2::x, Dali::Vector4::x, Dali::Vector3::x, Dali::Vector2::y, Dali::Vector4::y, Dali::Vector3::y, Dali::Vector4::z, and Dali::Vector3::z.

Here is the call graph for this function:

const int& Dali::Internal::PropertyInputAccessor::GetConstraintInputInteger ( BufferIndex  updateBufferIndex) const
inline

Definition at line 108 of file property-input-accessor.h.

References DALI_ASSERT_DEBUG, Dali::Internal::PropertyInputImpl::GetConstraintInputInteger(), mComponentIndex, and mInput.

Here is the call graph for this function:

const Matrix& Dali::Internal::PropertyInputAccessor::GetConstraintInputMatrix ( BufferIndex  updateBufferIndex) const
inline

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.

Definition at line 212 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputMatrix(), and mInput.

Here is the call graph for this function:

const Matrix3& Dali::Internal::PropertyInputAccessor::GetConstraintInputMatrix3 ( BufferIndex  updateBufferIndex) const
inline

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 204 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputMatrix3(), and mInput.

Here is the call graph for this function:

const Quaternion& Dali::Internal::PropertyInputAccessor::GetConstraintInputQuaternion ( BufferIndex  updateBufferIndex) const
inline

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.

Definition at line 196 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputQuaternion(), and mInput.

Here is the call graph for this function:

const Vector2& Dali::Internal::PropertyInputAccessor::GetConstraintInputVector2 ( BufferIndex  updateBufferIndex) const
inline

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 172 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputVector2(), and mInput.

Here is the call graph for this function:

const Vector3& Dali::Internal::PropertyInputAccessor::GetConstraintInputVector3 ( BufferIndex  updateBufferIndex) const
inline

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.

Definition at line 180 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputVector3(), and mInput.

Here is the call graph for this function:

const Vector4& Dali::Internal::PropertyInputAccessor::GetConstraintInputVector4 ( BufferIndex  updateBufferIndex) const
inline

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.

Definition at line 188 of file property-input-accessor.h.

References Dali::Internal::PropertyInputImpl::GetConstraintInputVector4(), and mInput.

Here is the call graph for this function:

const PropertyInputImpl* Dali::Internal::PropertyInputAccessor::GetInput ( ) const
inline

Retrieve the property input.

Definition at line 84 of file property-input-accessor.h.

References mInput.

Property::Type Dali::Internal::PropertyInputAccessor::GetType ( ) const
inline

Query the type of property input.

Returns
The property type.

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

References Dali::Internal::PropertyInputImpl::GetType(), and mInput.

Here is the call graph for this function:

PropertyInputAccessor& Dali::Internal::PropertyInputAccessor::operator= ( const PropertyInputAccessor accessor)
inline

Copy from a PropertyInputAccessor.

Definition at line 65 of file property-input-accessor.h.

References mComponentIndex, and mInput.

void Dali::Internal::PropertyInputAccessor::SetInput ( const PropertyInputImpl input,
int  componentIndex 
)
inline

Set the property input.

Definition at line 75 of file property-input-accessor.h.

References mComponentIndex, and mInput.

Member Data Documentation

int Dali::Internal::PropertyInputAccessor::mComponentIndex
const PropertyInputImpl* Dali::Internal::PropertyInputAccessor::mInput

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