-#ifndef __DALI_CONSTRAINTS_H__
-#define __DALI_CONSTRAINTS_H__
+#ifndef DALI_CONSTRAINTS_H
+#define DALI_CONSTRAINTS_H
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
// INTERNAL INCLUDES
#include <dali/public-api/animation/constraint.h>
-#include <dali/public-api/math/vector3.h>
-#include <dali/public-api/math/vector4.h>
-#include <dali/public-api/math/quaternion.h>
#include <dali/public-api/math/matrix.h>
#include <dali/public-api/math/matrix3.h>
+#include <dali/public-api/math/quaternion.h>
+#include <dali/public-api/math/vector3.h>
+#include <dali/public-api/math/vector4.h>
#include <dali/public-api/object/property-input.h>
namespace Dali
{
+/**
+ * @addtogroup dali_core_animation
+ * @{
+ */
/**
- * @brief EqualToConstraint
+ * @brief The constraint function that updates the target property with the value of the first source.
*
- * f(current, property) = property
+ * @e current = <em>input[0]</em>. @e current and <em>input[0]</em> indicate the target property
+ * and the first constraint source (the one added by the first Constraint::AddSource call), respectively.
+ * @SINCE_1_0.0
*/
struct EqualToConstraint
{
/**
* @brief Constructor.
+ * @SINCE_1_0.0
*/
- EqualToConstraint()
- { }
+ EqualToConstraint() = default;
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for float properties.
*
- * @param[in, out] current The current property value, the constrained value is set
+ * @SINCE_1_0.0
+ * @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( float& current, const PropertyInputContainer& inputs )
+ void operator()(float& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetFloat();
}
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for Vector2 properties.
*
- * @param[in] current The current property value, the constrained value is set
+ * @SINCE_1_0.0
+ * @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( Vector2& current, const PropertyInputContainer& inputs )
+ void operator()(Vector2& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetVector2();
}
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for Vector3 properties.
*
+ * @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( Vector3& current, const PropertyInputContainer& inputs )
+ void operator()(Vector3& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetVector3();
}
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for Vector4 properties.
*
+ * @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( Vector4& current, const PropertyInputContainer& inputs )
+ void operator()(Vector4& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetVector4();
}
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for Quaternion properties.
*
+ * @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( Quaternion& current, const PropertyInputContainer& inputs )
+ void operator()(Quaternion& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetQuaternion();
}
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for Matrix3 properties.
*
+ * @SINCE_1_0.0
* @param[in,out] current The current property value
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( Matrix3& current, const PropertyInputContainer& inputs )
+ void operator()(Matrix3& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetMatrix3();
}
/**
- * @brief override functor for float properties
+ * @brief Overrides functor for Matrix properties.
*
+ * @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
- * @return The copy of the input property
*/
- void operator()( Matrix& current, const PropertyInputContainer& inputs )
+ void operator()(Matrix& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetMatrix();
}
-
};
/**
- * @brief RelativeToConstraint for Vector3 properties
+ * @brief The constraint function that updates the target property with the value of the first source
+ * multiplied by scale parameter (for Vector3 properties).
*
- * current = property * scale
+ * @e current = <em>input[0]</em> * @e scale. @e current, <em>input[0]</em>, and @e scale
+ * indicates the target property, the first constraint source, and the scale parameter, respectively.
+ * * implies element-wise multiplication.
+ * @SINCE_1_0.0
*/
struct RelativeToConstraint
{
/**
* @brief Constructor.
+ * @SINCE_1_0.0
+ * @param[in] scale Scale factor
*/
- RelativeToConstraint( float scale )
- : mScale( scale, scale, scale ) { }
+ RelativeToConstraint(float scale)
+ : mScale(scale, scale, scale)
+ {
+ }
/**
* @brief Constructor.
+ * @SINCE_1_0.0
+ * @param[in] scale Scale factor
*/
- RelativeToConstraint( const Vector3& scale )
- : mScale( scale ) { }
+ RelativeToConstraint(const Vector3& scale)
+ : mScale(scale)
+ {
+ }
/**
* @brief Functor.
+ * @SINCE_1_0.0
+ * @param[in,out] current The current property value (vector3 property * scale factor)
+ * @param[in] inputs Property container for current property calculation
*/
- void operator()( Vector3& current, const PropertyInputContainer& inputs )
+ void operator()(Vector3& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetVector3() * mScale;
}
};
/**
- * @brief RelativeToConstraint for float properties
+ * @brief The constraint function that updates the target property with the value of the first source
+ * multiplied by scale parameter (for float properties).
+ *
+ * @e current = <em>input[0]</em> * @e scale. @e current, <em>input[0]</em>, and @e scale
+ * indicates the target property, the first constraint source, and the scale parameter, respectively.
+ * @SINCE_1_0.0
*/
struct RelativeToConstraintFloat
{
/**
* @brief Constructor.
+ * @SINCE_1_0.0
+ * @param[in] scale Scale factor
*/
- RelativeToConstraintFloat( float scale )
- : mScale( scale ) { }
+ RelativeToConstraintFloat(float scale)
+ : mScale(scale)
+ {
+ }
/**
* @brief Functor.
+ * @SINCE_1_0.0
+ * @param[in,out] current The current property value (float property * scale factor)
+ * @param[in] inputs Property container for current property calculation
*/
- void operator()( float& current, const PropertyInputContainer& inputs )
+ void operator()(float& current, const PropertyInputContainer& inputs)
{
current = inputs[0]->GetFloat() * mScale;
}
* @brief Constraint function to aim a camera at a target.
*
* Constraint which sets camera's orientation given camera world position
- * and a target world position. Uses target's up vector to orient the
+ * and a target world position. Uses target's up vector to orient the
* constrained actor along the vector between camera position and
* target position.
*
- * @param[in,out] current The current orientation property value, the constrained value is set.
- * @param[in] inputs Contains the World position of the target, the World position of the camera, and the world orientation of the target
- * @return The orientation of the camera
+ * @SINCE_1_0.0
+ * @param[in,out] current The current orientation property value, the constrained value is set
+ * @param[in] inputs Contains the world position of the target, the world position of the camera, and the world orientation of the target
*/
-inline void LookAt( Quaternion& current, const PropertyInputContainer& inputs )
+inline void LookAt(Dali::Quaternion& current, const Dali::PropertyInputContainer& inputs)
{
- const PropertyInput& targetPosition( *inputs[0] );
- const PropertyInput& cameraPosition( *inputs[1] );
- const PropertyInput& targetOrientation( *inputs[2] );
+ const PropertyInput& targetPosition(*inputs[0]);
+ const PropertyInput& cameraPosition(*inputs[1]);
+ const PropertyInput& targetOrientation(*inputs[2]);
Vector3 vForward = targetPosition.GetVector3() - cameraPosition.GetVector3();
vForward.Normalize();
Vector3 vY = vForward.Cross(vX);
vY.Normalize();
- current = Quaternion( vX, vY, vForward );
+ current = Quaternion(vX, vY, vForward);
}
+/**
+ * @}
+ */
} // namespace Dali
-#endif // __DALI_CONSTRAINTS_H__
+#endif // DALI_CONSTRAINTS_H
projects / platform / core / uifw / dali-core.git / blobdiff