- For document public release, Native API reference is checked by Lionbridge.
Change-Id: I4a1a1a364975a56e3c4a04664e8170ff950d612b
Signed-off-by: Seoyeon Kim <seoyeon2.kim@samsung.com>
*/
/**
- * @brief Actor color mode.
+ * @brief Enumeration for Actor color mode.
*
* @SINCE_1_0.0
*/
/**
* @DEPRECATED_1_1.24 Use SetInheritPosition instead
- * @brief Actor position inheritance mode.
+ * @brief Enumeration for Actor position inheritance mode.
* @SINCE_1_0.0
*/
enum PositionInheritanceMode
};
/**
- * @brief Dimensions for layout
+ * @brief Enumeration for layout Dimensions.
* @SINCE_1_0.0
*/
namespace Dimension
{
/**
- * @brief The type of Dimension
+ * @brief Enumeration for Dimension types.
* @SINCE_1_0.0
*/
enum Type
};
/**
- * @brief The number of dimensions
+ * @brief Enumeration for Dimension number.
* @SINCE_1_0.0
*/
enum Meta
}
/**
- * @brief Size negotiation resize policies
+ * @brief Enumeration for size negotiation resize policies.
* @SINCE_1_0.0
*/
namespace ResizePolicy
{
/**
- * @brief The type of ResizePolicy
+ * @brief Enumeration for ResizePolicy types.
* @SINCE_1_0.0
*/
enum Type
}
/**
- * @brief Policies to determine how an actor should resize itself when having its size set in size negotiation
+ * @brief Enumeration for policies to determine how an actor should resize itself when having its size set in size negotiation.
* @SINCE_1_0.0
*/
namespace SizeScalePolicy
{
/**
- * @brief The type of SizeScalePolicy
+ * @brief Enumeration for SizeScalePolicy types.
* @SINCE_1_0.0
*/
enum Type
}
/**
- * @brief Horizontal alignment types.
+ * @brief Enumeration for horizontal alignment types.
* @SINCE_1_0.0
*/
namespace HorizontalAlignment
{
/**
- * @brief The type of HorizontalAlignment
+ * @brief Enumeration for HorizontalAlignment types.
* @SINCE_1_0.0
*/
enum Type
}
/**
- * @brief Vertical alignment types.
+ * @brief Enumeration for vertical alignment types.
* @SINCE_1_0.0
*/
namespace VerticalAlignment
{
/**
- * @brief The type of VerticalAlignment
+ * @brief Enumeration for VerticalAlignment types.
* @SINCE_1_0.0
*/
enum Type
}
/**
- * @brief The ClippingMode describes how this Actors children will be clipped against it.
+ * @brief Enumeration for ClippingMode describing how this Actor's children will be clipped against it.
* @SINCE_1_2_5
*/
namespace ClippingMode
{
/**
- * @brief The type of ClippingMode
+ * @brief Enumeration for ClippingMode types.
* @SINCE_1_2_5
*/
enum Type
*
* - An actor is only hittable if the actor's touch or hover signal has a connection.
* - An actor is only hittable when it is between the camera's near and far planes.
- * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive()
- * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible()
+ * - If an actor is made insensitive, then the actor and its children are not hittable; see IsSensitive().
+ * - If an actor's visibility flag is unset, then none of its children are hittable either; see IsVisible().
* - To be hittable, an actor must have a non-zero size.
- * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor()
+ * - If an actor's world color is fully transparent, then it is not hittable; see GetCurrentWorldColor().
*
* <i>Hit Test Algorithm:</i>
*
* }
* @endcode
* - If there are several touch points, then the delivery is only to the first touch point's hit
- * actor (and its parents). There will be NO touch or hover signal delivery for the hit actors of the
+ * actor (and its parents). There will be NO touch or hover signal delivery for the hit actors of the
* other touch points.
* - The local coordinates are from the top-left (0.0f, 0.0f, 0.5f) of the hit actor.
*
public:
/**
- * @brief An enumeration of properties belonging to the Actor class.
+ * @brief Enumeration for the instance of properties belonging to the Actor class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Actor class.
+ * @brief Enumeration for instance of properties belonging to the Actor class.
* @SINCE_1_0.0
*/
enum
// Creation
/**
- * @brief Create an uninitialized Actor; this can be initialized with Actor::New().
+ * @brief Creates an uninitialized Actor; this can be initialized with Actor::New().
*
* Calling member functions with an uninitialized Actor handle is not allowed.
* @SINCE_1_0.0
Actor();
/**
- * @brief Create an initialized Actor.
+ * @brief Creates an initialized Actor.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static Actor New();
/**
- * @brief Downcast a handle to Actor handle.
+ * @brief Downcasts a handle to Actor handle.
*
- * If handle points to a Actor object the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If handle points to an Actor object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle to An object
static Actor DownCast( BaseHandle handle );
/**
- * @brief Dali::Actor is intended as a base class
+ * @brief Dali::Actor is intended as a base class.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~Actor();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] copy The actor to copy.
+ * @param[in] copy The actor to copy
*/
Actor(const Actor& copy);
* @brief Assignment operator
*
* @SINCE_1_0.0
- * @param [in] rhs The actor to copy.
+ * @param[in] rhs The actor to copy
* @return A reference to this
*/
Actor& operator=(const Actor& rhs);
/**
- * @brief Retrieve the Actor's name.
+ * @brief Retrieves the Actor's name.
*
* @SINCE_1_0.0
- * @return The Actor's name.
+ * @return The Actor's name
* @pre The Actor has been initialized.
*/
const std::string& GetName() const;
* @brief Sets the Actor's name.
*
* @SINCE_1_0.0
- * @param [in] name The new name.
+ * @param[in] name The new name
* @pre The Actor has been initialized.
*/
void SetName(const std::string& name);
/**
- * @brief Retrieve the unique ID of the actor.
+ * @brief Retrieves the unique ID of the actor.
*
* @SINCE_1_0.0
- * @return The ID.
+ * @return The ID
* @pre The Actor has been initialized.
*/
unsigned int GetId() const;
// Containment
/**
- * @brief Query whether an actor is the root actor, which is owned by the Stage.
+ * @brief Queries whether an actor is the root actor, which is owned by the Stage.
*
* @SINCE_1_0.0
- * @return True if the actor is the root actor.
+ * @return True if the actor is the root actor
* @pre The Actor has been initialized.
*/
bool IsRoot() const;
/**
- * @brief Query whether the actor is connected to the Stage.
+ * @brief Queries whether the actor is connected to the Stage.
*
* When an actor is connected, it will be directly or indirectly parented to the root Actor.
* @SINCE_1_0.0
- * @return True if the actor is connected to the Stage.
+ * @return True if the actor is connected to the Stage
* @pre The Actor has been initialized.
* @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
*/
bool OnStage() const;
/**
- * @brief Query whether the actor is of class Dali::Layer.
+ * @brief Queries whether the actor is of class Dali::Layer.
*
* @SINCE_1_0.0
- * @return True if the actor is a layer.
+ * @return True if the actor is a layer
* @pre The Actor has been initialized.
*/
bool IsLayer() const;
* @brief Gets the layer in which the actor is present.
*
* @SINCE_1_0.0
- * @return The layer, which will be uninitialized if the actor is off-stage.
+ * @return The layer, which will be uninitialized if the actor is off-stage
* @pre The Actor has been initialized.
*/
Layer GetLayer();
* @brief Adds a child Actor to this Actor.
*
* @SINCE_1_0.0
- * @param [in] child The child.
+ * @param[in] child The child
* @pre This Actor (the parent) has been initialized.
* @pre The child actor has been initialized.
* @pre The child actor is not the same as the parent actor.
* @pre The actor is not the Root actor.
* @post The child will be referenced by its parent. This means that the child will be kept alive,
* even if the handle passed into this method is reset or destroyed.
- * @note if the child already has a parent, it will be removed from old parent
- * and reparented to this actor. This may change childs position, color,
+ * @note If the child already has a parent, it will be removed from old parent
+ * and reparented to this actor. This may change child's position, color,
* scale etc as it now inherits them from this actor.
*/
void Add(Actor child);
*
* If the actor was not a child of this actor, this is a no-op.
* @SINCE_1_0.0
- * @param [in] child The child.
+ * @param[in] child The child
* @pre This Actor (the parent) has been initialized.
* @pre The child actor is not the same as the parent actor.
*/
void Unparent();
/**
- * @brief Retrieve the number of children held by the actor.
+ * @brief Retrieves the number of children held by the actor.
*
* @SINCE_1_0.0
* @return The number of children
*
* @SINCE_1_0.0
* @param[in] index The index of the child to retrieve
- * @return The actor for the given index or empty handle if children not initialised
+ * @return The actor for the given index or empty handle if children not initialized
* @pre The Actor has been initialized.
*/
Actor GetChildAt(unsigned int index) const;
*
* The actor itself is also considered in the search.
* @SINCE_1_0.0
- * @param[in] actorName the name of the actor to find
- * @return A handle to the actor if found, or an empty handle if not.
+ * @param[in] actorName The name of the actor to find
+ * @return A handle to the actor if found, or an empty handle if not
* @pre The Actor has been initialized.
*/
Actor FindChildByName(const std::string& actorName);
*
* The actor itself is also considered in the search.
* @SINCE_1_0.0
- * @param[in] id the ID of the actor to find
- * @return A handle to the actor if found, or an empty handle if not.
+ * @param[in] id The ID of the actor to find
+ * @return A handle to the actor if found, or an empty handle if not
* @pre The Actor has been initialized.
*/
Actor FindChildById(const unsigned int id);
/**
- * @brief Retrieve the actor's parent.
+ * @brief Retrieves the actor's parent.
*
* @SINCE_1_0.0
- * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid.
+ * @return A handle to the actor's parent. If the actor has no parent, this handle will be invalid
* @pre The actor has been initialized.
*/
Actor GetParent() const;
// Positioning
/**
- * @brief Set the origin of an actor, within its parent's area.
+ * @brief Sets the origin of an actor, within its parent's area.
*
* This is expressed in unit coordinates, such that (0.0, 0.0, 0.5) is the top-left corner of the parent,
* and (1.0, 1.0, 0.5) is the bottom-right corner.
* The default parent-origin is Dali::ParentOrigin::TOP_LEFT (0.0, 0.0, 0.5).
- * An actor position is the distance between this origin, and the actors anchor-point.
+ * An actor's position is the distance between this origin, and the actor's anchor-point.
* @image html parent-origin.png
* @SINCE_1_0.0
- * @param [in] origin The new parent-origin.
+ * @param[in] origin The new parent-origin
* @pre The Actor has been initialized.
* @see Dali::ParentOrigin for predefined parent origin values
*/
void SetParentOrigin(const Vector3& origin);
/**
- * @brief Retrieve the parent-origin of an actor.
+ * @brief Retrieves the parent-origin of an actor.
*
* @SINCE_1_0.0
- * @return The current parent-origin.
+ * @return The current parent-origin
* @pre The Actor has been initialized.
*/
Vector3 GetCurrentParentOrigin() const;
/**
- * @brief Set the anchor-point of an actor.
+ * @brief Sets the anchor-point of an actor.
*
* This is expressed in unit coordinates, such that (0.0, 0.0, 0.5)
* is the top-left corner of the actor, and (1.0, 1.0, 0.5) is the
- * bottom-right corner. The default anchor point is
+ * bottom-right corner. The default anchor point is
* Dali::AnchorPoint::CENTER (0.5, 0.5, 0.5).
* An actor position is the distance between its parent-origin and this anchor-point.
* An actor's orientation is the rotation from its default orientation, the rotation is centered around its anchor-point.
* @image html anchor-point.png
* @SINCE_1_0.0
- * @param [in] anchorPoint The new anchor-point.
+ * @param[in] anchorPoint The new anchor-point
* @pre The Actor has been initialized.
* @see Dali::AnchorPoint for predefined anchor point values
*/
void SetAnchorPoint(const Vector3& anchorPoint);
/**
- * @brief Retrieve the anchor-point of an actor.
+ * @brief Retrieves the anchor-point of an actor.
*
* @SINCE_1_0.0
- * @return The current anchor-point.
+ * @return The current anchor-point
* @pre The Actor has been initialized.
*/
Vector3 GetCurrentAnchorPoint() const;
* This does not interfere with the actors scale factor.
* The actors default depth is the minimum of width & height.
* @SINCE_1_0.0
- * @param [in] width The new width.
- * @param [in] height The new height.
+ * @param [in] width The new width
+ * @param [in] height The new height
* @pre The actor has been initialized.
*/
void SetSize(float width, float height);
* Geometry can be scaled to fit within this area.
* This does not interfere with the actors scale factor.
* @SINCE_1_0.0
- * @param [in] width The size of the actor along the x-axis.
- * @param [in] height The size of the actor along the y-axis.
- * @param [in] depth The size of the actor along the z-axis.
+ * @param[in] width The size of the actor along the x-axis
+ * @param[in] height The size of the actor along the y-axis
+ * @param[in] depth The size of the actor along the z-axis
* @pre The actor has been initialized.
*/
void SetSize(float width, float height, float depth);
* This does not interfere with the actors scale factor.
* The actors default depth is the minimum of width & height.
* @SINCE_1_0.0
- * @param [in] size The new size.
+ * @param[in] size The new size
* @pre The actor has been initialized.
*/
void SetSize(const Vector2& size);
* Geometry can be scaled to fit within this area.
* This does not interfere with the actors scale factor.
* @SINCE_1_0.0
- * @param [in] size The new size.
+ * @param [in] size The new size
* @pre The actor has been initialized.
*/
void SetSize(const Vector3& size);
/**
- * @brief Retrieve the actor's size.
+ * @brief Retrieves the actor's size.
*
* @SINCE_1_0.0
- * @return The actor's target size.
+ * @return The actor's target size
* @pre The actor has been initialized.
* @note This return is the value that was set using SetSize or the target size of an animation.
*/
Vector3 GetTargetSize() const;
/**
- * @brief Retrieve the actor's size.
+ * @brief Retrieves the actor's size.
*
* @SINCE_1_0.0
- * @return The actor's current size.
+ * @return The actor's current size
* @pre The actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetSize().
*/
Vector3 GetCurrentSize() const;
/**
- * @brief Return the natural size of the actor.
+ * @brief Returns the natural size of the actor.
*
* Deriving classes stipulate the natural size and by default an actor has a ZERO natural size.
*
* @image html actor-position.png
* The Actor's z position will be set to 0.0f.
* @SINCE_1_0.0
- * @param [in] x The new x position
- * @param [in] y The new y position
+ * @param[in] x The new x position
+ * @param[in] y The new y position
* @pre The Actor has been initialized.
*/
void SetPosition(float x, float y);
*
* @image html actor-position.png
* @SINCE_1_0.0
- * @param [in] x The new x position
- * @param [in] y The new y position
- * @param [in] z The new z position
+ * @param[in] x The new x position
+ * @param[in] y The new y position
+ * @param[in] z The new z position
* @pre The Actor has been initialized.
*/
void SetPosition(float x, float y, float z);
*
* @image html actor-position.png
* @SINCE_1_0.0
- * @param [in] position The new position
+ * @param[in] position The new position
* @pre The Actor has been initialized.
*/
void SetPosition(const Vector3& position);
/**
- * @brief Set the position of an actor along the X-axis.
+ * @brief Sets the position of an actor along the X-axis.
*
* @SINCE_1_0.0
- * @param [in] x The new x position
+ * @param[in] x The new x position
* @pre The Actor has been initialized.
*/
void SetX(float x);
/**
- * @brief Set the position of an actor along the Y-axis.
+ * @brief Sets the position of an actor along the Y-axis.
*
* @SINCE_1_0.0
- * @param [in] y The new y position.
+ * @param[in] y The new y position
* @pre The Actor has been initialized.
*/
void SetY(float y);
/**
- * @brief Set the position of an actor along the Z-axis.
+ * @brief Sets the position of an actor along the Z-axis.
*
* @SINCE_1_0.0
- * @param [in] z The new z position
+ * @param[in] z The new z position
* @pre The Actor has been initialized.
*/
void SetZ(float z);
/**
- * @brief Translate an actor relative to its existing position.
+ * @brief Translates an actor relative to its existing position.
*
* @SINCE_1_0.0
- * @param[in] distance The actor will move by this distance.
+ * @param[in] distance The actor will move by this distance
* @pre The actor has been initialized.
*/
void TranslateBy(const Vector3& distance);
/**
- * @brief Retrieve the position of the Actor.
+ * @brief Retrieves the position of the Actor.
*
* @SINCE_1_0.0
- * @return the Actor's current position.
+ * @return The Actor's current position
* @pre The Actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetPosition().
*/
Vector3 GetCurrentPosition() const;
/**
- * @brief Retrieve the world-position of the Actor.
+ * @brief Retrieves the world-position of the Actor.
*
* @SINCE_1_0.0
- * @return The Actor's current position in world coordinates.
+ * @return The Actor's current position in world coordinates
* @pre The Actor has been initialized.
* @note The actor may not have a world-position unless it has been added to the stage.
*/
/**
* @DEPRECATED_1_1.24 Use SetInheritPosition instead
- * @brief Set the actors position inheritance mode.
+ * @brief Sets the actors position inheritance mode.
*
* The default is to inherit.
* Switching this off means that using SetPosition() sets the actor's world position.
void SetPositionInheritanceMode( PositionInheritanceMode mode ) DALI_DEPRECATED_API;
/**
- * @brief Set whether a child actor inherits it's parent's position.
+ * @brief Sets whether a child actor inherits it's parent's position.
*
* Default is to inherit.
* Switching this off means that using SetPosition() sets the actor's world position, i.e. translates from
* the world origin (0,0,0) to the anchor point of the actor.
* @SINCE_1_1.24
- * @param[in] inherit - true if the actor should inherit position, false otherwise.
+ * @param[in] inherit - @c true if the actor should inherit position, @c false otherwise
* @pre The Actor has been initialized.
*/
inline void SetInheritPosition( bool inherit )
* @brief Returns the actors position inheritance mode.
*
* @SINCE_1_0.0
- * @return Return the position inheritance mode.
+ * @return Return the position inheritance mode
* @pre The Actor has been initialized.
*/
PositionInheritanceMode GetPositionInheritanceMode() const DALI_DEPRECATED_API;
* @brief Returns whether the actor inherits its parent's position.
*
* @SINCE_1_1.24
- * @return True if the actor inherits its parent position, false if it uses world position.
+ * @return @c true if the actor inherits its parent position, @c false if it uses world position
* @pre The Actor has been initialized.
*/
inline bool IsPositionInherited() const
*
* An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
* @SINCE_1_0.0
- * @param [in] angle The new orientation angle in degrees.
- * @param [in] axis The new axis of orientation.
+ * @param[in] angle The new orientation angle in degrees
+ * @param[in] axis The new axis of orientation
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
*/
*
* An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
* @SINCE_1_0.0
- * @param [in] angle The new orientation angle in radians.
- * @param [in] axis The new axis of orientation.
+ * @param[in] angle The new orientation angle in radians
+ * @param[in] axis The new axis of orientation
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
*/
*
* An actor's orientation is the rotation from its default orientation, and the rotation is centered around its anchor-point.
* @SINCE_1_0.0
- * @param [in] orientation The new orientation.
+ * @param[in] orientation The new orientation
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOrientation().
*/
void SetOrientation(const Quaternion& orientation);
/**
- * @brief Apply a relative rotation to an actor.
+ * @brief Applies a relative rotation to an actor.
*
* @SINCE_1_0.0
- * @param[in] angle The angle to the rotation to combine with the existing orientation.
- * @param[in] axis The axis of the rotation to combine with the existing orientation.
+ * @param[in] angle The angle to the rotation to combine with the existing orientation
+ * @param[in] axis The axis of the rotation to combine with the existing orientation
* @pre The actor has been initialized.
*/
void RotateBy( const Degree& angle, const Vector3& axis )
}
/**
- * @brief Apply a relative rotation to an actor.
+ * @brief Applies a relative rotation to an actor.
*
* @SINCE_1_0.0
- * @param[in] angle The angle to the rotation to combine with the existing orientation.
- * @param[in] axis The axis of the rotation to combine with the existing orientation.
+ * @param[in] angle The angle to the rotation to combine with the existing orientation
+ * @param[in] axis The axis of the rotation to combine with the existing orientation
* @pre The actor has been initialized.
*/
void RotateBy(const Radian& angle, const Vector3& axis);
/**
- * @brief Apply a relative rotation to an actor.
+ * @brief Applies a relative rotation to an actor.
*
* @SINCE_1_0.0
- * @param[in] relativeRotation The rotation to combine with the existing orientation.
+ * @param[in] relativeRotation The rotation to combine with the existing orientation
* @pre The actor has been initialized.
*/
void RotateBy(const Quaternion& relativeRotation);
/**
- * @brief Retreive the Actor's orientation.
+ * @brief Retrieves the Actor's orientation.
*
* @SINCE_1_0.0
- * @return The current orientation.
+ * @return The current orientation
* @pre The Actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetOrientation().
*/
Quaternion GetCurrentOrientation() const;
/**
- * @brief Set whether a child actor inherits it's parent's orientation.
+ * @brief Sets whether a child actor inherits it's parent's orientation.
*
* Default is to inherit.
* Switching this off means that using SetOrientation() sets the actor's world orientation.
* @SINCE_1_0.0
- * @param[in] inherit - true if the actor should inherit orientation, false otherwise.
+ * @param[in] inherit - @c true if the actor should inherit orientation, @c false otherwise
* @pre The Actor has been initialized.
*/
void SetInheritOrientation(bool inherit);
* @brief Returns whether the actor inherits its parent's orientation.
*
* @SINCE_1_0.0
- * @return True if the actor inherits its parent orientation, false if it uses world orientation.
+ * @return @c true if the actor inherits its parent orientation, @c false if it uses world orientation
* @pre The Actor has been initialized.
*/
bool IsOrientationInherited() const;
/**
- * @brief Retrieve the world-orientation of the Actor.
+ * @brief Retrieves the world-orientation of the Actor.
*
* @SINCE_1_0.0
- * @return The Actor's current orientation in the world.
+ * @return The Actor's current orientation in the world
* @pre The Actor has been initialized.
* @note The actor will not have a world-orientation, unless it has previously been added to the stage.
*/
Quaternion GetCurrentWorldOrientation() const;
/**
- * @brief Set the scale factor applied to an actor.
+ * @brief Sets the scale factor applied to an actor.
*
* @SINCE_1_0.0
- * @param [in] scale The scale factor applied on all axes.
+ * @param[in] scale The scale factor applied on all axes
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
*/
void SetScale(float scale);
/**
- * @brief Set the scale factor applied to an actor.
+ * @brief Sets the scale factor applied to an actor.
*
* @SINCE_1_0.0
- * @param [in] scaleX The scale factor applied along the x-axis.
- * @param [in] scaleY The scale factor applied along the y-axis.
- * @param [in] scaleZ The scale factor applied along the z-axis.
+ * @param[in] scaleX The scale factor applied along the x-axis
+ * @param[in] scaleY The scale factor applied along the y-axis
+ * @param[in] scaleZ The scale factor applied along the z-axis
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
*/
void SetScale(float scaleX, float scaleY, float scaleZ);
/**
- * @brief Set the scale factor applied to an actor.
+ * @brief Sets the scale factor applied to an actor.
*
* @SINCE_1_0.0
- * @param [in] scale A vector representing the scale factor for each axis.
+ * @param[in] scale A vector representing the scale factor for each axis
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentScale().
*/
void SetScale(const Vector3& scale);
/**
- * @brief Apply a relative scale to an actor.
+ * @brief Applies a relative scale to an actor.
*
* @SINCE_1_0.0
- * @param[in] relativeScale The scale to combine with the actor's existing scale.
+ * @param[in] relativeScale The scale to combine with the actor's existing scale
* @pre The actor has been initialized.
*/
void ScaleBy(const Vector3& relativeScale);
/**
- * @brief Retrieve the scale factor applied to an actor.
+ * @brief Retrieves the scale factor applied to an actor.
*
* @SINCE_1_0.0
- * @return A vector representing the scale factor for each axis.
+ * @return A vector representing the scale factor for each axis
* @pre The Actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetScale().
*/
Vector3 GetCurrentScale() const;
/**
- * @brief Retrieve the world-scale of the Actor.
+ * @brief Retrieves the world-scale of the Actor.
*
* @SINCE_1_0.0
- * @return The Actor's current scale in the world.
+ * @return The Actor's current scale in the world
* @pre The Actor has been initialized.
* @note The actor will not have a world-scale, unless it has previously been added to the stage.
*/
Vector3 GetCurrentWorldScale() const;
/**
- * @brief Set whether a child actor inherits it's parent's scale.
+ * @brief Sets whether a child actor inherits it's parent's scale.
*
* Default is to inherit.
* Switching this off means that using SetScale() sets the actor's world scale.
* @SINCE_1_0.0
- * @param[in] inherit - true if the actor should inherit scale, false otherwise.
+ * @param[in] inherit - @c true if the actor should inherit scale, @c false otherwise
* @pre The Actor has been initialized.
*/
void SetInheritScale( bool inherit );
* @brief Returns whether the actor inherits its parent's scale.
*
* @SINCE_1_0.0
- * @return True if the actor inherits its parent scale, false if it uses world scale.
+ * @return @c true if the actor inherits its parent scale, @c false if it uses world scale
* @pre The Actor has been initialized.
*/
bool IsScaleInherited() const;
* @brief Sets the visibility flag of an actor.
*
* @SINCE_1_0.0
- * @param [in] visible The new visibility flag.
+ * @param[in] visible The new visibility flag
* @pre The actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with IsVisible().
* @note If an actor's visibility flag is set to false, then the actor and its children will not be rendered.
void SetVisible(bool visible);
/**
- * @brief Retrieve the visibility flag of an actor.
+ * @brief Retrieves the visibility flag of an actor.
*
* @SINCE_1_0.0
- * @return The visibility flag.
+ * @return The visibility flag
* @pre The actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetVisible().
* @note If an actor is not visible, then the actor and its children will not be rendered.
* @brief Sets the opacity of an actor.
*
* @SINCE_1_0.0
- * @param [in] opacity The new opacity.
+ * @param[in] opacity The new opacity
* @pre The actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentOpacity().
*/
void SetOpacity(float opacity);
/**
- * @brief Retrieve the actor's opacity.
+ * @brief Retrieves the actor's opacity.
*
* @SINCE_1_0.0
- * @return The actor's opacity.
+ * @return The actor's opacity
* @pre The actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetOpacity().
*/
*
* The final color of the actor depends on its color mode.
* @SINCE_1_0.0
- * @param [in] color The new color.
+ * @param[in] color The new color
* @pre The Actor has been initialized.
* @note This is an asynchronous method; the value written may not match a value subsequently read with GetCurrentColor().
*/
void SetColor(const Vector4& color);
/**
- * @brief Retrieve the actor's color.
+ * @brief Retrieves the actor's color.
*
* Actor's own color is not clamped.
* @SINCE_1_0.0
- * @return The color.
+ * @return The color
* @pre The Actor has been initialized.
* @note This property can be animated; the return value may not match the value written with SetColor().
*/
* This specifies whether the Actor uses its own color, or inherits
* its parent color. The default is USE_OWN_MULTIPLY_PARENT_ALPHA.
* @SINCE_1_0.0
- * @param [in] colorMode to use.
+ * @param[in] colorMode ColorMode to use
* @pre The Actor has been initialized.
*/
void SetColorMode( ColorMode colorMode );
* @brief Returns the actor's color mode.
*
* @SINCE_1_0.0
- * @return currently used colorMode.
+ * @return Currently used colorMode
* @pre The Actor has been initialized.
*/
ColorMode GetColorMode() const;
/**
- * @brief Retrieve the world-color of the Actor, where each component is clamped within the 0->1 range.
+ * @brief Retrieves the world-color of the Actor, where each component is clamped within the 0->1 range.
*
* @SINCE_1_0.0
- * @return The Actor's current color in the world.
+ * @return The Actor's current color in the world
* @pre The Actor has been initialized.
* @note The actor will not have a world-color, unless it has previously been added to the stage.
*/
Vector4 GetCurrentWorldColor() const;
/**
- * @brief Set how the actor and its children should be drawn.
+ * @brief Sets how the actor and its children should be drawn.
*
* Not all actors are renderable, but DrawMode can be inherited from any actor.
* If an object is in a 3D layer, it will be depth-tested against
* and depth-testing will not be used.
* @SINCE_1_0.0
- * @param[in] drawMode The new draw-mode to use.
+ * @param[in] drawMode The new draw-mode to use
* @note Layers do not inherit the DrawMode from their parents.
*/
void SetDrawMode( DrawMode::Type drawMode );
/**
- * @brief Query how the actor and its children will be drawn.
+ * @brief Queries how the actor and its children will be drawn.
*
* @SINCE_1_0.0
- * @return Return the draw mode type.
+ * @return Return the draw mode type
*/
DrawMode::Type GetDrawMode() const;
* @endcode
*
* @SINCE_1_0.0
- * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise.
+ * @param[in] sensitive true to enable emission of the touch or hover event signals, false otherwise
* @pre The Actor has been initialized.
* @note If an actor's sensitivity is set to false, then it's children will not be hittable either.
* This is regardless of the individual sensitivity values of the children i.e. an actor will only be
void SetSensitive(bool sensitive);
/**
- * @brief Query whether an actor emits touch or hover event signals.
+ * @brief Queries whether an actor emits touch or hover event signals.
*
* @SINCE_1_0.0
- * @return True, if emission of touch or hover event signals is enabled, false otherwise.
+ * @return @c true, if emission of touch or hover event signals is enabled, @c false otherwise
* @pre The Actor has been initialized.
* @note If an actor is not sensitive, then it's children will not be hittable either.
* This is regardless of the individual sensitivity values of the children i.e. an actor will only be
* @brief Converts screen coordinates into the actor's coordinate system using the default camera.
*
* @SINCE_1_0.0
- * @param[out] localX On return, the X-coordinate relative to the actor.
- * @param[out] localY On return, the Y-coordinate relative to the actor.
- * @param[in] screenX The screen X-coordinate.
- * @param[in] screenY The screen Y-coordinate.
- * @return True if the conversion succeeded.
+ * @param[out] localX On return, the X-coordinate relative to the actor
+ * @param[out] localY On return, the Y-coordinate relative to the actor
+ * @param[in] screenX The screen X-coordinate
+ * @param[in] screenY The screen Y-coordinate
+ * @return True if the conversion succeeded
* @pre The Actor has been initialized.
* @note The actor coordinates are relative to the top-left (0.0, 0.0, 0.5)
*/
* the boundary of the actor.
*
* @SINCE_1_0.0
- * @param[in] required Should be set to true if a Leave event is required
+ * @param[in] required Should be set to true if a Leave event is required
* @pre The Actor has been initialized.
* @note By default, this is set to false as most actors do not require this.
* @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
* the boundary of the actor.
*
* @SINCE_1_0.0
- * @return True if a Leave event is required, false otherwise.
+ * @return @c true if a Leave event is required, @c false otherwise
* @pre The Actor has been initialized.
*/
bool GetLeaveRequired() const;
* The default is false.
* @SINCE_1_0.0
* @param[in] focusable - true if the actor should be focusable by keyboard navigation,
- * false otherwise.
+ * false otherwise
* @pre The Actor has been initialized.
*/
void SetKeyboardFocusable( bool focusable );
* @brief Returns whether the actor is focusable by keyboard navigation.
*
* @SINCE_1_0.0
- * @return True if the actor is focusable by keyboard navigation, false if not.
+ * @return @c true if the actor is focusable by keyboard navigation, @c false if not
* @pre The Actor has been initialized.
*/
bool IsKeyboardFocusable() const;
// SIZE NEGOTIATION
/**
- * @brief Set the resize policy to be used for the given dimension(s).
+ * @brief Sets the resize policy to be used for the given dimension(s).
*
* @SINCE_1_0.0
* @param[in] policy The resize policy to use
- * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions.
+ * @param[in] dimension The dimension(s) to set policy for. Can be a bitfield of multiple dimensions
*/
void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
/**
- * @brief Return the resize policy used for a single dimension.
+ * @brief Returns the resize policy used for a single dimension.
*
* @SINCE_1_0.0
* @param[in] dimension The dimension to get policy for
- * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found.
+ * @return Return the dimension resize policy. If more than one dimension is requested, just return the first one found
*/
ResizePolicy::Type GetResizePolicy( Dimension::Type dimension ) const;
/**
- * @brief Set the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
+ * @brief Sets the policy to use when setting size with size negotiation. Defaults to SizeScalePolicy::USE_SIZE_SET.
*
* @SINCE_1_0.0
* @param[in] policy The policy to use for when the size is set
void SetSizeScalePolicy( SizeScalePolicy::Type policy );
/**
- * @brief Return the size scale policy in use.
+ * @brief Returns the size scale policy in use.
*
* @SINCE_1_0.0
- * @return Return the size scale policy.
+ * @return Return the size scale policy
*/
SizeScalePolicy::Type GetSizeScalePolicy() const;
*
* This factor is only used when ResizePolicy is set to either:
* ResizePolicy::SIZE_RELATIVE_TO_PARENT or ResizePolicy::SIZE_FIXED_OFFSET_FROM_PARENT.
- * This actor's size is set to the actor's size multipled by or added to this factor,
+ * This actor's size is set to the actor's size multiplied by or added to this factor,
* depending on ResizePolicy ( See SetResizePolicy() ).
*
* @SINCE_1_0.0
- * @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
+ * @param[in] factor A Vector3 representing the relative factor to be applied to each axis
* @pre The Actor has been initialized.
*/
void SetSizeModeFactor( const Vector3& factor );
/**
- * @brief Retrieve the relative to parent size factor of the actor.
+ * @brief Retrieves the relative to parent size factor of the actor.
*
* @SINCE_1_0.0
- * @return The Actor's current relative size factor.
+ * @return The Actor's current relative size factor
* @pre The Actor has been initialized.
*/
Vector3 GetSizeModeFactor() const;
/**
- * @brief Calculate the height of the actor given a width.
+ * @brief Calculates the height of the actor given a width.
*
* The natural size is used for default calculation.
* size 0 is treated as aspect ratio 1:1.
*
* @SINCE_1_0.0
* @param[in] width Width to use
- * @return Return the height based on the width.
+ * @return Return the height based on the width
*/
float GetHeightForWidth( float width );
/**
- * @brief Calculate the width of the actor given a height.
+ * @brief Calculates the width of the actor given a height.
*
* The natural size is used for default calculation.
* size 0 is treated as aspect ratio 1:1.
*
* @SINCE_1_0.0
* @param[in] height Height to use
- * @return Return the width based on the height.
+ * @return Return the width based on the height
*/
float GetWidthForHeight( float height );
/**
- * @brief Return the value of negotiated dimension for the given dimension.
+ * @brief Returns the value of negotiated dimension for the given dimension.
*
* @SINCE_1_0.0
* @param[in] dimension The dimension to retrieve
- * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found.
+ * @return Return the value of the negotiated dimension. If more than one dimension is requested, just return the first one found
*/
float GetRelayoutSize( Dimension::Type dimension ) const;
/**
- * @brief Set the padding for use in layout.
+ * @brief Sets the padding for use in layout.
*
* @SINCE_1_0.0
* @param[in] padding Padding for the actor
void SetPadding( const Padding& padding );
/**
- * @brief Return the value of the padding.
+ * @brief Returns the value of the padding.
*
* @SINCE_1_0.0
* @param[in] paddingOut The returned padding data
void GetPadding( Padding& paddingOut ) const;
/**
- * @brief Set the minimum size an actor can be assigned in size negotiation.
+ * @brief Sets the minimum size an actor can be assigned in size negotiation.
*
* @SINCE_1_0.0
* @param[in] size The minimum size
void SetMinimumSize( const Vector2& size );
/**
- * @brief Return the minimum relayout size.
+ * @brief Returns the minimum relayout size.
*
* @SINCE_1_0.0
- * @return Return the mininmum size.
+ * @return Return the mininmum size
*/
Vector2 GetMinimumSize();
/**
- * @brief Set the maximum size an actor can be assigned in size negotiation.
+ * @brief Sets the maximum size an actor can be assigned in size negotiation.
*
* @SINCE_1_0.0
* @param[in] size The maximum size
void SetMaximumSize( const Vector2& size );
/**
- * @brief Return the maximum relayout size.
+ * @brief Returns the maximum relayout size.
*
* @SINCE_1_0.0
- * @return Return the maximum size.
+ * @return Return the maximum size
*/
Vector2 GetMaximumSize();
/**
- * @brief Get depth in the hierarchy for the actor.
+ * @brief Gets depth in the hierarchy for the actor.
*
* @SINCE_1_0.0
- * @return The current depth in the hierarchy of the actor, or -1 if actor is not in the hierarchy
+ * @return The current depth in the hierarchy of the actor, or @c -1 if actor is not in the hierarchy
*/
int GetHierarchyDepth();
public: // Renderer
/**
- * @brief Add a renderer to this actor.
+ * @brief Adds a renderer to this actor.
*
* @SINCE_1_0.0
* @param[in] renderer Renderer to add to the actor
unsigned int AddRenderer( Renderer& renderer );
/**
- * @brief Get the number of renderers on this actor.
+ * @brief Gets the number of renderers on this actor.
*
* @SINCE_1_0.0
- * @return the number of renderers on this actor
+ * @return The number of renderers on this actor
*/
unsigned int GetRendererCount() const;
/**
- * @brief Get a Renderer by index.
+ * @brief Gets a Renderer by index.
*
* @SINCE_1_0.0
* @param[in] index The index of the renderer to fetch
Renderer GetRendererAt( unsigned int index );
/**
- * @brief Remove an renderer from the actor.
+ * @brief Removes a renderer from the actor.
*
* @SINCE_1_0.0
* @param[in] renderer Handle to the renderer that is to be removed
void RemoveRenderer( Renderer& renderer );
/**
- * @brief Remove an renderer from the actor by index.
+ * @brief Removes a renderer from the actor by index.
*
* @SINCE_1_0.0
* @param[in] index Index of the renderer that is to be removed
* The return value of True, indicates that the touch event should be consumed.
* Otherwise the signal will be emitted on the next sensitive parent of the actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Actor has been initialized.
*/
TouchSignalType& TouchedSignal() DALI_DEPRECATED_API;
* The return value of True, indicates that the touch event has been consumed.
* Otherwise the signal will be emitted on the next sensitive parent of the actor.
* @SINCE_1_1.37
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Actor has been initialized.
*/
TouchDataSignalType& TouchSignal();
* The return value of True, indicates that the hover event should be consumed.
* Otherwise the signal will be emitted on the next sensitive parent of the actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Actor has been initialized.
*/
HoverSignalType& HoveredSignal();
* The return value of True, indicates that the wheel event should be consumed.
* Otherwise the signal will be emitted on the next sensitive parent of the actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Actor has been initialized.
*/
WheelEventSignalType& WheelEventSignal();
*
* When an actor is connected, it will be directly or indirectly parented to the root Actor.
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
*
* @note When the parent of a set of actors is connected to the stage, then all of the children
* If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
*
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @note When the parent of a set of actors is disconnected to the stage, then all of the children
* will received this callback, starting with the leaf actors.
* For the following actor tree, the callback order will be D, E, B, F, C, and finally A.
* If the handle is empty, this method does nothing. Otherwise
* Actor::Unparent() will be called, followed by Actor::Reset().
* @SINCE_1_0.0
- * @param[in,out] actor A handle to an actor, or an empty handle.
+ * @param[in,out] actor A handle to an actor, or an empty handle
*/
inline void UnparentAndReset( Actor& actor )
{
}
/**
- * @brief Camera enumerations.
+ * @brief Enumeration for camera.
* @SINCE_1_0.0
*/
namespace Camera
{
/**
- * @brief Type determines how camera operates.
+ * @brief Enumeration for type determination of how camera operates.
* @SINCE_1_0.0
*/
enum Type
};
/**
- * @brief Projection modes.
+ * @brief Enumeration for projection modes.
* @SINCE_1_0.0
*/
enum ProjectionMode
*
* Allows the developer to use actor semantics to control a camera.
*
- * DALi has a concept of a camera to display its virtual 3D world to a 2D screen.
+ * DALi has a concept of a camera to display its virtual 3D world to a 2D screen.
* There are 2 ways of using the camera in DALi:
*
* - For 2D applications, you do not need to care about the camera at all. The default camera is already best suited for 2D applications
* - For 3D applications, you can change the view by manipulating the camera. You can translate or rotate the camera in this case.
* Note that the top-left corner of the screen and unit 1 no longer are (0,0,0) and 1 pixel after manipulating the camera.
*
- * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default
+ * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default,
* the camera actor will be FREE_LOOK.
*
* - A FREE_LOOK camera uses actor's orientation to control where the camera is looking.
* If no additional rotations are specified, the camera looks in the negative Z direction.
*
- * - For LOOK_AT_TARGET the actor's orientation is ignored, instead the camera looks at TARGET_POSITION
+ * - For LOOK_AT_TARGET, the actor's orientation is ignored, instead the camera looks at TARGET_POSITION
* in world coordinates.
*
* @SINCE_1_0.0
public:
/**
- * @brief An enumeration of properties belonging to the CameraActor class.
+ * @brief Enumeration for the instance of properties belonging to the CameraActor class.
*
* Properties additional to Actor.
* @SINCE_1_0.0
struct Property
{
/**
- * @brief An enumeration of properties belonging to the CameraActor class.
+ * @brief Enumeration for the instance of properties belonging to the CameraActor class.
*
* Properties additional to Actor.
* @SINCE_1_0.0
};
/**
- * @brief Create an uninitialized CameraActor handle.
+ * @brief Creates an uninitialized CameraActor handle.
*
- * Initialise it using CameraActor::New().
+ * Initialize it using CameraActor::New().
* Calling member functions with an uninitialized CameraActor handle is not allowed.
* @SINCE_1_0.0
*/
CameraActor();
/**
- * @brief Create a CameraActor object.
+ * @brief Creates a CameraActor object.
*
* Sets the default camera perspective projection for the stage's size. @see SetPerspectiveProjection().
* @SINCE_1_0.0
- * @return The newly created camera actor.
+ * @return The newly created camera actor
*/
static CameraActor New();
/**
- * @brief Create a CameraActor object.
+ * @brief Creates a CameraActor object.
*
* Sets the default camera perspective projection for the given canvas size. @see SetPerspectiveProjection().
*
* @SINCE_1_0.0
- * @param[in] size The canvas size.
- * @return The newly created camera actor.
+ * @param[in] size The canvas size
+ * @return The newly created camera actor
*/
static CameraActor New( const Size& size );
/**
- * @brief Downcast a handle to CameraActor handle.
+ * @brief Downcasts a handle to CameraActor handle.
*
- * If handle points to a CameraActor the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If handle points to a CameraActor, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle to An object
* @return Handle to a CameraActor or an uninitialized handle
static CameraActor DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
- * This is non-virtual since derived Handle types must not contain data or virtual methods.
+ * This is non-virtual, since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
*/
~CameraActor();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] copy The actor to copy.
+ * @param[in] copy The actor to copy
*/
CameraActor(const CameraActor& copy);
/**
- * @brief Assignment operator
+ * @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] rhs The actor to copy.
+ * @param[in] rhs The actor to copy
* @return A reference to this
*/
CameraActor& operator=(const CameraActor& rhs);
/**
- * @brief Set the camera type.
+ * @brief Sets the camera type.
* The default type is Dali::Camera::FREE_LOOK
* @SINCE_1_0.0
* @param[in] type The camera type
void SetType( Dali::Camera::Type type );
/**
- * @brief Get the type of the camera.
+ * @brief Gets the type of the camera.
*
* @SINCE_1_0.0
* @return The type of camera
Dali::Camera::Type GetType() const;
/**
- * @brief Set the projection mode.
+ * @brief Sets the projection mode.
*
* @SINCE_1_0.0
* @param[in] mode One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
void SetProjectionMode( Dali::Camera::ProjectionMode mode );
/**
- * @brief Get the projection mode.
+ * @brief Gets the projection mode.
*
* @SINCE_1_0.0
* @return One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION
Dali::Camera::ProjectionMode GetProjectionMode() const;
/**
- * @brief Set the field of view.
+ * @brief Sets the field of view.
*
* @SINCE_1_0.0
* @param[in] fieldOfView The field of view in radians
void SetFieldOfView( float fieldOfView );
/**
- * @brief Get the field of view in Radians.
+ * @brief Gets the field of view in Radians.
*
* The default field of view is 45 degrees.
* @SINCE_1_0.0
float GetFieldOfView( );
/**
- * @brief Set the aspect ratio.
+ * @brief Sets the aspect ratio.
*
* @SINCE_1_0.0
* @param[in] aspectRatio The aspect ratio
void SetAspectRatio( float aspectRatio );
/**
- * @brief Get the aspect ratio of the camera.
+ * @brief Gets the aspect ratio of the camera.
*
* The default aspect ratio is 4.0f/3.0f.
* @SINCE_1_0.0
void SetNearClippingPlane( float nearClippingPlane );
/**
- * @brief Get the near clipping plane distance.
+ * @brief Gets the near clipping plane distance.
*
* The default near clipping plane is 800.0f, to match the default screen height.
* Reduce this value to see objects closer to the camera.
void SetFarClippingPlane( float farClippingPlane );
/**
- * @brief Get the far clipping plane distance.
+ * @brief Gets the far clipping plane distance.
*
* The default value is the default near clipping plane + (0xFFFF>>4).
* @SINCE_1_0.0
float GetFarClippingPlane( );
/**
- * @brief Set the target position of the camera.
+ * @brief Sets the target position of the camera.
*
* @SINCE_1_0.0
* @param[in] targetPosition The position of the target to look at
void SetTargetPosition( const Vector3& targetPosition );
/**
- * @brief Get Camera Target position.
+ * @brief Gets the Camera Target position.
*
* The default target position is Vector3::ZERO.
* @SINCE_1_0.0
Vector3 GetTargetPosition() const;
/**
- * @brief Request for an inversion on the Y axis on the projection calculation.
+ * @brief Requests for an inversion on the Y axis on the projection calculation.
*
* The default value is not inverted.
* @SINCE_1_0.0
void SetInvertYAxis(bool invertYAxis);
/**
- * @brief Get whether the Y axis is inverted.
+ * @brief Gets whether the Y axis is inverted.
*
* @SINCE_1_0.0
- * @return True if the Y axis is inverted, false otherwise
+ * @return @c True if the Y axis is inverted, @c false otherwise
*/
bool GetInvertYAxis();
/**
* @brief Sets the default camera perspective projection for the given canvas size.
*
- * Sets the near and far clipping planes, the field of view, the aspect ratio
+ * Sets the near and far clipping planes, the field of view, the aspect ratio,
* and the Z position of the actor based on the canvas size so that 1 unit in
* XY (z=0) plane is 1 pixel on screen.
*
* projection for the stage's size.
*
* @SINCE_1_0.0
- * @param[in] size The canvas size.
+ * @param[in] size The canvas size
* @pre If size is non ZERO, \e width and \e height must be greater than zero.
*
*/
* @brief This constructor is used by CameraActor::New() methods.
*
* @SINCE_1_0.0
- * @param [in] actor A pointer to a newly allocated Dali resource
+ * @param[in] actor A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL CameraActor(Internal::CameraActor* actor);
/// @endcond
/**
* @brief Called after the actor has been disconnected from Stage.
*
- * If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
+ * If an actor is disconnected, it either has no parent or is parented to a disconnected actor.
*
* @SINCE_1_0.0
* @note When the parent of a set of actors is disconnected to the stage, then all of the children
virtual void OnChildAdd(Actor& child) = 0;
/**
- * @brief Called after the owning actor has attempted to remove a child( regardless of whether it succeeded or not ).
+ * @brief Called after the owning actor has attempted to remove a child (regardless of whether it succeeded or not).
*
* @SINCE_1_0.0
* @param[in] child The child being removed
* @brief Called when the owning actor's size is set e.g. using Actor::SetSize().
*
* @SINCE_1_0.0
- * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize.
+ * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize
*/
virtual void OnSizeSet(const Vector3& targetSize) = 0;
* @brief Called when the owning actor's size is animated e.g. using Animation::AnimateTo( Property( actor, Actor::Property::SIZE ), ... ).
*
* @SINCE_1_0.0
- * @param[in] animation The object which is animating the owning actor.
- * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize.
+ * @param[in] animation The object which is animating the owning actor
+ * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetTargetSize
*/
virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
*
* @SINCE_1_0.0
* @param[in] event The touch event
- * @return True if the event should be consumed.
+ * @return True if the event should be consumed
* @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
*/
virtual bool OnTouchEvent(const TouchEvent& event) DALI_DEPRECATED_API = 0;
*
* @SINCE_1_0.0
* @param[in] event The hover event
- * @return True if the event should be consumed.
+ * @return True if the event should be consumed
* @note CustomActorImpl::REQUIRES_HOVER_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
*/
virtual bool OnHoverEvent(const HoverEvent& event) = 0;
* @brief Called after a key-event is received by the actor that has had its focus set.
*
* @SINCE_1_0.0
- * @param[in] event the Key Event
- * @return True if the event should be consumed.
+ * @param[in] event The Key Event
+ * @return True if the event should be consumed
*/
virtual bool OnKeyEvent(const KeyEvent& event) = 0;
*
* @SINCE_1_0.0
* @param[in] event The wheel event
- * @return True if the event should be consumed.
+ * @return True if the event should be consumed
* @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
*/
virtual bool OnWheelEvent(const WheelEvent& event) = 0;
* actors, resize or after changing specific properties.
*
* @SINCE_1_0.0
- * @param[in] size The allocated size.
+ * @param[in] size The allocated size
* @param[in,out] container The control should add actors to this container that it is not able
- * to allocate a size for.
+ * to allocate a size for
* @note As this function is called from inside the size negotiation algorithm, you cannot
* call RequestRelayout (the call would just be ignored).
*/
virtual void OnRelayout( const Vector2& size, RelayoutContainer& container ) = 0;
/**
- * @brief Notification for deriving classes
+ * @brief Notification for deriving classes.
*
* @SINCE_1_0.0
* @param[in] policy The policy being set
virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
/**
- * @brief Return the natural size of the actor.
+ * @brief Returns the natural size of the actor.
*
* @SINCE_1_0.0
* @return The actor's natural size
virtual Vector3 GetNaturalSize() = 0;
/**
- * @brief Calculate the size for a child.
+ * @brief Calculates the size for a child.
*
* @SINCE_1_0.0
* @param[in] child The child actor to calculate the size for
- * @param[in] dimension The dimension to calculate the size for. E.g. width or height.
- * @return Return the calculated size for the given dimension.
+ * @param[in] dimension The dimension to calculate the size for. E.g. width or height
+ * @return Return the calculated size for the given dimension
*/
virtual float CalculateChildSize( const Dali::Actor& child, Dimension::Type dimension ) = 0;
* Derived classes should override this if they wish to customize the height returned.
*
* @SINCE_1_0.0
- * @param[in] width Width to use.
- * @return The height based on the width.
+ * @param[in] width Width to use
+ * @return The height based on the width
*/
virtual float GetHeightForWidth( float width ) = 0;
* Derived classes should override this if they wish to customize the width returned.
*
* @SINCE_1_0.0
- * @param[in] height Height to use.
- * @return The width based on the width.
+ * @param[in] height Height to use
+ * @return The width based on the width
*/
virtual float GetWidthForHeight( float height ) = 0;
/**
- * @brief Determine if this actor is dependent on it's children for relayout.
+ * @brief Determines if this actor is dependent on its children for relayout.
*
* @SINCE_1_0.0
* @param[in] dimension The dimension(s) to check for
- * @return Return if the actor is dependent on it's children.
+ * @return Return if the actor is dependent on it's children
*/
virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS ) = 0;
/**
* @brief Virtual method to notify deriving classes that relayout dependencies have been
- * met and the size for this object is about to be calculated for the given dimension
+ * met and the size for this object is about to be calculated for the given dimension.
*
* @SINCE_1_0.0
* @param[in] dimension The dimension that is about to be calculated
/**
* @brief Virtual method to notify deriving classes that the size for a dimension
- * has just been negotiated
+ * has just been negotiated.
*
* @SINCE_1_0.0
* @param[in] size The new size for the given dimension
virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
/**
- * @brief Retrieve the extension for this control.
+ * @brief Retrieves the extension for this control.
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
protected: // For derived classes
/**
- * @brief Flags for the constructor
+ * @brief Enumeration for the constructor flags.
* @SINCE_1_0.0
*/
enum ActorFlags
static const int ACTOR_FLAG_COUNT = Log< LAST_ACTOR_FLAG - 1 >::value + 1; ///< Value for deriving classes to continue on the flag enum
/**
- * @brief Create a CustomActorImpl.
+ * @brief Creates a CustomActorImpl.
* @SINCE_1_0.0
* @param[in] flags Bitfield of ActorFlags to define behaviour
*/
// Size negotiation helpers
/**
- * @brief Request a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
+ * @brief Requests a relayout, which means performing a size negotiation on this actor, its parent and children (and potentially whole scene).
*
* This method can also be called from a derived class every time it needs a different size.
* At the end of event processing, the relayout process starts and
/**
* @brief Provides the Actor implementation of GetHeightForWidth.
* @SINCE_1_0.0
- * @param[in] width Width to use.
- * @return The height based on the width.
+ * @param[in] width Width to use
+ * @return The height based on the width
*/
float GetHeightForWidthBase( float width );
/**
* @brief Provides the Actor implementation of GetWidthForHeight.
* @SINCE_1_0.0
- * @param[in] height Height to use.
- * @return The width based on the height.
+ * @param[in] height Height to use
+ * @return The width based on the height
*/
float GetWidthForHeightBase( float height );
/**
- * @brief Calculate the size for a child using the base actor object.
+ * @brief Calculates the size for a child using the base actor object.
*
* @SINCE_1_0.0
* @param[in] child The child actor to calculate the size for
* @param[in] dimension The dimension to calculate the size for. E.g. width or height
- * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found.
+ * @return Return the calculated size for the given dimension. If more than one dimension is requested, just return the first one found
*/
float CalculateChildSizeBase( const Dali::Actor& child, Dimension::Type dimension );
/**
- * @brief Determine if this actor is dependent on it's children for relayout from the base class.
+ * @brief Determines if this actor is dependent on its children for relayout from the base class.
*
* @SINCE_1_0.0
* @param[in] dimension The dimension(s) to check for
- * @return Return if the actor is dependent on it's children.
+ * @return Return if the actor is dependent on it's children
*/
bool RelayoutDependentOnChildrenBase( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
public: // Not intended for application developers
/**
- * @brief Initialize a CustomActor.
+ * @brief Initializes a CustomActor.
* @SINCE_1_0.0
* @param[in] owner The owning object
* @pre The CustomActorImpl is not already owned.
void Initialize(Internal::CustomActor& owner);
/**
- * @brief Get the owner.
+ * @brief Gets the owner.
*
* This method is needed when creating additional handle objects to existing objects.
* Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
/**
* @brief Returns whether the OnTouchEvent() callback is required.
* @SINCE_1_0.0
- * @return True if the OnTouchEvent() callback is required.
+ * @return True if the OnTouchEvent() callback is required
* @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool RequiresTouchEvents() const;
/**
* @brief Returns whether the OnHoverEvent() callback is required.
* @SINCE_1_0.0
- * @return True if the OnHoverEvent() callback is required.
+ * @return True if the OnHoverEvent() callback is required
* @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool RequiresHoverEvents() const;
/**
* @brief Returns whether the OnWheelEvent() callback is required.
* @SINCE_1_0.0
- * @return True if the OnWheelEvent() callback is required.
+ * @return True if the OnWheelEvent() callback is required
* @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool RequiresWheelEvents() const;
/**
* @brief Returns whether relayout is enabled.
* @SINCE_1_0.0
- * @return Return true if relayout is enabled on the custom actor.
+ * @return Return true if relayout is enabled on the custom actor
* @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool IsRelayoutEnabled() const;
public:
/**
- * @brief Create an uninitialized CustomActor handle.
+ * @brief Creates an uninitialized CustomActor handle.
*
* Only derived versions can be instantiated.
* Calling member functions with an uninitialized CustomActor handle is not allowed.
CustomActor();
/**
- * @brief Downcast a handle to CustomActor handle.
+ * @brief Downcasts a handle to CustomActor handle.
*
- * If handle points to a CustomActor the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If the handle points to a CustomActor, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
static CustomActor DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~CustomActor();
/**
- * @brief Retrieve the custom actor implementation.
+ * @brief Retrieves the custom actor implementation.
*
* @SINCE_1_0.0
* @return The implementation
CustomActorImpl& GetImplementation();
/**
- * @brief Retrieve the custom actor implementation.
+ * @brief Retrieves the custom actor implementation.
*
* @SINCE_1_0.0
* @return The implementation
const CustomActorImpl& GetImplementation() const;
/**
- * @brief Create an initialised CustomActor.
+ * @brief Creates an initialized CustomActor.
*
* @SINCE_1_0.0
* @param[in] implementation The implementation for this custom actor
CustomActor(CustomActorImpl& implementation);
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] copy The actor to copy
+ * @param[in] copy The actor to copy
*/
CustomActor(const CustomActor& copy);
/**
- * @brief Assignment operator
+ * @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] rhs The actor to copy
+ * @param[in] rhs The actor to copy
* @return A reference to this
*/
CustomActor& operator=(const CustomActor& rhs);
* @brief This constructor is used internally to create additional CustomActor handles.
*
* @SINCE_1_0.0
- * @param [in] actor A pointer to a newly allocated Dali resource
+ * @param[in] actor A pointer to a newly allocated Dali resource
*/
CustomActor(Internal::CustomActor* actor);
};
{
/**
- * @brief How the actor and it's children will be drawn.
+ * @brief Enumeration for the instance of how the actor and it's children will be drawn.
*
* @SINCE_1_0.0
* @see Dali::Actor::SetDrawMode()
}
/**
- * @brief Rectangle describing area on screen that a layer can draw to
+ * @brief Rectangle describing area on screen that a layer can draw to.
*
* @SINCE_1_0.0
* @see Dali::Layer::SetClippingBox()
public:
/**
- * @brief An enumeration of properties belonging to the Layer class.
+ * @brief Enumeration for the instance of properties belonging to the Layer class.
*
* Properties additional to Actor.
* @SINCE_1_0.0
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Layer class.
+ * @brief Enumeration for the instance of properties belonging to the Layer class.
*
* Properties additional to Actor.
* @SINCE_1_0.0
{
/**
* @DEPRECATED_1_1.45, use LAYER_UI instead
- * @brief UI control rendering mode
+ * @brief UI control rendering mode.
* @SINCE_1_0.0
* @see LAYER_UI
*/
/**
* @brief Layer will use depth test.
*
- * When using this mode depth test will be used. A depth clear will happen for each layer,
+ * When using this mode, depth test will be used. A depth clear will happen for each layer,
* which means actors in a layer "above" other layers will be rendered in front of actors in
* those layers regardless of their Z positions (see Layer::Raise() and Layer::Lower()).
* Opaque renderers are drawn first and write to the depth buffer.
/**
* @DEPRECATED_1_2.26. Not intended for application use.
*
- * @brief TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
+ * @brief Enumeration for TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
* @SINCE_1_0.0
*/
enum TreeDepthMultiplier
};
/**
- * @brief The sort function type
+ * @brief The sort function type.
*
* @SINCE_1_0.0
- * @param[in] position This is the actor translation from camera.
+ * @param[in] position This is the actor translation from camera
*/
typedef float (*SortFunctionType)( const Vector3& position );
/**
- * @brief Create an empty Layer handle.
+ * @brief Creates an empty Layer handle.
*
- * This can be initialised with Layer::New(...).
+ * This can be initialized with Layer::New(...).
* @SINCE_1_0.0
*/
Layer();
/**
- * @brief Create a Layer object.
+ * @brief Creates a Layer object.
*
* @SINCE_1_0.0
* @return A handle to a newly allocated Layer
static Layer New();
/**
- * @brief Downcast a handle to Layer handle.
+ * @brief Downcasts a handle to Layer handle.
*
- * If handle points to a Layer the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If handle points to a Layer, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle Handle to An object
+ * @param[in] handle Handle to an object
* @return Handle to a Layer or an uninitialized handle
*/
static Layer DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
~Layer();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] copy The actor to copy
+ * @param[in] copy The actor to copy
*/
Layer(const Layer& copy);
/**
- * @brief Assignment operator
+ * @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] rhs The actor to copy
+ * @param[in] rhs The actor to copy
* @return A reference to this
*/
Layer& operator=(const Layer& rhs);
/**
- * @brief Query the depth of the layer
+ * @brief Queries the depth of the layer.
*
- * 0 is bottom most layer, higher number is on top.
+ * 0 is the bottom most layer, higher number is on top.
* @SINCE_1_0.0
* @return The current depth of the layer
* @pre Layer is on the stage.
unsigned int GetDepth() const;
/**
- * @brief Increment the depth of the layer.
+ * @brief Increments the depth of the layer.
*
* @SINCE_1_0.0
* @pre Layer is on the stage.
void Raise();
/**
- * @brief Decrement the depth of the layer.
+ * @brief Decrements the depth of the layer.
*
* @SINCE_1_0.0
* @pre Layer is on the stage.
/**
* @brief Ensures the layers depth is greater than the target layer.
*
- * If the layer already is above the target layer its depth is not changed.
+ * If the layer already is above the target layer, its depth is not changed.
* If the layer was below target, its new depth will be immediately above target.
* @SINCE_1_0.0
* @param target Layer to get above of
/**
* @brief Ensures the layers depth is less than the target layer.
*
- * If the layer already is below the target layer its depth is not changed.
+ * If the layer already is below the target layer, its depth is not changed.
* If the layer was above target, its new depth will be immediately below target.
* @SINCE_1_0.0
* @param target Layer to get below of
/**
* @brief Moves the layer directly above the given layer.
*
- * After the call this layers depth will be immediately above target.
+ * After the call, this layers depth will be immediately above target.
* @SINCE_1_0.0
* @param target Layer to get on top of
* @pre Layer is on the stage.
/**
* @brief Moves the layer directly below the given layer.
*
- * After the call this layers depth will be immediately below target.
+ * After the call, this layers depth will be immediately below target.
* @SINCE_1_0.0
* @param target Layer to get below of
* @pre Layer is on the stage.
void MoveBelow( Layer target );
/**
- * @brief Set the behavior of the layer.
+ * @brief Sets the behavior of the layer.
*
* @SINCE_1_0.0
* @param[in] behavior The desired behavior
void SetBehavior( Behavior behavior );
/**
- * @brief Get the behavior of the layer.
+ * @brief Gets the behavior of the layer.
*
* @SINCE_1_0.0
* @return The behavior of the layer
*
* Clipping is initially disabled; see also SetClippingBox().
* @SINCE_1_0.0
- * @param [in] enabled True if clipping is enabled.
+ * @param[in] enabled True if clipping is enabled
*
- * @note When clipping is enabled, the default clipping box is empty (0,0,0,0) which means everything is clipped.
+ * @note When clipping is enabled, the default clipping box is empty (0,0,0,0), which means everything is clipped.
*/
void SetClipping(bool enabled);
/**
- * @brief Query whether clipping is enabled for a layer.
+ * @brief Queries whether clipping is enabled for a layer.
* @SINCE_1_0.0
- * @return True if clipping is enabled.
+ * @return True if clipping is enabled
*/
bool IsClipping() const;
* enabled. The default clipping box is empty (0,0,0,0) which means everything is clipped.
* You can only do rectangular clipping using this API in window coordinates.
* @SINCE_1_0.0
- * @param [in] x The X-coordinate of the top-left corner of the box
- * @param [in] y The Y-coordinate of the top-left corner of the box
- * @param [in] width The width of the box
- * @param [in] height The height of the box
+ * @param[in] x The X-coordinate of the top-left corner of the box
+ * @param[in] y The Y-coordinate of the top-left corner of the box
+ * @param[in] width The width of the box
+ * @param[in] height The height of the box
*/
void SetClippingBox(int x, int y, int width, int height);
/**
- * @brief Sets the clipping box of a layer, in window coordinates.
+ * @brief Sets the clipping box of a layer in window coordinates.
*
- * The contents of the layer will not be visible outside this box, when clipping is
+ * The contents of the layer will not be visible outside this box when clipping is
* enabled. The default clipping box is empty (0,0,0,0).
* @SINCE_1_0.0
- * @param [in] box The clipping box
+ * @param[in] box The clipping box
*/
void SetClippingBox(ClippingBox box);
/**
- * @brief Retrieves the clipping box of a layer, in window coordinates.
+ * @brief Retrieves the clipping box of a layer in window coordinates.
*
* @SINCE_1_0.0
* @return The clipping box
* However, it's possible to disable the depth test by calling this method.
*
* @SINCE_1_0.0
- * @param[in] disable \e True disables depth test. \e false sets the default behavior.
+ * @param[in] disable \e True disables depth test. \e false sets the default behavior
*/
void SetDepthTestDisabled( bool disable );
* @brief Retrieves whether depth test is disabled.
*
* @SINCE_1_0.0
- * @return \e True if depth test is disabled.
+ * @return \e True if depth test is disabled
*/
bool IsDepthTestDisabled() const;
* @endcode
*
* @SINCE_1_0.0
- * @param[in] function The sort function pointer
+ * @param[in] function The sort function pointer
* @note If the sort function returns a low number, the actor with the data will be
* drawn in front of an actor whose data yields a high value from the sort function.
*
- * @note All child layers use the same sort function. If a child layer is added to this
- * layer then the sort function used by the child layer will also be the same.
+ * @note All child layers use the same sort function. If a child layer is added to this
+ * layer, then the sort function used by the child layer will also be the same.
*
*/
void SetSortFunction( SortFunctionType function );
* If set, any layers behind this layer will not be hit-test.
*
* @SINCE_1_0.0
- * @param[in] consume Whether the layer should consume touch (including gestures).
+ * @param[in] consume Whether the layer should consume touch (including gestures)
*/
void SetTouchConsumed( bool consume );
* @brief Retrieves whether the layer consumes touch (including gestures).
*
* @SINCE_1_0.0
- * @return True if consuming touch, false otherwise.
+ * @return @c True if consuming touch, @c false otherwise
*/
bool IsTouchConsumed() const;
* If set, any layers behind this layer will not be hit-test.
*
* @SINCE_1_0.0
- * @param[in] consume Whether the layer should consume hover.
+ * @param[in] consume Whether the layer should consume hover
*/
void SetHoverConsumed( bool consume );
* @brief Retrieves whether the layer consumes hover.
*
* @SINCE_1_0.0
- * @return True if consuming hover, false otherwise.
+ * @return @c True if consuming hover, @c false otherwise
*/
bool IsHoverConsumed() const;
* @brief This constructor is used by Layer::New() methods.
*
* @SINCE_1_0.0
- * @param [in] Layer A pointer to a newly allocated Dali resource
+ * @param[in] Layer A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL Layer(Internal::Layer* Layer);
/// @endcond
namespace FilterMode
{
/**
- * @brief Texture filtering mode.
+ * @brief Enumeration for texture filtering mode.
* @SINCE_1_0.0
*/
enum Type
{
/**
- * @brief Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR)
+ * @brief Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR).
* @SINCE_1_0.0
*/
NONE = 0,
/**
- * @brief Use Dali defaults (minification LINEAR, magnification LINEAR)
- * @SINCE_1_0.0
+ * @brief Use Dali defaults (minification LINEAR, magnification LINEAR).
+ * @SINCE_1_0.0
*/
DEFAULT,
/**
- * @brief Filter nearest
+ * @brief Filter nearest.
* @SINCE_1_0.0
*/
NEAREST,
/**
- * @brief Filter linear
+ * @brief Filter linear.
* @SINCE_1_0.0
*/
LINEAR,
public:
/**
- * @brief Built-in alpha functions
+ * @brief Enumeration for built-in alpha functions.
* @SINCE_1_0.0
*/
enum BuiltinFunction
};
/**
- * @brief All possible functioning modes for the alpha function
+ * @brief Enumeration for all possible functioning modes for the alpha function.
* @SINCE_1_0.0
*/
enum Mode
/**
* @brief Default constructor.
- * Creates an alpha function object with the default built-in alpha function
+ * Creates an alpha function object with the default built-in alpha function.
* @SINCE_1_0.0
* @return The alpha function
*/
/**
* @brief Constructor.
* Creates an alpha function object with the built-in alpha function passed as a parameter
- * to the constructor
+ * to the constructor.
* @SINCE_1_0.0
* @param[in] function One of the built-in alpha functions
* @return The alpha function
/**
* @brief Constructor.
- * Creates an alpha function object using a pointer to an alpha function passed as a paramter
- * to the constructor
+ * Creates an alpha function object using a pointer to an alpha function passed as a parameter
+ * to the constructor.
* @SINCE_1_0.0
* @param[in] function A pointer to an alpha function
* @return The alpha function
AlphaFunction( const Dali::Vector2& controlPoint0, const Dali::Vector2& controlPoint1 );
/**
- * @brief Return the control points of the alpha function
+ * @brief Returns the control points of the alpha function.
* @SINCE_1_0.0
- * @return Vector4 containing the two control points of the curve.
+ * @return Vector4 containing the two control points of the curve
* (xy for the first point and zw for the second)
*/
Vector4 GetBezierControlPoints() const;
/**
- * @brief Returns the pointer to the custom function
+ * @brief Returns the pointer to the custom function.
* @SINCE_1_0.0
- * @return A pointer to a custom alpha function or 0 if not defined
+ * @return A pointer to a custom alpha function, or @c 0 if not defined
*/
AlphaFunctionPrototype GetCustomFunction() const;
/**
- * @brief Returns the built-in function used by the alpha function
+ * @brief Returns the built-in function used by the alpha function.
* @SINCE_1_0.0
* @return One of the built-in alpha functions. In case no built-in function
* has been specified, it will return AlphaFunction::DEFAULT
typedef Any AnyFunction; ///< Interpolation function @SINCE_1_0.0
/**
- * @brief What to do when the animation ends, is stopped or is destroyed
+ * @brief Enumeration for what to do when the animation ends, is stopped, or is destroyed.
* @SINCE_1_0.0
*/
enum EndAction
};
/**
- * @brief What interpolation method to use on key-frame animations
+ * @brief Enumeration for what interpolation method to use on key-frame animations.
* @SINCE_1_0.0
*/
enum Interpolation
};
/**
- * @brief What state the animation is in
+ * @brief Enumeration for what state the animation is in.
*
* Note: Calling Reset() on this class will NOT reset the animation. It will call BaseHandle::Reset() which drops the object handle.
*
};
/**
- * @brief Create an uninitialized Animation; this can be initialized with Animation::New().
+ * @brief Creates an uninitialized Animation; this can be initialized with Animation::New().
*
* Calling member functions with an uninitialized Animation handle is not allowed.
* @SINCE_1_0.0
Animation();
/**
- * @brief Create an initialized Animation.
+ * @brief Creates an initialized Animation.
*
* The animation will not loop.
* The default end action is "Bake".
* The default alpha function is linear.
* @SINCE_1_0.0
- * @param [in] durationSeconds The duration in seconds.
- * @return A handle to a newly allocated Dali resource.
+ * @param[in] durationSeconds The duration in seconds
+ * @return A handle to a newly allocated Dali resource
* @note durationSeconds can not be negative.
*/
static Animation New(float durationSeconds);
/**
- * @brief Downcast a handle to Animation handle.
+ * @brief Downcasts a handle to Animation handle.
*
- * If handle points to an Animation object the downcast produces
- * valid handle. If not the returned handle is left uninitialized.
+ * If handle points to an Animation object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
- * @return Handle to a Animation object or an uninitialized handle
+ * @return Handle to an Animation object or an uninitialized handle
*/
static Animation DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
Animation(const Animation& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Animation& operator=(const Animation& rhs);
/**
- * @brief Set the duration of an animation.
+ * @brief Sets the duration of an animation.
*
* @SINCE_1_0.0
- * @param[in] seconds The duration in seconds.
+ * @param[in] seconds The duration in seconds
* @pre DurationSeconds must be greater than zero.
*/
void SetDuration(float seconds);
/**
- * @brief Retrieve the duration of an animation.
+ * @brief Retrieves the duration of an animation.
*
* @SINCE_1_0.0
- * @return The duration in seconds.
+ * @return The duration in seconds
*/
float GetDuration() const;
/**
- * @brief Set whether the animation will loop.
+ * @brief Sets whether the animation will loop.
*
* This function resets the loop count and should not be used with SetLoopCount(int).
- * Setting this parameter does not cause the animation to Play()
+ * Setting this parameter does not cause the animation to Play().
*
* @SINCE_1_0.0
- * @param[in] looping True if the animation will loop.
+ * @param[in] looping True if the animation will loop
*/
void SetLooping(bool looping);
/**
- * @brief Enable looping for 'count' repeats.
+ * @brief Enables looping for 'count' repeats.
*
- * A zero is the same as SetLooping(true) ie repeat forever.
+ * A zero is the same as SetLooping(true) i.e. repeat forever.
* If Play() Stop() or 'count' loops is reached, the loop counter will reset.
- * Setting this parameter does not cause the animation to Play()
+ * Setting this parameter does not cause the animation to Play().
*
* @SINCE_1_1.20
- * @param[in] count The number of times to loop.
+ * @param[in] count The number of times to loop
*/
void SetLoopCount(int count);
/**
- * @brief Get the loop count.
+ * @brief Gets the loop count.
*
* A zero is the same as SetLooping(true) ie repeat forever.
* The loop count is initially 1 for play once.
*
* @SINCE_1_1.20
- * @return The number of times to loop.
+ * @return The number of times to loop
*/
int GetLoopCount();
/**
- * @brief Get the current loop count.
+ * @brief Gets the current loop count.
*
* A value 0 to GetLoopCount() indicating the current loop count when looping.
*
* @SINCE_1_1.20
- * @return The current number of loops that have occured.
+ * @return The current number of loops that have occured
*/
int GetCurrentLoop();
/**
- * @brief Query whether the animation will loop.
+ * @brief Queries whether the animation will loop.
*
* @SINCE_1_0.0
- * @return True if the animation will loop.
+ * @return True if the animation will loop
*/
bool IsLooping() const;
/**
- * @brief Set the end action of the animation.
+ * @brief Sets the end action of the animation.
*
* This action is performed when the animation ends or if it is stopped.
- * Default end action is bake
+ * Default end action is bake.
* @SINCE_1_0.0
- * @param[in] action The end action.
+ * @param[in] action The end action
*/
void SetEndAction(EndAction action);
* @brief Returns the end action of the animation.
*
* @SINCE_1_0.0
- * @return The end action.
+ * @return The end action
*/
EndAction GetEndAction() const;
/**
- * @brief Set the disconnect action.
+ * @brief Sets the disconnect action.
*
* If any of the animated property owners are disconnected from the stage while the animation is being played, then this action is performed.
* Default action is to BakeFinal.
* @SINCE_1_0.0
- * @param[in] disconnectAction The disconnect action.
+ * @param[in] disconnectAction The disconnect action
*/
void SetDisconnectAction( EndAction disconnectAction );
* @brief Returns the disconnect action.
*
* @SINCE_1_0.0
- * @return The disconnect action.
+ * @return The disconnect action
*/
EndAction GetDisconnectAction() const;
/**
- * @brief Set the default alpha function for an animation.
+ * @brief Sets the default alpha function for an animation.
*
* This is applied to individual property animations, if no further alpha functions are supplied.
* @SINCE_1_0.0
- * @param[in] alpha The default alpha function.
+ * @param[in] alpha The default alpha function
*/
void SetDefaultAlphaFunction(AlphaFunction alpha);
/**
- * @brief Retrieve the default alpha function for an animation.
+ * @brief Retrieves the default alpha function for an animation.
*
* @SINCE_1_0.0
- * @return The default alpha function.
+ * @return The default alpha function
*/
AlphaFunction GetDefaultAlphaFunction() const;
*
* @SINCE_1_0.0
* @param[in] progress The new progress as a normalized value between [0,1]
- * or between the play range if specified.
+ * or between the play range if specified
*/
void SetCurrentProgress( float progress );
/**
- * @brief Retrieve the current progress of the animation.
+ * @brief Retrieves the current progress of the animation.
*
* @SINCE_1_0.0
- * @return The current progress as a normalized value between [0,1].
+ * @return The current progress as a normalized value between [0,1]
*/
float GetCurrentProgress();
/**
- * @brief Specifies an speed factor for the animation.
+ * @brief Specifies a speed factor for the animation.
*
* The speed factor is a multiplier of the normal velocity of the animation. Values between [0,1] will
* slow down the animation and values above one will speed up the animation. It is also possible to specify a negative multiplier
* to play the animation in reverse.
*
* @SINCE_1_0.0
- * @param[in] factor A value which will multiply the velocity.
+ * @param[in] factor A value which will multiply the velocity
*/
void SetSpeedFactor( float factor );
/**
- * @brief Retrieve the speed factor of the animation
+ * @brief Retrieves the speed factor of the animation.
*
* @SINCE_1_0.0
* @return Speed factor
float GetSpeedFactor() const;
/**
- * @brief Set the playing range.
+ * @brief Sets the playing range.
*
* Animation will play between the values specified. Both values ( range.x and range.y ) should be between 0-1,
* otherwise they will be ignored. If the range provided is not in proper order ( minimum,maximum ), it will be reordered.
*
* @SINCE_1_0.0
* @param[in] range Two values between [0,1] to specify minimum and maximum progress. The
- * animation will play between those values.
+ * animation will play between those values
*/
void SetPlayRange( const Vector2& range );
/**
- * @brief Get the playing range
+ * @brief Gets the playing range.
*
* @SINCE_1_0.0
- * @return The play range defined for the animation.
+ * @return The play range defined for the animation
*/
Vector2 GetPlayRange() const;
void Play();
/**
- * @brief Play the animation from a given point.
+ * @brief Plays the animation from a given point.
*
* The progress must be in the 0-1 interval or in the play range interval if defined ( See @ref Animation::SetPlayRange ),
* otherwise, it will be ignored.
*
* @SINCE_1_0.0
- * @param[in] progress A value between [0,1], or between the play range if specified, form where the animation should start playing
+ * @param[in] progress A value between [0,1], or between the play range if specified, from where the animation should start playing
*/
void PlayFrom( float progress );
/**
- * @brief Pause the animation.
+ * @brief Pauses the animation.
* @SINCE_1_0.0
*/
void Pause();
/**
- * @brief Query the state of the animation.
+ * @brief Queries the state of the animation.
* @SINCE_1_1.21
* @return The Animation::State
*/
State GetState() const;
/**
- * @brief Stop the animation.
+ * @brief Stops the animation.
* @SINCE_1_0.0
*/
void Stop();
/**
- * @brief Clear the animation.
+ * @brief Clears the animation.
*
* This disconnects any objects that were being animated, effectively stopping the animation.
* @SINCE_1_0.0
void Clear();
/**
- * @brief Connect to this signal to be notified when an Animation's animations have finished.
+ * @brief Connects to this signal to be notified when an Animation's animations have finished.
*
* @SINCE_1_0.0
- * @return A signal object to connect with.
+ * @return A signal object to connect with
*/
AnimationSignalType& FinishedSignal();
/**
- * @brief Animate a property value by a relative amount.
+ * @brief Animates a property value by a relative amount.
*
* The default alpha function will be used.
* The effect will start & end when the animation begins & ends.
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] relativeValue The property value will change by this amount.
+ * @param[in] target The target object/property to animate
+ * @param[in] relativeValue The property value will change by this amount
*/
void AnimateBy(Property target, Property::Value relativeValue);
/**
- * @brief Animate a property value by a relative amount.
+ * @brief Animates a property value by a relative amount.
*
* The effect will start & end when the animation begins & ends.
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] relativeValue The property value will change by this amount.
- * @param [in] alpha The alpha function to apply.
+ * @param[in] target The target object/property to animate
+ * @param[in] relativeValue The property value will change by this amount
+ * @param[in] alpha The alpha function to apply
*/
void AnimateBy(Property target, Property::Value relativeValue, AlphaFunction alpha);
/**
- * @brief Animate a property value by a relative amount.
+ * @brief Animates a property value by a relative amount.
*
* The default alpha function will be used.
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] relativeValue The property value will increase/decrease by this amount.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] target The target object/property to animate
+ * @param[in] relativeValue The property value will increase/decrease by this amount
+ * @param[in] period The effect will occur during this time period
*/
void AnimateBy(Property target, Property::Value relativeValue, TimePeriod period);
/**
- * @brief Animate a property value by a relative amount.
+ * @brief Animates a property value by a relative amount.
*
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] relativeValue The property value will increase/decrease by this amount.
- * @param [in] alpha The alpha function to apply.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] target The target object/property to animate
+ * @param[in] relativeValue The property value will increase/decrease by this amount
+ * @param[in] alpha The alpha function to apply
+ * @param[in] period The effect will occur during this time period
*/
void AnimateBy(Property target, Property::Value relativeValue, AlphaFunction alpha, TimePeriod period);
/**
- * @brief Animate a property to a destination value.
+ * @brief Animates a property to a destination value.
*
* The default alpha function will be used.
* The effect will start & end when the animation begins & ends.
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] destinationValue The destination value.
+ * @param[in] target The target object/property to animate
+ * @param[in] destinationValue The destination value
*/
void AnimateTo(Property target, Property::Value destinationValue);
/**
- * @brief Animate a property to a destination value.
+ * @brief Animates a property to a destination value.
*
* The effect will start & end when the animation begins & ends.
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] destinationValue The destination value.
- * @param [in] alpha The alpha function to apply.
+ * @param[in] target The target object/property to animate
+ * @param[in] destinationValue The destination value
+ * @param[in] alpha The alpha function to apply
*/
void AnimateTo(Property target, Property::Value destinationValue, AlphaFunction alpha);
/**
- * @brief Animate a property to a destination value.
+ * @brief Animates a property to a destination value.
*
* The default alpha function will be used.
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] destinationValue The destination value.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] target The target object/property to animate
+ * @param[in] destinationValue The destination value
+ * @param[in] period The effect will occur during this time period
*/
void AnimateTo(Property target, Property::Value destinationValue, TimePeriod period);
/**
- * @brief Animate a property to a destination value.
+ * @brief Animates a property to a destination value.
*
* @SINCE_1_0.0
- * @param [in] target The target object/property to animate.
- * @param [in] destinationValue The destination value.
- * @param [in] alpha The alpha function to apply.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] target The target object/property to animate
+ * @param[in] destinationValue The destination value
+ * @param[in] alpha The alpha function to apply
+ * @param[in] period The effect will occur during this time period
*/
void AnimateTo(Property target, Property::Value destinationValue, AlphaFunction alpha, TimePeriod period);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate.
- * @param [in] keyFrames The set of time/value pairs between which to animate.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
*/
void AnimateBetween(Property target, KeyFrames& keyFrames);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] interpolation The method used to interpolate between values.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] interpolation The method used to interpolate between values
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, Interpolation interpolation);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate.
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] alpha The alpha function to apply.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] alpha The alpha function to apply
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] alpha The alpha function to apply.
- * @param [in] interpolation The method used to interpolate between values.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] alpha The alpha function to apply
+ * @param[in] interpolation The method used to interpolate between values
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha, Interpolation interpolation);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate.
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] period The effect will occur during this time period
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, TimePeriod period);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] period The effect will occur duing this time period.
- * @param [in] interpolation The method used to interpolate between values.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] period The effect will occur duing this time period
+ * @param[in] interpolation The method used to interpolate between values
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, TimePeriod period, Interpolation interpolation);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate.
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] alpha The alpha function to apply.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] alpha The alpha function to apply
+ * @param[in] period The effect will occur during this time period
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha, TimePeriod period);
/**
- * @brief Animate a property between keyframes.
+ * @brief Animates a property between keyframes.
*
* @SINCE_1_0.0
- * @param [in] target The target object property to animate
- * @param [in] keyFrames The set of time/value pairs between which to animate.
- * @param [in] alpha The alpha function to apply to the overall progress.
- * @param [in] period The effect will occur duing this time period.
- * @param [in] interpolation The method used to interpolate between values.
+ * @param[in] target The target object property to animate
+ * @param[in] keyFrames The set of time/value pairs between which to animate
+ * @param[in] alpha The alpha function to apply to the overall progress
+ * @param[in] period The effect will occur duing this time period
+ * @param[in] interpolation The method used to interpolate between values
*/
void AnimateBetween(Property target, KeyFrames& keyFrames, AlphaFunction alpha, TimePeriod period, Interpolation interpolation);
// Actor-specific convenience methods
/**
- * @brief Animate an actor's position and orientation through a predefined path.
+ * @brief Animates an actor's position and orientation through a predefined path.
*
* The actor will rotate to orient the supplied
* forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.
void Animate( Actor actor, Path path, const Vector3& forward );
/**
- * @brief Animate an actor's position and orientation through a predefined path.
+ * @brief Animates an actor's position and orientation through a predefined path.
*
* The actor will rotate to orient the supplied
* forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.
* @param[in] actor The actor to animate
* @param[in] path The path. It defines position and orientation
* @param[in] forward The vector (in local space coordinate system) that will be oriented with the path's tangent direction
- * @param [in] alpha The alpha function to apply.
+ * @param[in] alpha The alpha function to apply
*/
void Animate( Actor actor, Path path, const Vector3& forward, AlphaFunction alpha );
/**
- * @brief Animate an actor's position and orientation through a predefined path.
+ * @brief Animates an actor's position and orientation through a predefined path.
*
* The actor will rotate to orient the supplied
* forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.
* @param[in] actor The actor to animate
* @param[in] path The path. It defines position and orientation
* @param[in] forward The vector (in local space coordinate system) that will be oriented with the path's tangent direction
- * @param [in] period The effect will occur during this time period.
+ * @param[in] period The effect will occur during this time period
*/
void Animate( Actor actor, Path path, const Vector3& forward, TimePeriod period );
/**
- * @brief Animate an actor's position and orientation through a predefined path.
+ * @brief Animates an actor's position and orientation through a predefined path.
*
* The actor will rotate to orient the supplied
* forward vector with the path's tangent. If forward is the zero vector then no rotation will happen.
* @param[in] actor The actor to animate
* @param[in] path The path. It defines position and orientation
* @param[in] forward The vector (in local space coordinate system) that will be oriented with the path's tangent direction
- * @param [in] alpha The alpha function to apply.
- * @param [in] period The effect will occur during this time period.
+ * @param[in] alpha The alpha function to apply
+ * @param[in] period The effect will occur during this time period
*/
void Animate( Actor actor, Path path, const Vector3& forward, AlphaFunction alpha, TimePeriod period);
/**
- * @brief Show an actor during the animation.
+ * @brief Shows an actor during the animation.
*
* @SINCE_1_0.0
- * @param [in] actor The actor to animate.
- * @param [in] delaySeconds The initial delay from the start of the animation.
+ * @param[in] actor The actor to animate
+ * @param[in] delaySeconds The initial delay from the start of the animation
*/
void Show(Actor actor, float delaySeconds);
/**
- * @brief Hide an actor during the animation.
+ * @brief Hides an actor during the animation.
*
* @SINCE_1_0.0
- * @param [in] actor The actor to animate.
- * @param [in] delaySeconds The initial delay from the start of the animation.
+ * @param[in] actor The actor to animate
+ * @param[in] delaySeconds The initial delay from the start of the animation
*/
void Hide(Actor actor, float delaySeconds);
/// @cond internal
/**
- * @brief This constructor is used by Animation::New() methods
+ * @brief This constructor is used by Animation::New() methods.
* @SINCE_1_0.0
- * @param [in] animation A pointer to a newly allocated Dali resource
+ * @param[in] animation A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL Animation(Internal::Animation* animation);
/// @endcond
*/
/**
- * @brief Constraint source types.
+ * @brief Enumeration for constraint source types.
*
* This specifies the location of a property, which is used as an input for a constraint function.
* @SINCE_1_0.0
struct DALI_IMPORT_API LocalSource
{
/**
- * @brief Create a local constraint source.
+ * @brief Creates a local constraint source.
*
* @SINCE_1_0.0
- * @param [in] index The index of a property provided by the constrained object.
+ * @param[in] index The index of a property provided by the constrained object
*/
LocalSource( Property::Index index );
struct DALI_IMPORT_API ParentSource
{
/**
- * @brief Create a parent constraint source.
+ * @brief Creates a parent constraint source.
*
* @SINCE_1_0.0
- * @param [in] index The index of a property, provided by the parent of the constrained object.
+ * @param[in] index The index of a property, provided by the parent of the constrained object
*/
ParentSource( Property::Index index );
struct DALI_IMPORT_API Source
{
/**
- * @brief Create a constraint source.
+ * @brief Creates a constraint source.
*
* @SINCE_1_0.0
- * @param [in] object The object providing the property.
- * @param [in] index The index of a property provided by object.
+ * @param[in] object The object providing the property
+ * @param[in] index The index of a property provided by object
*/
Source( Handle& object, Property::Index index );
struct DALI_IMPORT_API ConstraintSource
{
/**
- * @brief Create a constraint source.
+ * @brief Creates a constraint source.
*
* @SINCE_1_0.0
- * @param [in] source A constraint source from an arbitrary object.
+ * @param[in] source A constraint source from an arbitrary object
*/
ConstraintSource( Source source );
/**
- * @brief Create a constraint source.
+ * @brief Creates a constraint source.
*
* @SINCE_1_0.0
- * @param [in] local A local constraint source.
+ * @param[in] local A local constraint source
*/
ConstraintSource( LocalSource local );
/**
- * @brief Create a constraint source.
+ * @brief Creates a constraint source.
*
* @SINCE_1_0.0
- * @param [in] parent A parent constraint source.
+ * @param[in] parent A parent constraint source
*/
ConstraintSource( ParentSource parent );
* should change this value to the desired one. The PropertyInputContainer is a const reference to the property inputs
* added to the Constraint in the order they were added via AddSource().
*
- * @tparam P The property type to constrain.
* @SINCE_1_0.0
+ * @tparam P The property type to constrain
*/
template< typename P >
class DALI_INTERNAL Function : public CallbackBase
* @endcode
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
+ * @param[in] function The function to call
*/
Function( void( *function )( P&, const PropertyInputContainer& ) )
: CallbackBase( reinterpret_cast< CallbackBase::Function >( function ) ),
* @endcode
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
- *
- * @tparam T The type of the object.
+ * @param[in] object The object to copy
+ * @tparam T The type of the object
*/
template< class T >
Function( const T& object )
* @endcode
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
- * @param[in] memberFunction The member function to call. This has to be a member of the same class.
- *
- * @tparam T The type of the object.
+ * @param[in] object The object to copy
+ * @param[in] memberFunction The member function to call. This has to be a member of the same class
+ * @tparam T The type of the object
*/
template< class T >
Function( const T& object, void ( T::*memberFunction ) ( P&, const PropertyInputContainer& ) )
* The object, if held by this object, is also copied.
*
* @SINCE_1_0.0
- * @return A pointer to a newly-allocation Function.
+ * @return A pointer to a newly-allocated Function
*/
CallbackBase* Clone()
{
class UndefinedClass;
/**
- * @brief Used to call the function to copy the stored object
+ * @brief Used to call the function to copy the stored object.
* @SINCE_1_0.0
*/
typedef UndefinedClass* (*CopyConstructorDispatcher) ( UndefinedClass* object );
/**
* @brief Copies the actual object in Constraint::Function.
*
- * @tparam T The type of the object.
* @SINCE_1_0.0
+ * @tparam T The type of the object
*/
template< class T >
struct ObjectCopyConstructorDispatcher
{
/**
- * @brief Copy the object stored in Constraint::Function.
+ * @brief Copies the object stored in Constraint::Function.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
- *
- * @return Newly allocated clone of the object.
+ * @param[in] object The object to copy
+ * @return Newly allocated clone of the object
*/
static UndefinedClass* Copy( const UndefinedClass* object )
{
};
/**
- * @brief Undefined copy constructor
+ * @brief Undefined copy constructor.
* @SINCE_1_0.0
*/
Function( const Function& );
/**
- * @brief Undefined assignment operator
+ * @brief Undefined assignment operator.
* @SINCE_1_0.0
*/
Function& operator=( const Function& );
*
* @SINCE_1_0.0
* @param[in] object A newly copied object
- * @param[in] memberFunction The member function of the object.
- * @param[in] dispatcher Used to call the actual object.
- * @param[in] destructor Used to delete the owned object.
- * @param[in] copyConstructorDispatcher Used to create a copy of the owned object.
+ * @param[in] memberFunction The member function of the object
+ * @param[in] dispatcher Used to call the actual object
+ * @param[in] destructor Used to delete the owned object
+ * @param[in] copyConstructorDispatcher Used to create a copy of the owned object
*/
Function( void* object,
CallbackBase::MemberFunction memberFunction,
* @brief Constructor used when copying a simple stored function.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
+ * @param[in] function The function to call
*/
Function( CallbackBase::Function function )
: CallbackBase( function ),
};
/**
- * @brief The action that will happen when the constraint is removed.
+ * @brief Enumeration for the action that will happen when the constraint is removed.
*
* The final value may be "baked" i.e. saved permanently.
* Alternatively the constrained value may be discarded when the constraint is removed.
static const RemoveAction DEFAULT_REMOVE_ACTION; ///< Bake
/**
- * @brief Create an uninitialized Constraint; this can be initialized with Constraint::New().
+ * @brief Creates an uninitialized Constraint; this can be initialized with Constraint::New().
*
* Calling member functions with an uninitialized Constraint handle is not allowed.
* @SINCE_1_0.0
Constraint();
/**
- * @brief Create a constraint which targets a property using a function or a static class member.
+ * @brief Creates a constraint which targets a property using a function or a static class member.
*
* The expected signature, for a Vector3 type for example, of the function is:
* @code
* @endcode
*
* @SINCE_1_0.0
- * @param[in] handle The handle to the property-owning object.
- * @param[in] targetIndex The index of the property to constrain.
- * @param[in] function The function to call to set the constrained property value.
- * @return The new constraint.
+ * @param[in] handle The handle to the property-owning object
+ * @param[in] targetIndex The index of the property to constrain
+ * @param[in] function The function to call to set the constrained property value
*
- * @tparam P The type of the property to constrain.
+ * @tparam P The type of the property to constrain
+ * @return The new constraint
*/
template< class P >
static Constraint New( Handle handle, Property::Index targetIndex, void( *function )( P&, const PropertyInputContainer& ) )
}
/**
- * @brief Create a constraint which targets a property using a functor object.
+ * @brief Creates a constraint which targets a property using a functor object.
*
* The expected structure, for a Vector3 type for example, of the functor object is:
* @code
* @endcode
*
* @SINCE_1_0.0
- * @param[in] handle The handle to the property-owning object.
- * @param[in] targetIndex The index of the property to constrain.
- * @param[in] object The functor object whose functor is called to set the constrained property value.
- * @return The new constraint.
+ * @param[in] handle The handle to the property-owning object
+ * @param[in] targetIndex The index of the property to constraint
+ * @param[in] object The functor object whose functor is called to set the constrained property value
*
- * @tparam P The type of the property to constrain.
- * @tparam T The type of the object.
+ * @tparam P The type of the property to constrain
+ * @tparam T The type of the object
+ * @return The new constraint
*/
template< class P, class T >
static Constraint New( Handle handle, Property::Index targetIndex, const T& object )
}
/**
- * @brief Create a constraint which targets a property using an object method.
+ * @brief Creates a constraint which targets a property using an object method.
*
* The expected structure, for a Vector3 type for example, of the object is:
* @code
* @endcode
*
* @SINCE_1_0.0
- * @param[in] handle The handle to the property-owning object.
- * @param[in] targetIndex The index of the property to constrain.
- * @param[in] object The object whose member function is called to set the constrained property value.
- * @param[in] memberFunction The member function to call to set the constrained property value.
- * @return The new constraint.
- *
- * @tparam P The type of the property to constrain.
- * @tparam T The type of the object.
+ * @param[in] handle The handle to the property-owning object
+ * @param[in] targetIndex The index of the property to constraint
+ * @param[in] object The object whose member function is called to set the constrained property value
+ * @param[in] memberFunction The member function to call to set the constrained property value
+ * @return The new constraint
+ *
+ * @tparam P The type of the property to constrain
+ * @tparam T The type of the object
*/
template< class P, class T >
static Constraint New( Handle handle, Property::Index targetIndex, const T& object, void ( T::*memberFunction ) ( P&, const PropertyInputContainer& ) )
}
/**
- * @brief Creates a clones of this constraint for another object.
+ * @brief Creates a clone of this constraint for another object.
*
* @SINCE_1_0.0
- * @param[in] handle The handle to the property-owning object this constraint is to be cloned for.
- *
- * @return The new constraint.
+ * @param[in] handle The handle to the property-owning object this constraint is to be cloned for
+ * @return The new constraint
*/
Constraint Clone( Handle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] constraint A reference to the copied handle
+ * @param[in] constraint A reference to the copied handle
*/
Constraint( const Constraint& constraint );
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Constraint& operator=( const Constraint& rhs );
/**
- * @brief Downcast a handle to Constraint handle.
+ * @brief Downcasts a handle to Constraint handle.
*
- * If handle points to a Constraint object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a Constraint object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] baseHandle BaseHandle to an object
* @return Handle to a Constraint object or an uninitialized handle
static Constraint DownCast( BaseHandle baseHandle );
/**
- * @brief Adds a constraint source to the constraint
+ * @brief Adds a constraint source to the constraint.
*
* @SINCE_1_0.0
* @param[in] source The constraint source input to add
* @brief Applies this constraint.
*
* @SINCE_1_0.0
- * @pre The constraint must be initialized
- * @pre The target object must still be alive
- * @pre The source inputs should not have been destroyed
+ * @pre The constraint must be initialized.
+ * @pre The target object must still be alive.
+ * @pre The source inputs should not have been destroyed.
*/
void Apply();
void Remove();
/**
- * @brief Retrieve the object which this constraint is targeting.
+ * @brief Retrieves the object which this constraint is targeting.
*
* @SINCE_1_0.0
- * @return The target object.
+ * @return The target object
*/
Handle GetTargetObject();
/**
- * @brief Retrieve the property which this constraint is targeting.
+ * @brief Retrieves the property which this constraint is targeting.
*
* @SINCE_1_0.0
- * @return The target property.
+ * @return The target property
*/
Dali::Property::Index GetTargetProperty();
/**
- * @brief Set the remove action. Constraint::Bake will "bake" a value when fully-applied.
+ * @brief Sets the remove action. Constraint::Bake will "bake" a value when fully-applied.
*
* In case of Constraint::Discard, the constrained value will be discarded, when the constraint is removed.
* The default value is Constraint::Bake.
* @SINCE_1_0.0
- * @param[in] action The remove-action.
+ * @param[in] action The remove-action
*/
void SetRemoveAction( RemoveAction action );
/**
- * @brief Retrieve the remove action that will happen when the constraint is removed.
+ * @brief Retrieves the remove action that will happen when the constraint is removed.
*
* @SINCE_1_0.0
- * @return The remove-action.
+ * @return The remove-action
*/
RemoveAction GetRemoveAction() const;
/**
- * @brief Set a tag for the constraint so it can be identified later
+ * @brief Sets a tag for the constraint so it can be identified later.
*
* @SINCE_1_0.0
* @param[in] tag An integer to identify the constraint
void SetTag( const unsigned int tag );
/**
- * @brief Get the tag
+ * @brief Gets the tag.
*
* @SINCE_1_0.0
* @return The tag
/// @cond internal
/**
- * @brief This constructor is used by Constraint::New() methods
+ * @brief This constructor is used by Constraint::New() methods.
* @SINCE_1_0.0
- * @param [in] constraint A pointer to a newly allocated Dali resource
+ * @param[in] constraint A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL Constraint( Internal::ConstraintBase* constraint );
/// @endcond
/// @cond internal
/**
- * @brief Construct a new constraint which targets a property.
+ * @brief Constructs a new constraint which targets a property.
*
* @SINCE_1_0.0
- * @param[in] handle The handle to the property-owning object.
- * @param[in] targetIndex The index of the property to constrain.
- * @param[in] targetType Type The type of the constrained property.
- * @param[in] function The constraint function.
- * @return The new constraint.
+ * @param[in] handle The handle to the property-owning object
+ * @param[in] targetIndex The index of the property to constrain
+ * @param[in] targetType Type The type of the constrained property
+ * @param[in] function The constraint function
+ * @return The new constraint
*/
static Constraint New( Handle handle, Property::Index targetIndex, Property::Type targetType, CallbackBase* function );
/// @endcond
{ }
/**
- * @brief Override functor for float properties
+ * @brief Overrides functor for float properties.
*
* @SINCE_1_0.0
- * @param[in, out] current The current property value, the constrained value is set
+ * @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
*/
void operator()( float& current, const PropertyInputContainer& inputs )
}
/**
- * @brief Override functor for Vector2 properties
+ * @brief Overrides functor for Vector2 properties.
*
* @SINCE_1_0.0
- * @param[in, out] current The current property value, the constrained value is set
+ * @param[in,out] current The current property value, the constrained value is set
* @param[in] inputs Contains the property to copy
*/
void operator()( Vector2& current, const PropertyInputContainer& inputs )
}
/**
- * @brief Override functor for Vector3 properties
+ * @brief Overrides functor for Vector3 properties.
*
* @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
}
/**
- * @brief Override functor for Vector4 properties
+ * @brief Overrides functor for Vector4 properties.
*
* @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
}
/**
- * @brief Override functor for Quaternion properties
+ * @brief Overrides functor for Quaternion properties.
*
* @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
}
/**
- * @brief Override functor for Matrix3 properties
+ * @brief Overrides functor for Matrix3 properties.
*
* @SINCE_1_0.0
* @param[in,out] current The current property value
}
/**
- * @brief Override functor for Matrix properties
+ * @brief Overrides functor for Matrix properties.
*
* @SINCE_1_0.0
* @param[in,out] current The current property value, the constrained value is set
* multiplied by scale parameter (for Vector3 properties).
*
* @e current = <em>input[0]</em> * @e scale. @e current, <em>input[0]</em>, and @e scale
- * indicate the target property, the first constraint source, and the scale parameter, respectively.
+ * indicates the target property, the first constraint source, and the scale parameter, respectively.
* * implies element-wise multiplication.
* @SINCE_1_0.0
*/
/**
* @brief Functor.
* @SINCE_1_0.0
- * @param[in,out] current The current property value (vector3 property * scale factor).
+ * @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 )
* multiplied by scale parameter (for float properties).
*
* @e current = <em>input[0]</em> * @e scale. @e current, <em>input[0]</em>, and @e scale
- * indicate the target property, the first constraint source, and the scale parameter, respectively.
+ * indicates the target property, the first constraint source, and the scale parameter, respectively.
* @SINCE_1_0.0
*/
struct RelativeToConstraintFloat
/**
* @brief Functor.
* @SINCE_1_0.0
- * @param[in,out] current The current property value (float property * scale factor).
+ * @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 )
* @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.
*
* @SINCE_1_0.0
- * @param[in,out] current The current orientation property value, the constrained value is set.
+ * @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( Dali::Quaternion& current, const Dali::PropertyInputContainer& inputs )
{
public:
/**
- * @brief Create an initialized KeyFrames handle.
+ * @brief Creates an initialized KeyFrames handle.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static KeyFrames New();
/**
- * @brief Downcast a handle to KeyFrames handle.
+ * @brief Downcasts a handle to KeyFrames handle.
*
- * If handle points to a KeyFrames object the downcast produces
- * valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a KeyFrames object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a KeyFrames object or an uninitialized handle
static KeyFrames DownCast( BaseHandle handle );
/**
- * @brief Create an uninitialized KeyFrame handle.
+ * @brief Creates an uninitialized KeyFrame handle.
*
* This can be initialized with KeyFrame::New().
* Calling member functions with an uninitialized KeyFrames handle is not allowed.
KeyFrames();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
KeyFrames(const KeyFrames& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
KeyFrames& operator=(const KeyFrames& rhs);
*
* If no key frames have been added, this returns Property::NONE.
* @SINCE_1_0.0
- * @return The key frame property type.
+ * @return The key frame property type
*/
Property::Type GetType() const;
/**
- * @brief Add a key frame.
+ * @brief Adds a key frame.
*
* The key frames should be added in time order.
* @SINCE_1_0.0
- * @param[in] progress A progress value between 0.0 and 1.0.
- * @param[in] value A value.
+ * @param[in] progress A progress value between 0.0 and 1.0
+ * @param[in] value A value
*/
void Add(float progress, Property::Value value);
/**
- * @brief Add a key frame.
+ * @brief Adds a key frame.
*
* The key frames should be added in time order.
* @SINCE_1_0.0
- * @param[in] progress A progress value between 0.0 and 1.0.
- * @param[in] value A value.
+ * @param[in] progress A progress value between 0.0 and 1.0
+ * @param[in] value A value
* @param[in] alpha The alpha function used to blend to the next keyframe
*/
void Add(float progress, Property::Value value, AlphaFunction alpha);
}
/**
- * @brief LinearConstrainer applies constraints to objects given a linear map.
+ * @brief LinearConstrainer applies constraints to objects, given a linear map.
*
* A linear map is defined by a set of value-progress pairs.
* Progress must be normalized between [0,1]. If no progress is defined, the values
- * are considered to be equally spaced along the x axis.
+ * are considered to be equally spaced along the X axis.
*
* Basically, a linear constrainer allows constraining a property to another property
* with the changes mapped over a certain range. For example, if you want to change the
- * opacity of an actor depending on its position along the X-axis, so that it’s fully
+ * opacity of an actor depending on its position along the X-axis, so that it's fully
* transparent on the edges and fully opaque in the center. To do this, an array with
* values, 0.0f, 1.0f, 0.0f, is created, which means that there are 3 control points.
* You can add as many control points as you want, but they will be linearly spaced.
* Then you can apply the linear constrainer by using the alpha of the actor as the
- * target and the source as the actor’s position.
+ * target and the source as the actor's position.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API LinearConstrainer : public Handle
public:
/**
- * @brief An enumeration of properties belonging to the LinearConstrainer class.
+ * @brief Enumeration for the instance of properties belonging to the LinearConstrainer class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the LinearConstrainer class.
+ * @brief Enumeration for the instance of properties belonging to the LinearConstrainer class.
* @SINCE_1_0.0
*/
enum
};
/**
- * @brief Create an initialized LinearConstrainer handle.
+ * @brief Creates an initialized LinearConstrainer handle.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static LinearConstrainer New();
/**
- * @brief Downcast a handle to LinearConstrainer handle.
+ * @brief Downcasts a handle to LinearConstrainer handle.
*
- * If handle points to a LinearConstrainer object the downcast produces
- * valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a LinearConstrainer object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a LinearConstrainer object or an uninitialized handle
static LinearConstrainer DownCast( BaseHandle handle );
/**
- * @brief Create an uninitialized LinearConstrainer handle.
+ * @brief Creates an uninitialized LinearConstrainer handle.
*
* This can be initialized with @ref LinearConstrainer::New
* Calling member functions with an uninitialized LinearConstrainer handle is not allowed.
LinearConstrainer();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
LinearConstrainer(const LinearConstrainer& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
LinearConstrainer& operator=(const LinearConstrainer& rhs);
/**
- * @brief Applies the linear constraint to the target property
+ * @brief Applies the linear constraint to the target property.
*
* @SINCE_1_0.0
* @param[in] target Property to be constrained
- * @param[in] source Property used as parameter for the linear map
+ * @param[in] source Property used as a parameter for the linear map
* @param[in] range The range of values in the source property which will be mapped to [0,1]
* @param[in] wrap Wrapping domain. Source property will be wrapped in the domain [wrap.x,wrap.y] before mapping to [0,1]. See cfloat.h for FLT_MAX
*/
void Apply( Dali::Property target, Dali::Property source, const Vector2& range, const Vector2& wrap = Vector2(-FLT_MAX, FLT_MAX) );
/**
- * @brief Removes the linear constraint in the target object
+ * @brief Removes the linear constraint in the target object.
*
* @SINCE_1_0.0
* @param[in] target A handle to an object constrained by the LinearConstrainer
}
/**
- * @brief A 3D parametric curve
+ * @brief A 3D parametric curve.
*
- * Paths can be used to animate position and orientation of actors using Dali::Animate()
+ * Paths can be used to animate position and orientation of actors using Dali::Animate().
*
* @SINCE_1_0.0
*/
public:
/**
- * @brief An enumeration of properties belonging to the Path class.
+ * @brief Enumeration for the instance of properties belonging to the Path class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Path class.
+ * @brief Enumeration for the instance of properties belonging to the Path class.
* @SINCE_1_0.0
*/
enum
};
/**
- * @brief Create an initialized Path handle.
+ * @brief Creates an initialized Path handle.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static Path New();
/**
- * @brief Downcast a handle to Path handle.
+ * @brief Downcasts a handle to Path handle.
*
- * If handle points to a Path object the downcast produces
- * valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a Path object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a Path object or an uninitialized handle
static Path DownCast( BaseHandle handle );
/**
- * @brief Create an uninitialized Path handle.
+ * @brief Creates an uninitialized Path handle.
*
* This can be initialized with Path::New().
* Calling member functions with an uninitialized Path handle is not allowed.
Path();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
Path(const Path& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Path& operator=(const Path& rhs);
/**
- * @brief Add an interpolation point.
+ * @brief Adds an interpolation point.
*
* @SINCE_1_0.0
* @param[in] point The new interpolation point to be added
void AddPoint(const Vector3& point );
/**
- * @brief Add a control point.
+ * @brief Adds a control point.
*
* @SINCE_1_0.0
* @param[in] point The new control point to be added
* negative values means the spline contains loops, positive values up to
* 0.5 result in a smooth curve, positive values between 0.5 and 1 result
* in looped curves where the loops are not distinct (i.e. the curve appears
- * to be non-continuous), positive values higher than 1 result in looped curves.
+ * to be non-continuous), positive values higher than 1 result in looped curves
* @pre There are at least two points in the path ( one segment ).
*
*/
void GenerateControlPoints( float curvature );
/**
- * @brief Sample path at a given progress. Calculates position and tangent at that point of the curve
+ * @brief Sample path at a given progress. Calculates position and tangent at that point of the curve.
*
* @SINCE_1_0.0
- * @param[in] progress A floating point value between 0.0 and 1.0.
- * @param[out] position The interpolated position at that progress.
- * @param[out] tangent The interpolated tangent at that progress.
+ * @param[in] progress A floating point value between 0.0 and 1.0
+ * @param[out] position The interpolated position at that progress
+ * @param[out] tangent The interpolated tangent at that progress
*/
void Sample( float progress, Vector3& position, Vector3& tangent ) const;
* @brief Accessor for the interpolation points.
*
* @SINCE_1_0.0
- * @param[in] index The index of the interpolation point.
- * @return A reference to the interpolation point.
+ * @param[in] index The index of the interpolation point
+ * @return A reference to the interpolation point
*/
Vector3& GetPoint( size_t index );
* @brief Accessor for the control points.
*
* @SINCE_1_0.0
- * @param[in] index The index of the control point.
- * @return A reference to the control point.
+ * @param[in] index The index of the control point
+ * @return A reference to the control point
*/
Vector3& GetControlPoint( size_t index );
/**
- * @brief Get the number of interpolation points in the path
+ * @brief Gets the number of interpolation points in the path.
*
* @SINCE_1_0.0
* @return The number of interpolation points in the path
struct DALI_IMPORT_API TimePeriod
{
/**
- * @brief Create a time period.
+ * @brief Creates a time period.
*
* @SINCE_1_0.0
- * @param [in] durationSeconds The duration of the time period in seconds.
+ * @param[in] durationSeconds The duration of the time period in seconds
*/
explicit TimePeriod(float durationSeconds);
/**
- * @brief Create a time period.
+ * @brief Creates a time period.
*
* @SINCE_1_0.0
- * @param [in] delaySeconds A delay before the time period in seconds.
- * @param [in] durationSeconds The duration of the time period in seconds.
+ * @param[in] delaySeconds A delay before the time period in seconds
+ * @param[in] durationSeconds The duration of the time period in seconds
*/
TimePeriod(float delaySeconds, float durationSeconds);
/**
- * @brief Non-virtual destructor; TimePeriod is not intended as a base class.
+ * @brief Non-virtual destructor. TimePeriod is not intended as a base class.
* @SINCE_1_0.0
*/
~TimePeriod();
*/
/**
- * @brief ParentOrigin constants
+ * @brief ParentOrigin constants.
*
- * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f)
+ * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f).
* @SINCE_1_0.0
*/
namespace ParentOrigin
}
/**
- * @brief AnchorPoint constants
+ * @brief AnchorPoint constants.
*
- * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f)
+ * Note that for 2D layouting, the typical Z position is 0.5f (not 0.0f).
* @SINCE_1_0.0
*/
namespace AnchorPoint
} // namespace Color
/**
- * @brief Math constants
+ * @brief Math constants.
* @SINCE_1_0.0
*/
namespace Math
#endif
/*
- * Definitions for shared library support
+ * Definitions for shared library support.
*
* If a library is configured with --enable-exportall or --enable-debug
* then HIDE_DALI_INTERNALS is not defined, and nothing is hidden.
* If it is configured without these options (the default), then HIDE_INTERNALS
* is defined when building the library, visibility is automatically hidden, and the explicit
* defines below come into use.
- * When building a library that uses DALI, HIDE_DALI_INTERNALS
+ * When building a library that uses DALI, HIDE_DALI_INTERNALS.
*/
#if __GNUC__ >= 4
# ifndef HIDE_DALI_INTERNALS
/**
* @brief Two macros to provide branch predictor information.
* DALI_LIKELY should be used when a branch is taken in almost all cases so the
- * branch predictor can avoid pre-fetching the code for else branch
- * DALI_UNLIKELY should be used when a branch is almost never taken
+ * branch predictor can avoid pre-fetching. The code for else branch
+ * DALI_UNLIKELY should be used when a branch is almost never taken.
* @SINCE_1_0.0
*/
#define DALI_LIKELY(expression) __builtin_expect( !!(expression), 1 )
#define DALI_UNLIKELY(expression) __builtin_expect( !!(expression), 0 )
/**
- * @brief The DALi namespace
+ * @brief The DALi namespace.
* @SINCE_1_0.0
*/
namespace Dali
*/
/**
- * @brief Strip assert location for release builds, assert text is descriptive enough
- * This is to save space for low spec devices
+ * @brief Strip assert location for release builds, assert text is descriptive enough.
+ * This is to save space for low spec devices.
* @SINCE_1_0.0
*/
#if defined(DEBUG_ENABLED)
/**
* @brief An invariant concurrent assertion to ensure its argument evaluates TRUE in debug builds.
*
- * Use this to sanity check algorithms and prevent internal programming errors
+ * Use this to sanity check algorithms and prevent internal programming errors.
* @SINCE_1_0.0
*/
#if defined(DEBUG_ENABLED)
#include <dali/public-api/math/math-utils.h>
/**
- * @brief For DALi internal use asserts are enabled in debug builds.
+ * @brief For DALi internal use, asserts are enabled in debug builds.
*
- * For Application use asserts can be enabled manually.
+ * For Application use, asserts can be enabled manually.
* @SINCE_1_0.0
*/
#if defined( DEBUG_ENABLED )
* @brief Destructor.
*
* Does not release the space. Derived class needs to call Release.
- * Not virtual as should not be called directly and we do not want
+ * Not virtual as this should not be called directly and we do not want
* a vtable for this class as it would unnecessarily increase size.
* @SINCE_1_0.0
*/
public: // API
/**
- * @brief This method is inlined as its needed frequently for Vector::End() iterator.
+ * @brief This method is inlined as it's needed frequently for Vector::End() iterator.
*
* @SINCE_1_0.0
- * @return The count of elements in this vector.
+ * @return The count of elements in this vector
*/
SizeType Count() const
{
/**
* @brief Gets the count of elements in this vector.
* @SINCE_1_0.0
- * @return The count of elements in this vector.
+ * @return The count of elements in this vector
*/
SizeType Size() const
{
}
/**
- * @brief @ return If the vector is empty
+ * @brief @ return if the vector is empty.
* @SINCE_1_0.0
- * @return true if the count of elements is empty
+ * @return True if the count of elements is empty
*/
bool Empty() const
{
/**
* @brief Gets the capacity of this vector.
* @SINCE_1_0.0
- * @return The capacity of this vector.
+ * @return The capacity of this vector
*/
SizeType Capacity() const;
/**
- * @brief Release the data.
+ * @brief Releases the data.
*
* Does not call destructors on objects held.
* @SINCE_1_0.0
* @brief Helper to set the count.
*
* @SINCE_1_0.0
- * @param[in] count Number of elements in the vector.
+ * @param[in] count Number of elements in the vector
*/
void SetCount( SizeType count );
/**
- * @brief Reserve space in the vector.
+ * @brief Reserves space in the vector.
*
* @SINCE_1_0.0
- * @param[in] count Count of elements to reserve.
- * @param[in] elementSize Size of a single element.
+ * @param[in] count Count of elements to reserve
+ * @param[in] elementSize Size of a single element
*/
void Reserve( SizeType count, SizeType elementSize );
* @brief Copy a vector.
*
* @SINCE_1_0.0
- * @param[in] vector Vector to copy from.
- * @param[in] elementSize Size of a single element.
+ * @param[in] vector Vector to copy from
+ * @param[in] elementSize Size of a single element
*/
void Copy( const VectorBase& vector, SizeType elementSize );
/**
- * @brief Swap the contents of two vectors.
+ * @brief Swaps the contents of two vectors.
*
* @SINCE_1_0.0
- * @param[in] vector Vector to swap with.
+ * @param[in] vector Vector to swap with
*/
void Swap( VectorBase& vector );
/**
- * @brief Erase an element.
+ * @brief Erases an element.
*
* Does not change capacity.
* @SINCE_1_0.0
- * @param[in] address Adress to erase from.
- * @param[in] elementSize Size to erase.
+ * @param[in] address Address to erase from
+ * @param[in] elementSize Size to erase
* @pre Last element cannot be erased as there is nothing to move.
*/
void Erase( char* address, SizeType elementSize );
/**
- * @brief Erase a range of elements.
+ * @brief Erases a range of elements.
*
* Does not change capacity.
* @SINCE_1_0.0
- * @param[in] first Address to the first element to be erased.
- * @param[in] last Address to the last element to be erased.
- * @param[in] elementSize Size of one of the elements to be erased.
- * @return Address pointing to the next element of the last one.
+ * @param[in] first Address to the first element to be erased
+ * @param[in] last Address to the last element to be erased
+ * @param[in] elementSize Size of one of the elements to be erased
+ * @return Address pointing to the next element of the last one
*/
char* Erase( char* first, char* last, SizeType elementSize );
* \e source and \e destination must not overlap.
*
* @SINCE_1_0.0
- * @param[in] destination Pointer to the destination address.
- * @param[in] source Pointer to the source address.
- * @param[in] numberOfBytes The number of bytes to be copied.
+ * @param[in] destination Pointer to the destination address
+ * @param[in] source Pointer to the source address
+ * @param[in] numberOfBytes The number of bytes to be copied
*/
void CopyMemory( char* destination, const char* source, size_t numberOfBytes );
* @brief Copy vector contents.
*
* @SINCE_1_0.0
- * @param[in] rhs VectorBase object to copy from.
- * @param[in] elementSize Size of the content.
+ * @param[in] rhs VectorBase object to copy from
+ * @param[in] elementSize Size of the content
*/
void Copy( const VectorBase& rhs, SizeType elementSize )
{
}
/**
- * @brief Reserve space in the vector.
+ * @brief Reserves space in the vector.
*
* @SINCE_1_0.0
- * @param[in] count Count of elements to reserve.
- * @param[in] elementSize Size of a single element.
+ * @param[in] count Count of elements to reserve
+ * @param[in] elementSize Size of a single element
*/
void Reserve( SizeType count, SizeType elementSize )
{
}
/**
- * @brief Resize the vector. Does not change capacity.
+ * @brief Resizes the vector. Does not change capacity.
*
* @SINCE_1_0.0
- * @param[in] count Count to resize to.
- * @param[in] elementSize Size of a single element.
+ * @param[in] count Count to resize to
+ * @param[in] elementSize Size of a single element
*/
void Resize( SizeType count, SizeType elementSize )
{
}
/**
- * @brief Clear the contents.
+ * @brief Clears the contents.
*
- * For simple types nothing to do.
+ * For simple types, nothing to do.
* @SINCE_1_0.0
*/
void Clear()
}
/**
- * @brief Release the vector.
+ * @brief Releases the vector.
* @SINCE_1_0.0
*/
void Release()
}
/**
- * @brief Erase an element. Does not change capacity.
+ * @brief Erases an element. Does not change capacity.
*
* @SINCE_1_0.0
- * @param[in] address Address to erase from.
- * @param[in] elementSize Size to erase.
+ * @param[in] address Address to erase from
+ * @param[in] elementSize Size to erase
*/
void Erase( char* address, SizeType elementSize )
{
}
/**
- * @brief Erase a range of elements. Does not change capacity.
+ * @brief Erases a range of elements. Does not change capacity.
*
* @SINCE_1_0.0
- * @param[in] first Address to the first element to be erased.
- * @param[in] last Address to the last element to be erased.
- * @param[in] elementSize Size of one of the elements to be erased.
- * @return Address pointing to the next element of the last one.
+ * @param[in] first Address to the first element to be erased
+ * @param[in] last Address to the last element to be erased
+ * @param[in] elementSize Size of one of the elements to be erased
+ * @return Address pointing to the next element of the last one
*/
char* Erase( char* first, char* last, SizeType elementSize )
{
* @brief Inserts the given elements into the vector.
*
* @SINCE_1_0.0
- * @param[in] at Address where to insert the elements into the vector.
- * @param[in] from Address to the first element to be inserted.
- * @param[in] to Address to the last element to be inserted.
- * @param[in] elementSize Size of one of the elements to be inserted.
+ * @param[in] at Address where to insert the elements into the vector
+ * @param[in] from Address to the first element to be inserted
+ * @param[in] to Address to the last element to be inserted
+ * @param[in] elementSize Size of one of the elements to be inserted
*/
void Insert( char* at, char* from, char* to, SizeType elementSize )
{
};
/**
- * @brief Vector class with minimum space allocation when its empty.
+ * @brief Vector class with minimum space allocation when it's empty.
*
* @SINCE_1_0.0
- * @param type of the data that the vector holds.
+ * @param type The type of the data that the vector holds
*/
template< class T, bool IsTrivialType = TypeTraits<T>::IS_TRIVIAL_TYPE == true >
class Vector : public VectorAlgorithms< IsTrivialType >
* @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param[in] vector Vector to copy from.
+ * @param[in] vector Vector to copy from
*/
Vector( const Vector& vector )
{
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] vector Vector to assign from.
- * @return Reference to self for chaining.
+ * @param[in] vector Vector to assign from
+ * @return Reference to self for chaining
*/
Vector& operator=( const Vector& vector )
{
/**
* @brief Iterator to the beginning of the data.
* @SINCE_1_0.0
- * @return Iterator to the beginning of the data.
+ * @return Iterator to the beginning of the data
*/
Iterator Begin() const
{
/**
* @brief Iterator to the end of the data (one past last element).
* @SINCE_1_0.0
- * @return Iterator to the end of the data (one past last element).
+ * @return Iterator to the end of the data (one past last element)
*/
Iterator End() const
{
/**
* @brief Subscript operator.
* @SINCE_1_0.0
- * @param[in] index Index of the element.
- * @return Reference to the element for given index.
+ * @param[in] index Index of the element
+ * @return Reference to the element for given index
* @pre Index must be in the vector's range.
*/
ItemType& operator[]( SizeType index )
/**
* @brief Subscript operator.
* @SINCE_1_0.0
- * @param[in] index Index of the element.
- * @return reference to the element for given index.
- * @pre index must be in the vector's range.
+ * @param[in] index Index of the element
+ * @return Reference to the element for given index
+ * @pre Index must be in the vector's range.
*/
const ItemType& operator[]( SizeType index ) const
{
}
/**
- * @brief Push back an element to the vector.
+ * @brief Pushes back an element to the vector.
*
* The underlying storage may be reallocated to provide space.
* If this occurs, all pre-existing pointers into the vector will
* become invalid.
*
* @SINCE_1_0.0
- * @param[in] element Element to be added.
+ * @param[in] element Element to be added
*/
void PushBack( const ItemType& element )
{
}
/**
- *@brief Insert an element to the vector.
+ * @brief Inserts an element to the vector.
*
* Elements after \e at are moved one position to the right.
*
* If this occurs, all pre-existing pointers into the vector will
* become invalid.
*
+ * @SINCE_1_0.0
+ * @param[in] at Iterator where to insert the elements into the vector
+ * @param[in] element An element to be added
* @pre Iterator at must be in the vector's range ( Vector::Begin(), Vector::End() ).
- *
- * @param[in] at Iterator where to insert the elements into the vector.
- * @param[in] element An element to be added.
- *@SINCE_1_0.0
*/
void Insert( Iterator at, const ItemType& element )
{
* become invalid.
*
* @SINCE_1_0.0
- * @param[in] at Iterator where to insert the elements into the vector.
- * @param[in] from Iterator to the first element to be inserted.
- * @param[in] to Iterator to the last element to be inserted.
+ * @param[in] at Iterator where to insert the elements into the vector
+ * @param[in] from Iterator to the first element to be inserted
+ * @param[in] to Iterator to the last element to be inserted
* @pre Iterator \e at must be in the vector's range ( Vector::Begin(), Vector::End() ).
* @pre Iterators \e from and \e to must be valid iterators.
* @pre Iterator \e from must not be grater than Iterator \e to.
}
/**
- * @brief Reserve space in the vector.
+ * @brief Reserves space in the vector.
*
* Reserving less than current Capacity is a no-op.
* @SINCE_1_0.0
- * @param[in] count Count of elements to reserve.
+ * @param[in] count Count of elements to reserve
*/
void Reserve( SizeType count )
{
}
/**
- * @brief Resize the vector. Does not change capacity.
+ * @brief Resizes the vector. Does not change capacity.
*
* @SINCE_1_0.0
- * @param[in] count Count to resize to.
+ * @param[in] count Count to resize to
*/
void Resize( SizeType count )
{
}
/**
- * @brief Resize the vector. Does not change capacity.
+ * @brief Resizes the vector. Does not change capacity.
*
* @SINCE_1_0.0
- * @param[in] count Count to resize to.
- * @param[in] item An item to insert to the new indices.
+ * @param[in] count Count to resize to
+ * @param[in] item An item to insert to the new indices
*/
void Resize( SizeType count, const ItemType& item )
{
}
/**
- * @brief Erase an element.
+ * @brief Erases an element.
*
* Does not change capacity. Other elements get moved.
*
* @SINCE_1_0.0
- * @param[in] iterator Iterator pointing to item to remove.
- * @return Iterator pointing to next element.
+ * @param[in] iterator Iterator pointing to the item to remove
+ * @return Iterator pointing to next element
* @pre Iterator \e iterator must be within the vector's range ( Vector::Begin(), Vector::End() - 1 ).
*
*/
}
/**
- * @brief Erase a range of elements.
+ * @brief Erases a range of elements.
*
* Does not change capacity. Other elements get moved.
*
* @SINCE_1_0.0
- * @param[in] first Iterator to the first element to be erased.
- * @param[in] last Iterator to the last element to be erased.
+ * @param[in] first Iterator to the first element to be erased
+ * @param[in] last Iterator to the last element to be erased
*
- * @return Iterator pointing to the next element of the last one.
+ * @return Iterator pointing to the next element of the last one
* @pre Iterator \e first must be in the vector's range ( Vector::Begin(), Vector::End() ).
* @pre Iterator \e last must be in the vector's range ( Vector::Begin(), Vector::End() ).
* @pre Iterator \e first must not be grater than Iterator \e last.
/**
* @brief Removes an element.
*
- * Does not maintain order. Swaps the element with end and
+ * Does not maintain order. Swaps the element with end and
* decreases size by one. This is much faster than Erase so use
* this in case order does not matter. Does not change capacity.
*
* @SINCE_1_0.0
- * @param[in] iterator Iterator pointing to item to remove.
+ * @param[in] iterator Iterator pointing to the item to remove
* @pre Iterator \e iterator must be in the vector's range ( Vector::Begin(), Vector::End() - 1 ).
*
*/
}
/**
- * @brief Swap the contents of two vectors.
+ * @brief Swaps the contents of two vectors.
*
* @SINCE_1_0.0
- * @param[in] vector Vector to swap with.
+ * @param[in] vector Vector to swap with
*/
void Swap( Vector& vector )
{
}
/**
- * @brief Clear the contents of the vector. Keeps its capacity.
+ * @brief Clears the contents of the vector. Keeps its capacity.
* @SINCE_1_0.0
*/
void Clear()
}
/**
- * @brief Release the memory that the vector holds.
+ * @brief Releases the memory that the vector holds.
* @SINCE_1_0.0
*/
void Release()
*/
/**
- * @brief Templated intrusive pointer class
+ * @brief Templated intrusive pointer class.
*
* Uses the Dali:RefObject type with actual reference counting.
* The object is responsible for destroying itself.
* @brief Constructor to attach existing object.
*
* @SINCE_1_0.0
- * @param[in] p Pointer to object,
+ * @param[in] p Pointer to object
*/
IntrusivePtr( T* p ) : mPtr( p )
{
/**
* @brief Destructor.
*
- * Object will self-destruct if reference count is zero
+ * Object will self-destruct if reference count is zero.
* @SINCE_1_0.0
*/
~IntrusivePtr()
}
/**
- * @brief Get pointer to reference counted object.
+ * @brief Gets pointer to reference counted object.
*
* @SINCE_1_0.0
* @return Pointer to reference counted object
}
/**
- * @brief Detach pointer from intrusive ptr counting.
+ * @brief Detaches pointer from intrusive ptr counting.
*
* Use with care.
* @SINCE_1_0.0
void ThisIsSaferThanReturningVoidStar() const {}
/**
- * @brief Internal swap function
+ * @brief Internal swap function.
* @SINCE_1_0.0
*/
void Swap( IntrusivePtr& rhs )
}
/**
- * @brief Comparison overrides of objects wrapped by intrusive pointers
+ * @brief Comparison overrides of objects wrapped by intrusive pointers.
*
* @SINCE_1_0.0
* @param[in] lhs Intrusive pointer to compare with
}
/**
- * @brief Comparison overrides of objects wrapped by intrusive pointers
+ * @brief Comparison overrides of objects wrapped by intrusive pointers.
*
* @SINCE_1_0.0
* @param[in] lhs Object to compare with
}
/**
- * @brief Comparison overrides of objects wrapped by intrusive pointers
+ * @brief Comparison overrides of objects wrapped by intrusive pointers.
*
* @SINCE_1_0.0
* @param[in] lhs Object to compare with
*/
/**
- * @brief The status during resource loading operations.
+ * @brief Enumeration for the status during resource loading operations.
* @SINCE_1_0.0
*/
enum LoadingState
Stage();
/**
- * @brief Get the current Stage.
+ * @brief Gets the current Stage.
*
* @SINCE_1_0.0
- * @return The current stage or an empty handle if the internal core has not been created or has been already destroyed.
+ * @return The current stage or an empty handle if the internal core has not been created or has been already destroyed
*/
static Stage GetCurrent();
/**
- * @brief Query whether the Stage exists; this should only return false during or after destruction of Dali core.
+ * @brief Queries whether the Stage exists; this should only return false during or after destruction of Dali core.
*
* @SINCE_1_0.0
- * @return True when it's safe to call Stage::GetCurrent().
+ * @return True when it's safe to call Stage::GetCurrent()
*/
static bool IsInstalled();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
Stage(const Stage& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Stage& operator=(const Stage& rhs);
*
* The child will be referenced.
* @SINCE_1_0.0
- * @param [in] actor The child.
+ * @param[in] actor The child
* @pre The actor has been initialized.
* @pre The actor does not have a parent.
*/
*
* The child will be unreferenced.
* @SINCE_1_0.0
- * @param [in] actor The child.
+ * @param[in] actor The child
* @pre The actor has been added to the stage.
*/
void Remove(Actor& actor);
/**
* @brief Returns the size of the Stage in pixels as a Vector.
*
- * The x component will be the width of the Stage in pixels
- * The y component will be the height of the Stage in pixels
- * The z component will be the distance between far and near planes
+ * The x component will be the width of the Stage in pixels.
+ * The y component will be the height of the Stage in pixels.
+ * The z component will be the distance between far and near planes.
* @SINCE_1_0.0
- * @return The size of the Stage as a Vector.
+ * @return The size of the Stage as a Vector
*/
Vector2 GetSize() const;
// Render Tasks
/**
- * @brief Retrieve the list of render-tasks.
+ * @brief Retrieves the list of render-tasks.
*
* @SINCE_1_0.0
- * @return A valid handle to a RenderTaskList.
+ * @return A valid handle to a RenderTaskList
*/
RenderTaskList GetRenderTaskList() const;
// Layers
/**
- * @brief Query the number of on-stage layers.
+ * @brief Queries the number of on-stage layers.
*
* Note that a default layer is always provided (count >= 1).
* @SINCE_1_0.0
- * @return The number of layers.
+ * @return The number of layers
*/
unsigned int GetLayerCount() const;
/**
- * @brief Retrieve the layer at a specified depth.
+ * @brief Retrieves the layer at a specified depth.
*
* @SINCE_1_0.0
- * @param[in] depth The depth.
- * @return The layer found at the given depth.
+ * @param[in] depth The depth
+ * @return The layer found at the given depth
* @pre Depth is less than layer count; see GetLayerCount().
*/
Layer GetLayer(unsigned int depth) const;
* @brief Returns the Stage's Root Layer.
*
* @SINCE_1_0.0
- * @return The root layer.
+ * @return The root layer
*/
Layer GetRootLayer() const;
// Background color
/**
- * @brief Set the background color of the stage.
+ * @brief Sets the background color of the stage.
*
* @SINCE_1_0.0
- * @param[in] color The new background color.
+ * @param[in] color The new background color
*/
void SetBackgroundColor(Vector4 color);
/**
- * @brief Retrieve the background color of the stage.
+ * @brief Retrieves the background color of the stage.
*
* @SINCE_1_0.0
- * @return The background color.
+ * @return The background color
*/
Vector4 GetBackgroundColor() const;
/**
- * @brief Retrieve the DPI of the display device to which the stage is connected.
+ * @brief Retrieves the DPI of the display device to which the stage is connected.
*
* @SINCE_1_0.0
* @return The horizontal and vertical DPI
Vector2 GetDpi() const;
/**
- * @brief Get the Object registry.
+ * @brief Gets the Object registry.
*
* @SINCE_1_0.0
- * @return The object registry.
+ * @return The object registry
*/
ObjectRegistry GetObjectRegistry() const;
/**
* @brief Keep rendering for at least the given amount of time.
*
- * By default Dali will stop rendering when no Actor positions are being set, and when no animations are running etc.
+ * By default, Dali will stop rendering when no Actor positions are being set, and when no animations are running etc.
* This method is useful to force screen refreshes e.g. when updating a NativeImage.
* @SINCE_1_0.0
* @param[in] durationSeconds Time to keep rendering, 0 means render at least one more frame
* void YourCallbackName(const KeyEvent& event);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
KeyEventSignalType& KeyEventSignal();
* @brief This signal is emitted just after the event processing is finished.
*
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
EventProcessingFinishedSignalType& EventProcessingFinishedSignal();
* @endcode
*
* @SINCE_1_0.0
- * @return The touch signal to connect to.
+ * @return The touch signal to connect to
* @note Motion events are not emitted.
*/
TouchedSignalType& TouchedSignal() DALI_DEPRECATED_API;
* @endcode
*
* @SINCE_1_1.37
- * @return The touch signal to connect to.
+ * @return The touch signal to connect to
* @note Motion events are not emitted.
*/
TouchSignalType& TouchSignal();
* void YourCallbackName(const WheelEvent& event);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
WheelEventSignalType& WheelEventSignal();
* @brief This signal is emitted when the GL context is lost (Platform specific behaviour).
*
* If the application is responsible for handling context loss, it should listen to
- * this signal and tear down UI components when recieved.
+ * this signal and tear down UI components when received.
* @SINCE_1_0.0
- * @return The context lost signal to connect to.
+ * @return The context lost signal to connect to
*/
ContextStatusSignal& ContextLostSignal();
/**
* @brief This signal is emitted when the GL context is regained (Platform specific
- * behaviour).
+ * behavior).
*
* If the application is responsible for handling context loss, it should listen to
* this signal and rebuild UI components on receipt.
* @SINCE_1_0.0
- * @return The context regained signal to connect to.
+ * @return The context regained signal to connect to
*/
ContextStatusSignal& ContextRegainedSignal();
* void YourCallbackName();
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
*/
SceneCreatedSignalType& SceneCreatedSignal();
* @brief This constructor is used by Stage::GetCurrent() methods.
*
* @SINCE_1_0.0
- * @param [in] stage A pointer to a Dali resource
+ * @param[in] stage A pointer to a Dali resource
*/
explicit DALI_INTERNAL Stage(Internal::Stage* stage);
/// @endcond
/**
* @brief Basic type traits that every type has by default.
*
- * This allows specializations to not have to repeat all flags
+ * This allows specializations to not have to repeat all flags.
* @SINCE_1_0.0
*/
template <typename Type>
*/
/**
- * @brief Stereoscopic view modes
+ * @brief Enumeration for stereoscopic view modes.
* @SINCE_1_0.0
*/
enum ViewMode
public: // Creation & Destruction
/**
- * @brief Create an uninitialized GestureDetector.
+ * @brief Creates an uninitialized GestureDetector.
*
* This can be initialized with one of the derived gesture detectors' New() methods. For example, PanGestureDetector::New().
*
GestureDetector();
/**
- * @brief Downcast a handle to GestureDetector handle.
+ * @brief Downcasts a handle to GestureDetector handle.
*
- * If handle points to a GestureDetector object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a GestureDetector object, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a GestureDetector object or an uninitialized handle
static GestureDetector DownCast( BaseHandle handle );
/**
- * @brief Dali::GestureDetector is intended as a base class
+ * @brief Dali::GestureDetector is intended as a base class.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
GestureDetector(const GestureDetector& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
GestureDetector& operator=(const GestureDetector& rhs);
* The detected signal will be dispatched when the gesture occurs on
* the attached actor.
* @SINCE_1_0.0
- * @param[in] actor The actor to attach to the gesture detector
+ * @param[in] actor The actor to attach to the gesture detector
* @pre The gesture detector has been initialized.
* @note You can attach several actors to a gesture detector.
*/
* @brief Detaches the attached actor from the gesture detector.
*
* @SINCE_1_0.0
- * @param[in] actor The actor to detach from the gesture detector.
+ * @param[in] actor The actor to detach from the gesture detector
* @pre The gesture detector has been initialized.
* @pre The specified actor has been attached to the gesture detector.
*/
*
* @SINCE_1_0.0
* @param[in] index The attached actor's index
- * @return The attached actor or an empty handle.
+ * @return The attached actor or an empty handle
* @pre The gesture detector has been initialized.
*/
Actor GetAttachedActor(size_t index) const;
* @brief This constructor is used by New() methods of derived classes (For example, PanGestureDetector::New()).
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param[in] internal A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL GestureDetector(Internal::GestureDetector* internal);
/// @endcond
virtual ~Gesture();
/**
- * @brief Type of gesture.
+ * @brief Enumeration for type of gesture.
* @SINCE_1_0.0
*/
enum Type
};
/**
- * @brief State of the gesture.
+ * @brief Enumeration for state of the gesture.
* @SINCE_1_0.0
*/
enum State
// Construction & Destruction
/**
- * @brief Default constructor
+ * @brief Default constructor.
* @SINCE_1_0.0
*/
HoverEvent();
/**
- * @brief Constructor
+ * @brief Constructor.
* @SINCE_1_0.0
- * @param[in] time The time the event occurred
+ * @param[in] time The time the event occurred
*/
HoverEvent(unsigned long time);
/**
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_0.0
*/
~HoverEvent();
* @brief Returns the total number of points in this HoverEvent.
*
* @SINCE_1_0.0
- * @return Total number of Points.
+ * @return Total number of Points
*/
unsigned int GetPointCount() const;
* The first point in the set is always the primary
* touch point (i.e. the first point touched in a multi-touch event).
* @SINCE_1_0.0
- * @param[in] point The index of the required Point.
+ * @param[in] point The index of the required Point
* @return Point requested
* @note "point" should be less than the value returned by GetPointCount().
* If out of range, then program asserts.
// Enumerations
/**
- * @brief Specifies the state of the key event.
+ * @brief Enumeration for specifying the state of the key event.
* @SINCE_1_0.0
*/
enum State
};
/**
- * @brief Default constructor
+ * @brief Default constructor.
* @SINCE_1_0.0
*/
KeyEvent();
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] keyName The name of the key pressed or command from the IMF, if later then the some following parameters will be needed.
- * @param[in] keyString A string of input characters or key pressed
- * @param[in] keyCode The unique key code for the key pressed.
- * @param[in] keyModifier The key modifier for special keys like shift and alt
- * @param[in] timeStamp The time (in ms) that the key event occurred.
- * @param[in] keyState The state of the key event.
+ * @param[in] keyName The name of the key pressed or command from the IMF, if later then the some following parameters will be needed
+ * @param[in] keyString A string of input characters or key pressed
+ * @param[in] keyCode The unique key code for the key pressed
+ * @param[in] keyModifier The key modifier for special keys like shift and alt
+ * @param[in] timeStamp The time (in ms) that the key event occurred
+ * @param[in] keyState The state of the key event
*/
KeyEvent(const std::string& keyName, const std::string& keyString, int keyCode, int keyModifier, unsigned long timeStamp, const State& keyState);
~KeyEvent();
/**
- * @brief Check to see if Shift key modifier has been supplied.
+ * @brief Checks to see if Shift key modifier has been supplied.
*
* @SINCE_1_0.0
* @return True if shift modifier
bool IsShiftModifier() const;
/**
- * @brief Check to see if Ctrl (control) key modifier has been supplied.
+ * @brief Checks to see if Ctrl (control) key modifier has been supplied.
*
* @SINCE_1_0.0
* @return True if ctrl modifier
bool IsCtrlModifier() const;
/**
- * @brief Check to see if Alt key modifier has been supplied.
+ * @brief Checks to see if Alt key modifier has been supplied.
*
* @SINCE_1_0.0
* @return True if alt modifier
// Data
/**
- * @brief name given to the key pressed.
+ * @brief Name given to the key pressed.
*/
std::string keyPressedName;
public: // Creation & Destruction
/**
- * @brief Create an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
+ * @brief Creates an uninitialized LongPressGestureDetector; this can be initialized with LongPressGestureDetector::New().
*
* Calling member functions with an uninitialized LongPressGestureDetector handle is not allowed.
* @SINCE_1_0.0
LongPressGestureDetector();
/**
- * @brief Create an initialized LongPressGestureDetector.
+ * @brief Creates an initialized LongPressGestureDetector.
*
* By default, this would create a gesture detector that requires only one touch.
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static LongPressGestureDetector New();
/**
- * @brief Create an initialized LongPressGestureDetector with the number of touches required.
+ * @brief Creates an initialized LongPressGestureDetector with the number of touches required.
*
* A long press gesture will be emitted from this detector if the number of fingers touching the
* screen is equal to the touches required.
* @SINCE_1_0.0
- * @param[in] touchesRequired The number of touches required.
- * @return A handle to a newly allocated Dali resource.
+ * @param[in] touchesRequired The number of touches required
+ * @return A handle to a newly allocated Dali resource
*/
static LongPressGestureDetector New(unsigned int touchesRequired);
/**
- * @brief Create an initialized LongPressGestureDetector with the minimum and maximum number of touches required.
+ * @brief Creates an initialized LongPressGestureDetector with the minimum and maximum number of touches required.
*
* A long press gesture will be emitted from this detector if the number of fingers touching the screen
* falls between the minimum and maximum touches set.
* @SINCE_1_0.0
- * @param[in] minTouches The minimum number of touches required.
- * @param[in] maxTouches The maximum number of touches required.
- * @return A handle to a newly allocated Dali resource.
+ * @param[in] minTouches The minimum number of touches required
+ * @param[in] maxTouches The maximum number of touches required
+ * @return A handle to a newly allocated Dali resource
*/
static LongPressGestureDetector New(unsigned int minTouches, unsigned int maxTouches);
/**
- * @brief Downcast a handle to LongPressGestureDetector handle.
+ * @brief Downcasts a handle to LongPressGestureDetector handle.
*
- * If handle points to a LongPressGestureDetector object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a LongPressGestureDetector object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a LongPressGestureDetector object or an uninitialized handle
static LongPressGestureDetector DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
LongPressGestureDetector(const LongPressGestureDetector& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
LongPressGestureDetector& operator=(const LongPressGestureDetector& rhs);
public: // Setters
/**
- * @brief Set the number of touches required.
+ * @brief Sets the number of touches required.
*
* The number of touches corresponds to the number of fingers a user
* has on the screen. This sets the minimum and maximum touches to
* the input parameter.
*
* @SINCE_1_0.0
- * @param[in] touches Touches required.
+ * @param[in] touches Touches required
* @pre The gesture detector has been initialized.
* @note The default is '1'.
*/
* has on the screen.
*
* @SINCE_1_0.0
- * @param[in] minTouches Minimum Touches required.
- * @param[in] maxTouches Maximum Touches required.
+ * @param[in] minTouches Minimum Touches required
+ * @param[in] maxTouches Maximum Touches required
* @pre The gesture detector has been initialized.
* @note The default is '1'.
*/
* @brief Retrieves the minimum number of touches required.
*
* @SINCE_1_0.0
- * @return The minimum number of touches required.
+ * @return The minimum number of touches required
* @pre The gesture detector has been initialized.
*/
unsigned int GetMinimumTouchesRequired() const;
* @brief Retrieves the maximum number of touches required.
*
* @SINCE_1_0.0
- * @return The maximum number of touches required.
+ * @return The maximum number of touches required
* @pre The gesture detector has been initialized.
*/
unsigned int GetMaximumTouchesRequired() const;
public: // Signals
/**
- * @brief This signal is emitted when the specified long press is detected on the attached actor.
+ * @brief This signal is emitted when the specified long press is detected on the attached actor.
*
* A callback of the following type may be connected:
* @code
* void YourCallbackName( Actor actor, const LongPressGesture& gesture );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The gesture detector has been initialized.
*/
DetectedSignalType& DetectedSignal();
* @brief This constructor is used by LongPressGestureDetector::New() methods.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param[in] internal A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL LongPressGestureDetector(Internal::LongPressGestureDetector* internal);
/// @endcond
// Construction & Destruction
/**
- * @brief Constructor
+ * @brief Constructor.
*
* @SINCE_1_0.0
* @param[in] state The state of the gesture
LongPressGesture(Gesture::State state);
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
* @SINCE_1_0.0
* @param[in] rhs A reference to the copied handle
*/
LongPressGesture( const LongPressGesture& rhs );
/**
- * @brief Assignment operator
+ * @brief Assignment operator.
* @SINCE_1_0.0
* @param[in] rhs A reference to the copied handle
* @return A reference to this
LongPressGesture& operator=( const LongPressGesture& rhs );
/**
- * @brief Virtual destructor
+ * @brief Virtual destructor.
* @SINCE_1_0.0
*/
virtual ~LongPressGesture();
* @brief This is the point, in local actor coordinates, where the long press occurred.
*
* If a multi-touch long press, then this is the centroid of all the touch points.
- * @return The point where tap has occurred (in local actor coordinates).
+ * @return The point where tap has occurred (in local actor coordinates)
*/
Vector2 localPoint;
};
public:
/**
- * @brief An enumeration of properties belonging to the PanGestureDetector class.
+ * @brief Enumeration for the instance of properties belonging to the PanGestureDetector class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the PanGestureDetector class.
+ * @brief Enumeration for the instance of properties belonging to the PanGestureDetector class.
* @SINCE_1_0.0
*/
enum
public: // Creation & Destruction
/**
- * @brief Create an uninitialized PanGestureDetector; this can be initialized with PanGestureDetector::New().
+ * @brief Creates an uninitialized PanGestureDetector; this can be initialized with PanGestureDetector::New().
*
* Calling member functions with an uninitialized PanGestureDetector handle is not allowed.
* @SINCE_1_0.0
PanGestureDetector();
/**
- * @brief Create an initialized PanGestureDetector.
+ * @brief Creates an initialized PanGestureDetector.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static PanGestureDetector New();
/**
- * @brief Downcast a handle to PanGestureDetector handle.
+ * @brief Downcasts a handle to PanGestureDetector handle.
*
- * If handle points to a PanGestureDetector object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a PanGestureDetector object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a PanGestureDetector object or an uninitialized handle
static PanGestureDetector DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
PanGestureDetector(const PanGestureDetector& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
PanGestureDetector& operator=(const PanGestureDetector& rhs);
* @brief This is the minimum number of touches required for the pan gesture to be detected.
*
* @SINCE_1_0.0
- * @param[in] minimum Minimum touches required.
+ * @param[in] minimum Minimum touches required
* @pre The gesture detector has been initialized.
* @note The default minimum is '1'.
*/
* @brief This is the maximum number of touches required for the pan gesture to be detected.
*
* @SINCE_1_0.0
- * @param[in] maximum Maximum touches required.
+ * @param[in] maximum Maximum touches required
* @pre The gesture detector has been initialized.
* @note The default maximum is '1'.
*/
* @brief Retrieves the minimum number of touches required for the pan gesture to be detected.
*
* @SINCE_1_0.0
- * @return The minimum touches required.
+ * @return The minimum touches required
* @pre The gesture detector has been initialized.
*/
unsigned int GetMinimumTouchesRequired() const;
* @brief Retrieves the maximum number of touches required for the pan gesture to be detected.
*
* @SINCE_1_0.0
- * @return The maximum touches required.
+ * @return The maximum touches required
* @pre The gesture detector has been initialized.
*/
unsigned int GetMaximumTouchesRequired() const;
* direction range is from -45 to 45 degrees.
*
* @SINCE_1_0.0
- * @param[in] angle The angle that pan should be allowed.
- * @param[in] threshold The threshold around that angle.
+ * @param[in] angle The angle that pan should be allowed
+ * @param[in] threshold The threshold around that angle
*
* @pre The gesture detector has been initialized.
* @note The angle added using this API is only checked when the gesture first starts, after that,
* right scrolling.
*
* @SINCE_1_0.0
- * @param[in] direction The direction of panning required.
- * @param[in] threshold The threshold.
+ * @param[in] direction The direction of panning required
+ * @param[in] threshold The threshold
*
* @pre The gesture detector has been initialized.
*
* @brief Returns the count of angles that this pan gesture detector emits a signal.
*
* @SINCE_1_0.0
- * @return The count.
+ * @return The count
* @pre The gesture detector has been initialized.
*/
size_t GetAngleCount() const;
*
* @SINCE_1_0.0
* @param[in] index The angle's index
- * @return An angle threshold pair, or a zero valued angle pair when index is invalid.
+ * @return An angle threshold pair, or a zero valued angle pair when index is invalid
* @pre The gesture detector has been initialized.
* @pre The index is less than GetAngleCount()
*/
* @brief Removes the angle specified from the container.
*
* @SINCE_1_0.0
- * @param[in] angle The angle to remove.
+ * @param[in] angle The angle to remove
* @pre The gesture detector has been initialized.
* @note This will only remove the first instance of the angle found from the container.
* @note If an angle outside the range in AddAngle() is given, then the value is wrapped within
* @brief Removes the two angles that make up the direction from the container.
*
* @SINCE_1_0.0
- * @param[in] direction The direction to remove.
+ * @param[in] direction The direction to remove
* @pre The gesture detector has been initialized.
* @note If a direction outside the range in AddAngle() is given, then the value is wrapped within
* the range and that is removed.
* void YourCallbackName( Actor actor, const PanGesture& gesture );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The gesture detector has been initialized.
*/
DetectedSignalType& DetectedSignal();
* @brief Allows setting of the pan properties that are returned in constraints.
*
* @SINCE_1_0.0
- * @param[in] pan The pan gesture to set.
+ * @param[in] pan The pan gesture to set
* @note If a normal pan is taking place, then any value set is ignored.
*/
static void SetPanGestureProperties( const PanGesture& pan );
* @brief This constructor is used by PanGestureDetector::New() methods.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param[in] internal A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL PanGestureDetector(Internal::PanGestureDetector* internal);
/// @endcond
*
* This is the pixel movement per millisecond.
* @SINCE_1_0.0
- * @return The speed of the pan (in pixels per millisecond).
+ * @return The speed of the pan (in pixels per millisecond)
*/
float GetSpeed() const;
*
* This is always a positive value.
* @SINCE_1_0.0
- * @return The distance, as a float, a user's finger has panned.
+ * @return The distance, as a float, a user's finger has panned
*/
float GetDistance() const;
*
* This is the pixel movement per millisecond.
* @SINCE_1_0.0
- * @return The speed of the pan (in pixels per millisecond).
+ * @return The speed of the pan (in pixels per millisecond)
*/
float GetScreenSpeed() const;
*
* This is always a positive value.
* @SINCE_1_0.0
- * @return The distance, as a float, a user's finger has panned.
+ * @return The distance, as a float, a user's finger has panned
*/
float GetScreenDistance() const;
};
public: // Creation & Destruction
/**
- * @brief Create an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
+ * @brief Creates an uninitialized PinchGestureDetector; this can be initialized with PinchGestureDetector::New().
*
* Calling member functions with an uninitialized PinchGestureDetector handle is not allowed.
* @SINCE_1_0.0
PinchGestureDetector();
/**
- * @brief Create an initialized PinchGestureDetector.
+ * @brief Creates an initialized PinchGestureDetector.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static PinchGestureDetector New();
/**
- * @brief Downcast a handle to PinchGestureDetector handle.
+ * @brief Downcasts a handle to PinchGestureDetector handle.
*
- * If handle points to a PinchGestureDetector object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a PinchGestureDetector object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a PinchGestureDetector object or an uninitialized handle
static PinchGestureDetector DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
PinchGestureDetector(const PinchGestureDetector& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
PinchGestureDetector& operator=(const PinchGestureDetector& rhs);
* void YourCallbackName( Actor actor, const PinchGesture& gesture );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The gesture detector has been initialized.
*/
DetectedSignalType& DetectedSignal();
* @brief This constructor is used by PinchGestureDetector::New() methods.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param[in] internal A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL PinchGestureDetector(Internal::PinchGestureDetector* internal);
/// @endcond
*
* This gesture can be in one of three states; when the pinch gesture is first detected, its
* state is set to Gesture::Started. After this, if there is change in the gesture, the state will
- * be Gesture::Continuing. Finally, when the gesture ends, the state of the gesture changes to
+ * be Gesture::Continuing. Finally, when the gesture ends, the state of the gesture changes to
* Gesture::Finished.
*
* A pinch gesture will continue to be sent to the actor under the center point of the pinch
{
/**
- * @brief Point state type
+ * @brief Enumeration for point state type.
* @SINCE_1_1.37
*/
enum Type
UP = FINISHED, /**< Touch stopped */
MOTION, /**< Finger dragged or hovered */
LEAVE, /**< Leave the boundary of an actor */
- STATIONARY, /**< No change from last event. Useful when a multi-point event occurs where
+ STATIONARY, /**< No change from last event. Useful when a multi-point event occurs where
all points are sent but indicates that this particular point has not changed
since the last time */
INTERRUPTED, /**< A system event has occurred which has interrupted the touch or hover event sequence. */
public: // Creation & Destruction
/**
- * @brief Create an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
+ * @brief Creates an uninitialized TapGestureDetector; this can be initialized with TapGestureDetector::New().
*
* Calling member functions with an uninitialized TapGestureDetector handle is not allowed.
* @SINCE_1_0.0
TapGestureDetector();
/**
- * @brief Create an initialized TapGestureDetector.
+ * @brief Creates an initialized TapGestureDetector.
*
* By default, this would create a gesture detector which requires one tap with one touch.
* @SINCE_1_0.0
- * @return A handle to a newly allocated Dali resource.
+ * @return A handle to a newly allocated Dali resource
*/
static TapGestureDetector New();
/**
- * @brief Create an initialized TapGestureDetector with the specified parameters.
+ * @brief Creates an initialized TapGestureDetector with the specified parameters.
*
* @SINCE_1_0.0
- * @param[in] tapsRequired The minimum & maximum number of taps required.
- * @return A handle to a newly allocated Dali resource.
+ * @param[in] tapsRequired The minimum & maximum number of taps required
+ * @return A handle to a newly allocated Dali resource
*/
static TapGestureDetector New( unsigned int tapsRequired );
/**
- * @brief Downcast a handle to TapGestureDetector handle.
+ * @brief Downcasts a handle to TapGestureDetector handle.
*
- * If handle points to a TapGestureDetector object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a TapGestureDetector object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a TapGestureDetector object or an uninitialized handle
static TapGestureDetector DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
TapGestureDetector(const TapGestureDetector& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
TapGestureDetector& operator=(const TapGestureDetector& rhs);
public: // Setters
/**
- * @brief Set the minimum number of taps required.
+ * @brief Sets the minimum number of taps required.
*
* The tap count is the number of times a user should "tap" the screen.
* @SINCE_1_0.0
- * @param[in] minimumTaps The minimum taps required.
+ * @param[in] minimumTaps The minimum taps required
* @pre The gesture detector has been initialized.
* @note The default is '1'.
*/
void SetMinimumTapsRequired( unsigned int minimumTaps );
/**
- * @brief Set the maximum number of taps required.
+ * @brief Sets the maximum number of taps required.
*
* The tap count is the number of times a user should "tap" the screen.
* @SINCE_1_0.0
- * @param[in] maximumTaps The maximum taps required.
+ * @param[in] maximumTaps The maximum taps required
* @pre The gesture detector has been initialized.
* @note The default is '1'.
*/
* @brief Retrieves the minimum number of taps required.
*
* @SINCE_1_0.0
- * @return The minimum taps required.
+ * @return The minimum taps required
* @pre The gesture detector has been initialized.
*/
unsigned int GetMinimumTapsRequired() const;
* @brief Retrieves the maximum number of taps required.
*
* @SINCE_1_0.0
- * @return The maximum taps required.
+ * @return The maximum taps required
* @pre The gesture detector has been initialized.
*/
unsigned int GetMaximumTapsRequired() const;
* void YourCallbackName( Actor actor, const TapGesture& gesture );
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The gesture detector has been initialized.
*/
DetectedSignalType& DetectedSignal();
* @brief This constructor is used by TapGestureDetector::New() methods.
*
* @SINCE_1_0.0
- * @param [in] internal A pointer to a newly allocated Dali resource.
+ * @param[in] internal A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL TapGestureDetector(Internal::TapGestureDetector* internal);
/// @endcond
// Construction & Destruction
/**
- * @brief Default Constructor
+ * @brief Default Constructor.
* @SINCE_1_0.0
*/
TapGesture();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
* @SINCE_1_0.0
- * @param[in] rhs A reference to the copied handle
+ * @param rhs A reference to the copied handle
*/
TapGesture( const TapGesture& rhs );
/**
- * @brief Assignment operator
+ * @brief Assignment operator.
* @SINCE_1_0.0
- * @param[in] rhs A reference to the copied handle
+ * @param rhs A reference to the copied handle
* @return A reference to this
*/
TapGesture& operator=( const TapGesture& rhs );
/**
- * @brief Virtual destructor
+ * @brief Virtual destructor.
* @SINCE_1_0.0
*/
virtual ~TapGesture();
* @brief This is the point, in local actor coordinates, where the tap occurred.
*
* If a multi-touch tap, then this is the centroid of all the touch points.
- * @return The point where tap has occurred (in local actor coordinates).
+ * @return The point where tap has occurred (in local actor coordinates)
*/
Vector2 localPoint;
};
TouchData();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_1.37
- * @param[in] other The TouchData to copy from.
+ * @param[in] other The TouchData to copy from
*/
TouchData( const TouchData& other );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.37
*/
// Operators
/**
- * @brief Assignment Operator
+ * @brief Assignment Operator.
*
* @SINCE_1_1.37
- * @param[in] other The TouchData to copy from.
+ * @param[in] other The TouchData to copy from
* @return A reference to this
*/
TouchData& operator=( const TouchData& other );
* @brief Returns the time (in ms) that the touch event occurred.
*
* @SINCE_1_1.37
- * @return The time (in ms) that the touch event occurred.
+ * @return The time (in ms) that the touch event occurred
*/
unsigned long GetTime() const;
* @brief Returns the total number of points in this TouchData.
*
* @SINCE_1_1.37
- * @return Total number of Points.
+ * @return Total number of Points
*/
std::size_t GetPointCount() const;
* point. This is returned by this method.
*
* @SINCE_1_1.37
- * @param[in] point The point required.
- * @return The Device ID of this point.
+ * @param[in] point The point required
+ * @return The Device ID of this point
* @note If point is greater than GetPointCount() then this method will return -1.
*/
int32_t GetDeviceId( std::size_t point ) const;
* @brief Retrieves the State of the point specified.
*
* @SINCE_1_1.37
- * @param[in] point The point required.
- * @return The state of the point specified.
+ * @param[in] point The point required
+ * @return The state of the point specified
* @note If point is greater than GetPointCount() then this method will return PointState::FINISHED.
* @see State
*/
PointState::Type GetState( std::size_t point ) const;
/**
- * @brief Retrieve the actor that was underneath the point specified.
+ * @brief Retrieves the actor that was underneath the point specified.
*
* @SINCE_1_1.37
- * @param[in] point The point required.
- * @return The actor that was underneath the point specified.
+ * @param[in] point The point required
+ * @return The actor that was underneath the point specified
* @note If point is greater than GetPointCount() then this method will return an empty handle.
*/
Actor GetHitActor( std::size_t point ) const;
/**
- * @brief Retrieve the co-ordinates relative to the top-left of the hit-actor at the point specified.
+ * @brief Retrieves the co-ordinates relative to the top-left of the hit-actor at the point specified.
*
* @SINCE_1_1.37
- * @param[in] point The point required.
- * @return The co-ordinates relative to the top-left of the hit-actor of the point specified.
+ * @param[in] point The point required
+ * @return The co-ordinates relative to the top-left of the hit-actor of the point specified
*
* @note The top-left of an actor is (0.0, 0.0, 0.5).
* @note If you require the local coordinates of another actor (e.g the parent of the hit actor),
* @brief Retrieves the co-ordinates relative to the top-left of the screen of the point specified.
*
* @SINCE_1_1.37
- * @param[in] point The point required.
- * @return The co-ordinates relative to the top-left of the screen of the point specified.
+ * @param[in] point The point required
+ * @return The co-ordinates relative to the top-left of the screen of the point specified
* @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
*/
const Vector2& GetScreenPosition( std::size_t point ) const;
/**
- * @brief Retrieve the radius of the press point.
+ * @brief Retrieves the radius of the press point.
*
* This is the average of both the horizontal and vertical radii of the press point.
*
* @SINCE_1_1.39
- * @param[in] point The point required.
- * @return The radius of the press point.
+ * @param[in] point The point required
+ * @return The radius of the press point
* @note If point is greater than GetPointCount() then this method will return 0.0f.
*/
float GetRadius( std::size_t point ) const;
/**
- * @brief Retrieve BOTH the horizontal and the vertical radii of the press point.
+ * @brief Retrieves BOTH the horizontal and the vertical radii of the press point.
*
* @SINCE_1_1.39
- * @param[in] point The point required.
- * @return The horizontal and vertical radii of the press point.
+ * @param[in] point The point required
+ * @return The horizontal and vertical radii of the press point
* @note If point is greater than GetPointCount() then this method will return Vector2::ZERO.
*/
const Vector2& GetEllipseRadius( std::size_t point ) const;
/**
- * @brief Retrieve the touch pressure.
+ * @brief Retrieves the touch pressure.
*
* The pressure range starts at 0.0f.
* Normal pressure is defined as 1.0f.
* A value greater than 1.0f means more pressure than normal has been applied.
*
* @SINCE_1_1.39
- * @param[in] point The point required.
- * @return The touch pressure.
+ * @param[in] point The point required
+ * @return The touch pressure
* @note If point is greater than GetPointCount() then this method will return 1.0f.
*/
float GetPressure( std::size_t point ) const;
/**
- * @brief Retrieve the angle of the press point relative to the Y-Axis.
+ * @brief Retrieves the angle of the press point relative to the Y-Axis.
*
* @SINCE_1_1.39
- * @param[in] point The point required.
- * @return The angle of the press point.
+ * @param[in] point The point required
+ * @return The angle of the press point
* @note If point is greater than GetPointCount() then this method will return Degree().
*/
Degree GetAngle( std::size_t point ) const;
* @brief This constructor is used internally to Create an initialized TouchData handle.
*
* @SINCE_1_1.37
- * @param [in] touchData A pointer to a newly allocated Dali resource
+ * @param[in] touchData A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL TouchData( Internal::TouchData* touchData );
/// @endcond
/**
* @DEPRECATED_1_1.37
- * @brief Default constructor
+ * @brief Default constructor.
* @SINCE_1_0.0
*/
TouchEvent() DALI_DEPRECATED_API;
/**
* @DEPRECATED_1_1.37
- * @brief Constructor
+ * @brief Constructor.
* @SINCE_1_0.0
* @param[in] time The time the event occurred
*/
/**
* @DEPRECATED_1_1.37
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_0.0
*/
~TouchEvent() DALI_DEPRECATED_API;
* @brief Returns the total number of points in this TouchEvent.
*
* @SINCE_1_0.0
- * @return Total number of Points.
+ * @return Total number of Points
*/
unsigned int GetPointCount() const DALI_DEPRECATED_API;
* The first point in the set is always the primary
* touch point (i.e. the first point touched in a multi-touch event).
* @SINCE_1_0.0
- * @param[in] point The index of the required Point.
+ * @param[in] point The index of the required Point
* @return Point requested
* @note "point" should be less than the value returned by GetPointCount().
* If out of range, then program asserts.
// Enumerations
/**
- * @brief Touch state
+ * @brief Enumeration for Touch state.
* @SINCE_1_0.0
*/
enum State
// Construction & Destruction
/**
- * @brief Constructor
+ * @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] id The touch device ID.
- * @param[in] state The state.
- * @param[in] screenX The X co-ordinate relative to the screen's origin.
- * @param[in] screenY The Y co-ordinate relative to the screen's origin.
+ * @param[in] id The touch device ID
+ * @param[in] state The state
+ * @param[in] screenX The X co-ordinate relative to the screen's origin
+ * @param[in] screenY The Y co-ordinate relative to the screen's origin
*/
TouchPoint(int id, State state, float screenX, float screenY);
/**
- * @brief Constructor
+ * @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] id The touch device ID.
- * @param[in] state The state.
- * @param[in] screenX The X co-ordinate relative to the screen's origin.
- * @param[in] screenY The Y co-ordinate relative to the screen's origin.
- * @param[in] localX The X co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
- * @param[in] localY The Y co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor.
+ * @param[in] id The touch device ID
+ * @param[in] state The state
+ * @param[in] screenX The X co-ordinate relative to the screen's origin
+ * @param[in] screenY The Y co-ordinate relative to the screen's origin
+ * @param[in] localX The X co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor
+ * @param[in] localY The Y co-ordinate relative to the top-left (0.0, 0.0, 0.5) of the actor
*/
TouchPoint(int id, State state, float screenX, float screenY, float localX, float localY);
/**
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_0.0
*/
~TouchPoint();
// Enumerations
/**
- * @brief Specifies the type of the wheel event.
+ * @brief Enumeration for specifying the type of the wheel event.
* @SINCE_1_0.0
*/
enum Type
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] type The type of the wheel event
- * @param[in] direction The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
- * @param[in] modifiers Modifier keys pressed during the event (such as shift, alt and control)
- * @param[in] point The co-ordinates of the cursor relative to the top-left of the screen.
- * @param[in] z The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
- * @param[in] timeStamp The time the wheel is being rolled.
+ * @param[in] type The type of the wheel event
+ * @param[in] direction The direction of wheel rolling (0 = default vertical wheel, 1 = horizontal wheel)
+ * @param[in] modifiers Modifier keys pressed during the event (such as shift, alt and control)
+ * @param[in] point The co-ordinates of the cursor relative to the top-left of the screen
+ * @param[in] z The offset of rolling (positive value means roll down or clockwise, and negative value means roll up or counter-clockwise)
+ * @param[in] timeStamp The time the wheel is being rolled
*/
WheelEvent( Type type, int direction, unsigned int modifiers, Vector2 point, int z, unsigned int timeStamp );
~WheelEvent();
/**
- * @brief Check to see if Shift key modifier has been supplied.
+ * @brief Checks to see if Shift key modifier has been supplied.
*
* @SINCE_1_0.0
* @return True if shift modifier
bool IsShiftModifier() const;
/**
- * @brief Check to see if Ctrl (control) key modifier has been supplied.
+ * @brief Checks to see if Ctrl (control) key modifier has been supplied.
*
* @SINCE_1_0.0
* @return True if ctrl modifier
bool IsCtrlModifier() const;
/**
- * @brief Check to see if Alt key modifier has been supplied.
+ * @brief Checks to see if Alt key modifier has been supplied.
*
* @SINCE_1_0.0
* @return True if alt modifier
// Data
/**
- * @brief Type of the event
+ * @brief Type of the event.
*
* @see Type
*/
/**
* @brief The direction in which the wheel is being rolled.
*
- * 0 means the default vertical wheel, and 1 means horizontal wheel
+ * 0 means the default vertical wheel, and 1 means horizontal wheel.
*/
int direction;
/**
* @brief Constructor which creates an uninitialized BufferImage object.
*
- * Use BufferImage::New(...) to create an initialised object.
+ * Use BufferImage::New(...) to create an initialized object.
* @SINCE_1_0.0
*/
BufferImage();
/**
- * @brief Create a new BufferImage.
+ * @brief Creates a new BufferImage.
*
* Also a pixel buffer for image data is allocated.
* Dali has ownership of the buffer.
* For better performance and portability use power of two dimensions.
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
* @SINCE_1_0.0
- * @param [in] width Image width in pixels
- * @param [in] height Image height in pixels
- * @param [in] pixelformat The pixel format (rgba 32 bit by default)
+ * @param[in] width Image width in pixels
+ * @param[in] height Image height in pixels
+ * @param[in] pixelformat The pixel format (rgba 32 bit by default)
* @return A handle to a new instance of BufferImage
* @pre width & height are greater than zero
* @note default resource management policies are Immediate and Never
Pixel::Format pixelformat=Pixel::RGBA8888);
/**
- * @brief Create a new BufferImage, which uses an external data source.
+ * @brief Creates a new BufferImage, which uses an external data source.
*
* The PixelBuffer has to be allocated by application.
*
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
*
* @SINCE_1_0.0
- * @param [in] pixelBuffer Pixel buffer. has to be allocated by application.
- * @param [in] width Image width in pixels
- * @param [in] height Image height in pixels
- * @param [in] pixelFormat The pixel format (rgba 32 bit by default)
- * @param [in] stride The internal stride of the pixelbuffer in pixels
+ * @param[in] pixelBuffer Pixel buffer has to be allocated by application
+ * @param[in] width Image width in pixels
+ * @param[in] height Image height in pixels
+ * @param[in] pixelFormat The pixel format (rgba 32 bit by default)
+ * @param[in] stride The internal stride of the pixelbuffer in pixels
* @return A handle to a new instance of BufferImage
* @pre width & height are greater than zero
*/
unsigned int stride=0);
/**
- * @brief Downcast a handle to BufferImage handle.
+ * @brief Downcasts a handle to BufferImage handle.
*
- * If handle points to a BufferImage the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * If the handle points to a BufferImage, the downcast produces valid handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_0.0
* @param[in] handle Handle to an object
static BufferImage DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
BufferImage(const BufferImage& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
BufferImage& operator=(const BufferImage& rhs);
/**
* @copydoc Update()
- * @param [in] updateArea Area that has changed in buffer
+ * @param[in] updateArea Area that has changed in buffer
*/
void Update( RectArea updateArea );
* if it has called Update() and hasn't received a Image::UploadedSignal.
*
* @SINCE_1_0.0
- * @return true if application owns data, false otherwise
+ * @return @c true if application owns data, @c false otherwise
*/
bool IsDataExternal() const;
EncodedBufferImage();
/**
- * @brief Create an initialised image object from an encoded image buffer in memory.
+ * @brief Creates an initialized image object from an encoded image buffer in memory.
*
* @SINCE_1_0.0
- * @param [in] encodedImage The encoded bytes of an image, in a supported
+ * @param[in] encodedImage The encoded bytes of an image, in a supported
* image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
* exactly as it would be as a file in the filesystem.
* The caller retains ownership of this buffer and is free to modify or
- * discard it as soon as the function returns.
- * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
+ * discard it as soon as the function returns
+ * @param[in] encodedImageByteCount The size in bytes of the buffer pointed to
* by encodedImage.
- * @return A handle to a newly allocated object.
+ * @return A handle to a newly allocated object
*/
static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount );
/**
- * @brief Create an initialised image object from an encoded image buffer in memory.
+ * @brief Creates an initialized image object from an encoded image buffer in memory.
*
* @SINCE_1_1.4
- * @param [in] encodedImage The encoded bytes of an image, in a supported
+ * @param[in] encodedImage The encoded bytes of an image, in a supported
* image format such as PNG, JPEG, GIF, BMP, KTX, ICO, and WBMP, organised
* exactly as it would be as a file in the filesystem.
* The caller retains ownership of this buffer and is free to modify or
- * discard it as soon as the function returns.
- * @param [in] encodedImageByteCount The size in bytes of the buffer pointed to
- * by encodedImage.
- * @param [in] size The width and height to fit the loaded image to.
- * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
+ * discard it as soon as the function returns
+ * @param[in] encodedImageByteCount The size in bytes of the buffer pointed to
+ * by encodedImage
+ * @param[in] size The width and height to fit the loaded image to
+ * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
+ * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
* policy is set, a reload will not be possible, so the Image should never be
- * used once all actors using it have gone off-stage.
- * @return A handle to a newly allocated object.
+ * used once all actors using it have gone off-stage
+ * @return A handle to a newly allocated object
*/
static EncodedBufferImage New( const uint8_t * const encodedImage, std::size_t encodedImageByteCount, ImageDimensions size, FittingMode::Type fittingMode, SamplingMode::Type samplingMode, bool orientationCorrection = true );
/**
- * @brief Downcast a handle to EncodedBufferImage handle.
+ * @brief Downcasts a handle to EncodedBufferImage handle.
*
- * If handle points to a EncodedBufferImage the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a EncodedBufferImage, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a EncodedBufferImage or an uninitialized handle
static EncodedBufferImage DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
EncodedBufferImage(const EncodedBufferImage& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
EncodedBufferImage& operator=(const EncodedBufferImage& rhs);
namespace RenderBuffer
{
/**
- * @brief Render Buffer formats
+ * @brief Enumeration for rendering buffer formats.
*
* The default format for framebuffer creation is COLOR, so If a depth buffer for 3D rendering is required use
- * COLOR_DEPTH instead
+ * COLOR_DEPTH instead.
* @SINCE_1_0.0
*/
enum Format ///< Framebuffer format, default color depth is RGBA 32 bit with alpha @SINCE_1_0.0
/**
* @brief Constructor which creates an uninitialized FrameBufferImage object.
*
- * Use @ref FrameBufferImage::New to create an initialised object.
+ * Use @ref FrameBufferImage::New to create an initialized object.
* @SINCE_1_0.0
*/
FrameBufferImage();
/**
- * @brief Create a new FrameBufferImage.
+ * @brief Creates a new FrameBufferImage.
*
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
*
* @SINCE_1_0.0
- * @param [in] width The width in pixels. Setting to zero will use the width of the stage.
- * @param [in] height The height in pixels. Setting to zero will use the height of the stage.
- * @param [in] pixelFormat The pixel format (rgba 32 bit by default)
- * @param [in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
- * @return A handle to a new instance of a FrameBufferImage.
+ * @param[in] width The width in pixels. Setting to zero will use the width of the stage
+ * @param[in] height The height in pixels. Setting to zero will use the height of the stage
+ * @param[in] pixelFormat The pixel format (rgba 32 bit by default)
+ * @param[in] bufferFormat The format of the buffers that are going to be created for the FBO, (COLOR and DEPTH buffer as default)
+ * @return A handle to a new instance of a FrameBufferImage
* @post When the FrameBufferImage is first used as a render target, an exception may be thrown if pixelFormat is not supported on the hardware platform.
*/
static FrameBufferImage New(unsigned int width = 0, unsigned int height = 0, Pixel::Format pixelFormat = Pixel::RGBA8888,
RenderBuffer::Format bufferFormat = RenderBuffer::COLOR);
/**
- * @brief Create a new FrameBufferImage.
+ * @brief Creates a new FrameBufferImage.
*
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE.
* @SINCE_1_0.0
- * @param [in] image The native image.
+ * @param[in] image The native image
*
- * @return A handle to a new instance of a FrameBufferImage.
+ * @return A handle to a new instance of a FrameBufferImage
* @post When the FrameBufferImage is first used as a render target, an exception may be thrown if the NativeImage cannot be mapped to a texture.
*/
static FrameBufferImage New(NativeImageInterface& image);
/**
- * @brief Downcast a handle to FrameBufferImage handle.
+ * @brief Downcasts a handle to FrameBufferImage handle.
*
- * If handle points to a FrameBufferImage object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a FrameBufferImage object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a FrameBufferImage object or an uninitialized handle
static FrameBufferImage DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
FrameBufferImage(const FrameBufferImage& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
FrameBufferImage& operator=(const FrameBufferImage& rhs);
namespace FittingMode
{
/**
- * @brief The type of FittingMode
+ * @brief Enumeration for FittingMode type.
* @SINCE_1_0.0
*/
enum Type
namespace SamplingMode
{
/**
- * @brief The type of SamplingMode
+ * @brief Enumeration for SamplingMode type.
* @SINCE_1_0.0
*/
enum Type
* This class has no New method.
* Use the appropriate New method of its subclasses to create an initialized handle.
* (Dali::BufferImage::New(), Dali::EncodedBufferImage::New(), Dali::FrameBufferImage::New(),
- * Dali::NativeImage::New(), Dali::ResourceImage::New())
+ * Dali::NativeImage::New(), Dali::ResourceImage::New()).
* @SINCE_1_0.0
*/
Image();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
Image(const Image& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Image& operator=(const Image& rhs);
/**
- * @brief Downcast a handle to Image handle.
+ * @brief Downcasts a handle to Image handle.
*
- * If handle points to a Image object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a Image object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a Image object or an uninitialized handle
* Returns either the requested width or the actual loaded width if no specific size was requested.
*
* @SINCE_1_0.0
- * @return Width of the image in pixels.
+ * @return Width of the image in pixels
*/
unsigned int GetWidth() const;
* Returns either the requested height or the actual loaded height if no specific size was requested.
*
* @SINCE_1_0.0
- * @return Height of the image in pixels.
+ * @return Height of the image in pixels
*/
unsigned int GetHeight() const;
* the stage, when such a staged image is reloaded, or when a staged
* BufferImage calls Update().
* @SINCE_1_0.0
- * @return A signal object to Connect() with.
+ * @return A signal object to Connect() with
*/
ImageSignalType& UploadedSignal();
class Extension; ///< Forward declare future extension interface
/**
- * @brief Create the GL resource for the NativeImage.
+ * @brief Creates the GL resource for the NativeImage.
*
- * e.g. For the EglImageKHR extension, this corresponds to calling eglCreateImageKHR()
+ * e.g. For the EglImageKHR extension, this corresponds to calling eglCreateImageKHR().
* @SINCE_1_0.0
- * @return false If the initialization fails.
+ * @return false If the initialization fails
* @pre There is a GL context for the current thread.
*/
virtual bool GlExtensionCreate() = 0;
/**
- * @brief Destroy the GL resource for the NativeImage.
+ * @brief Destroys the GL resource for the NativeImage.
*
- * e.g. For the EglImageKHR extension, this corresponds to calling eglDestroyImageKHR()
+ * e.g. For the EglImageKHR extension, this corresponds to calling eglDestroyImageKHR().
* @SINCE_1_0.0
* @pre There is a GL context for the current thread.
*/
virtual void GlExtensionDestroy() = 0;
/**
- * @brief Use the NativeImage as a texture for rendering.
+ * @brief Uses the NativeImage as a texture for rendering.
*
* @SINCE_1_0.0
* @return A GL error code
virtual unsigned int GetHeight() const = 0;
/**
- * @brief Query whether blending is required
+ * @brief Queries whether blending is required.
* @SINCE_1_0.0
- * @return true if blending is required
+ * @return True if blending is required
*/
virtual bool RequiresBlending() const = 0;
/**
- * @brief Retrieve the extension for the interface.
+ * @brief Retrieves the extension for the interface.
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
};
/**
- * @brief Pointer to Dali::NativeImageInterface
+ * @brief Pointer to Dali::NativeImageInterface.
* @SINCE_1_0.0
*/
typedef Dali::IntrusivePtr<NativeImageInterface> NativeImageInterfacePtr;
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
NativeImage( const NativeImage& handle );
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param[in] rhs A reference to the copied handle.
- * @return A reference to this.
+ * @param[in] rhs A reference to the copied handle
+ * @return A reference to this
*/
NativeImage& operator=( const NativeImage& rhs );
/**
- * @brief Trigger asynchronous creation of backing GL texture immediately.
+ * @brief Triggers asynchronous creation of backing GL texture immediately.
*
* The normal policy is for a GL texture to created lazily when needed.
* This function forces the allocation of a texture to happen at the earliest
void CreateGlTexture();
/**
- * @brief Create a new NativeImage, which used native resources.
+ * @brief Creates a new NativeImage, which used native resources.
*
* The maximum size of the image is limited by GL_MAX_TEXTURE_SIZE
* @SINCE_1_0.0
- * @param [in] nativeImageInterface An reference to the object of the interface implementation.
- * @return A handle to a newly allocated object.
+ * @param[in] nativeImageInterface An reference to the object of the interface implementation
+ * @return A handle to a newly allocated object
*/
static NativeImage New( NativeImageInterface& nativeImageInterface );
/**
- * @brief Downcast a handle to NativeImage handle.
+ * @brief Downcasts a handle to NativeImage handle.
*
* If handle points to a NativeImage object, the downcast produces valid handle.
- * If not, the returned handle is left unintialized.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle Handle to an object.
- * @return handle to a NativeImage or an uninitialized handle.
+ * @param[in] handle Handle to an object
+ * @return handle to a NativeImage or an uninitialized handle
*/
static NativeImage DownCast( BaseHandle handle );
/**
- * @brief Get custom fragment prefix for rendering a native image.
+ * @brief Gets custom fragment prefix for rendering a native image.
*
* @return String for custom fragment prefix
*/
const char* GetCustomFragmentPreFix();
/**
- * @brief Get custom sampler type name for rendering a native image.
+ * @brief Gets custom sampler type name for rendering a native image.
*
* @return String for custom sampler type name
*/
public:
/**
- * @brief Function to release the pixel buffer
+ * @brief Enumeration for Function to release the pixel buffer.
* @SINCE_1_1.43
*/
enum ReleaseFunction
};
/**
- * @brief Create a PixelData object.
+ * @brief Creates a PixelData object.
*
* @SINCE_1_1.43
- * @param[in] buffer The raw pixel data.
- * @param[in] bufferSize The size of the buffer in bytes
- * @param[in] width Buffer width in pixels
- * @param[in] height Buffer height in pixels
- * @param[in] pixelFormat The pixel format
- * @param[in] releaseFunction The function used to release the memory.
+ * @param[in] buffer The raw pixel data
+ * @param[in] bufferSize The size of the buffer in bytes
+ * @param[in] width Buffer width in pixels
+ * @param[in] height Buffer height in pixels
+ * @param[in] pixelFormat The pixel format
+ * @param[in] releaseFunction The function used to release the memory
* @return A handle to the PixelData
*/
static PixelData New( unsigned char* buffer,
ReleaseFunction releaseFunction);
/**
- * @brief Create an empty handle.
+ * @brief Creates an empty handle.
* Use PixelData::New() to create an initialized object.
*
* @SINCE_1_1.43
PixelData& operator=(const PixelData& rhs);
/**
- * @brief Get the width of the buffer in pixels.
+ * @brief Gets the width of the buffer in pixels.
*
* @SINCE_1_1.43
* @return The width of the buffer in pixels
unsigned int GetWidth() const;
/**
- * @brief Get the height of the buffer in pixels.
+ * @brief Gets the height of the buffer in pixels.
*
* @SINCE_1_1.43
* @return The height of the buffer in pixels
unsigned int GetHeight() const;
/**
- * @brief Get the pixel format.
+ * @brief Gets the pixel format.
*
* @SINCE_1_1.43
* @return The pixel format
public:
/**
- * @brief The constructor
+ * @brief The constructor.
* @note Not intended for application developers.
* @SINCE_1_1.43
* @param[in] pointer A pointer to a newly allocated PixelData
namespace Pixel
{
/**
- * @brief Pixel formats
+ * @brief Enumeration for Pixel formats.
*
- * Pixel format, default color depth is RGBA 32 bit with alpha
+ * Pixel format, default color depth is RGBA 32 bit with alpha.
* @SINCE_1_0.0
* @note BufferImage::Update might not work with BGR/BGRA formats!
*/
* @brief Whether specified pixel format contains an alpha value.
*
* @SINCE_1_0.0
- * @param [in] pixelformat Pixel format
- * @return true if format has alpha, false otherwise
+ * @param[in] pixelformat Pixel format
+ * @return @c true if format has alpha, @c false otherwise
*/
DALI_IMPORT_API bool HasAlpha(Format pixelformat);
* @brief Returns The number of bytes per pixel for the specified pixel format.
*
* @SINCE_1_0.0
- * @param [in] pixelFormat The pixel format
+ * @param[in] pixelFormat The pixel format
* @return The number of bytes per pixel
*/
DALI_IMPORT_API unsigned int GetBytesPerPixel(Format pixelFormat);
* For example, in case of Pixel::RGBA4444, byteOffset value is 1 and bitMask value is 0x0f.
* It means the second byte contains the alpha value and the last 4 bits of the byte is the alpha value.
*
- * Bitmask is zero if the pixelFormat does not support alpha
+ * Bitmask is zero if the pixelFormat does not support alpha.
* @SINCE_1_0.0
* @param[in] pixelFormat The pixel format
* @param[out] byteOffset The byte offset of the byte containing the alpha value
}
/**
- * @brief ResourceImage is an image loaded using a URL
+ * @brief ResourceImage is an image loaded using a URL.
*
* <i>Customizing load requests</i>
*
public:
/**
- * @brief Get the size of an image from disk.
+ * @brief Gets the size of an image from disk.
*
* This function will read the header info from file on disk and is
* synchronous, so it should not be used repeatedly or in tight
*
* @SINCE_1_0.0
* @REMARK_STORAGE
- * @param [in] url The URL of the image file.
- * @return The width and height in pixels of the image.
+ * @param[in] url The URL of the image file
+ * @return The width and height in pixels of the image
*/
static ImageDimensions GetImageSize( const std::string& url );
ResourceImage();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
ResourceImage( const ResourceImage& handle );
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
ResourceImage& operator=( const ResourceImage& rhs );
/**
* @name ResourceImageFactoryFunctions
- * Create ResourceImage object instances using these functions.
+ * Creates ResourceImage object instances using these functions.
*/
///@{
/**
- * @brief Create an initialised ResourceImage object.
+ * @brief Creates an initialized ResourceImage object.
*
* Uses defaults for all options.
*
* @SINCE_1_0.0
* @REMARK_INTERNET
* @REMARK_STORAGE
- * @param [in] url The URL of the image file to use.
- * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
+ * @param[in] url The URL of the image file to use
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
* @return A handle to a newly allocated object
*/
static ResourceImage New( const std::string& url, bool orientationCorrection = true );
/**
- * @brief Create an initialised ResourceImage object.
+ * @brief Creates an initialized ResourceImage object.
*
* @SINCE_1_0.0
* @REMARK_INTERNET
* @REMARK_STORAGE
- * @param [in] url The URL of the image file to use.
- * @param [in] size The width and height to fit the loaded image to.
- * @param [in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param [in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param [in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
+ * @param[in] url The URL of the image file to use
+ * @param[in] size The width and height to fit the loaded image to
+ * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
+ * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
* @return A handle to a newly allocated object
*/
static ResourceImage New( const std::string& url,
///@}
/**
- * @brief Downcast a handle to ResourceImage handle.
+ * @brief Downcasts a handle to ResourceImage handle.
*
- * If handle points to a ResourceImage object the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a ResourceImage object, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle Handle to an object
* @return Handle to a Image object or an uninitialized handle
static ResourceImage DownCast( BaseHandle handle );
/**
- * @brief Query whether the image data has loaded.
+ * @brief Queries whether the image data has loaded.
*
* The asynchronous loading begins when the Image object is created.
* After the Image object is discarded, the image data will be released from memory.
* @SINCE_1_0.0
- * @return The loading state, either Loading, Success or Failed.
+ * @return The loading state, either Loading, Success or Failed
*/
LoadingState GetLoadingState() const;
* @brief Returns the URL of the image.
*
* @SINCE_1_0.0
- * @return The URL of the image file.
+ * @return The URL of the image file
*/
std::string GetUrl() const;
/**
- * @brief Reload image from filesystem.
+ * @brief Reloads image from filesystem.
*
* The original set of image loading attributes (requested dimensions, scaling
* mode and filter mode) are used when requesting the image again.
* @SINCE_1_0.0
- * @note If image is offstage and OnDemand policy is set, the reload request is
- * ignored.
+ * @note If image is offstage and OnDemand policy is set, the reload request is ignored.
*/
void Reload();
* @brief Emitted when the image data loads successfully, or when the loading fails.
*
* @SINCE_1_0.0
- * @return A signal object to Connect() with.
+ * @return A signal object to Connect() with
*/
ResourceImageSignal& LoadingFinishedSignal();
struct AngleAxis
{
/**
- * @brief Create an angle-axis pair.
+ * @brief Creates an angle-axis pair.
* @SINCE_1_0.0
*/
AngleAxis()
{ }
/**
- * @brief Create an angle-axis pair.
+ * @brief Creates an angle-axis pair.
*
* @SINCE_1_0.0
- * @param[in] initialAngle The initial angle in radians.
- * @param[in] initialAxis The initial axis.
+ * @param[in] initialAngle The initial angle in radians
+ * @param[in] initialAxis The initial axis
*/
AngleAxis( Radian initialAngle, const Vector3& initialAxis )
: angle( initialAngle ),
// Compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
/**
- * @brief Compare two angle axis for equality
+ * @brief Compares two angle axis for equality.
*
* @SINCE_1_0.0
* @param lhs angle axis
}
/**
- * @brief Print an angle axis
+ * @brief Prints an angle axis.
*
* @SINCE_1_1.33
- * @param [in] o The output stream operator.
- * @param [in] angleAxis The angle axis to print
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] angleAxis The angle axis to print
+ * @return The output stream operator
*/
inline std::ostream& operator<< (std::ostream& o, const Dali::AngleAxis& angleAxis)
{
*/
/**
- * @brief Compile time template to calculate base to the power of N.
+ * @brief Compiles time template to calculate base to the power of N.
*
* @SINCE_1_0.0
* @tparam mantissa to raise to exponent
* @tparam exponent to use for mantissa
- * @note values need to be compile time constants
+ * @note Values need to be compile time constants.
* Usage: <code>Power< 10, 2 >::value; // value=100</code>
*/
template< size_t mantissa, size_t exponent >
};
/**
- * @brief Compile time template to calculate base to the power of N.
+ * @brief Compiles time template to calculate base to the power of N.
*
- * Specialisation for power of 1
+ * Specialization for power of 1.
* @SINCE_1_0.0
* @tparam mantissa to raise to exponent
*/
};
/**
- * @brief Compile time template to calculate base to the power of N.
+ * @brief Compiles time template to calculate base to the power of N.
*
- * Specialisation for power of 0
+ * Specialization for power of 0.
* @SINCE_1_0.0
* @tparam mantissa to raise to exponent
*/
};
/**
- * @brief Compile time template to calculate base logarithm of N.
+ * @brief Compiles time template to calculate base logarithm of N.
*
* @SINCE_1_0.0
* @tparam number for which to calculate the logarithm
* @tparam base logarithm to calculate
- * @note values need to be compile time constants
+ * @note Values need to be compile time constants.
* Usage: <code>Log< 100, 10 >::value; value equals 2</code>
*/
template< size_t number, size_t base = 2 >
};
/**
- * @brief Compile time template to calculate base logarithm of N.
+ * @brief Compiles time template to calculate base logarithm of N.
*
- * Specialisation for logarithm of 1
+ * Specialization for logarithm of 1.
* @SINCE_1_0.0
* @tparam base logarithm to calculate
*/
};
/**
- * @brief Compile time template to calculate base logarithm of N.
+ * @brief Compiles time template to calculate base logarithm of N.
*
- * Specialisation for logarithm of 0
+ * Specialization for logarithm of 0.
* @SINCE_1_0.0
* @tparam base logarithm to calculate
*/
/**
- * @brief Compile time template to calculate the machine epsilon for a given floating point number.
+ * @brief Compiles time template to calculate the machine epsilon for a given floating point number.
*
* @SINCE_1_0.0
* @tparam N the number for which to calculate the machine epsilon
- * @note value needs to be compile time constant
+ * @note Value needs to be compile time constant.
* Usage: <code>Epsilon<1000>::value; value equals 0.000119209</code>
*/
template< size_t N >
};
/**
- * @brief Compile time template to calculate the machine epsilon for a given floating point number.
+ * @brief Compiles time template to calculate the machine epsilon for a given floating point number.
*
- * Specialisation for epsilon of 1
+ * Specialization for epsilon of 1.
* @SINCE_1_0.0
*/
template<>
};
/**
- * @brief Compile time template to calculate the machine epsilon for a given floating point number.
+ * @brief Compiles time template to calculate the machine epsilon for a given floating point number.
*
- * Specialisation for epsilon of 0
+ * Specialization for epsilon of 0.
* @SINCE_1_0.0
*/
template<>
struct Degree
{
/**
- * @brief default constructor, initialises to 0.
+ * @brief Default constructor, initialises to 0.
* @SINCE_1_0.0
*/
Degree()
{ }
/**
- * @brief Create an angle in degrees.
+ * @brief Creates an angle in degrees.
*
* @SINCE_1_0.0
- * @param[in] value The initial value in degrees.
+ * @param[in] value The initial value in degrees
*/
explicit Degree( float value )
: degree( value )
{ }
/**
- * @brief Create an angle in degrees from a Radian.
+ * @brief Creates an angle in degrees from a Radian.
*
* @SINCE_1_0.0
- * @param[in] value The initial value in Radians.
+ * @param[in] value The initial value in Radians
*/
DALI_EXPORT_API Degree( Radian value );
DALI_EXPORT_API extern const Radian ANGLE_0; ///< 0 degree turn in radians
/**
- * @brief Compare equality between two degrees.
+ * @brief Compares equality between two degrees.
*
* @SINCE_1_0.0
* @param[in] lhs Degree to compare
* @param[in] rhs Degree to compare to
- * @return true if the values are identical
+ * @return True if the values are identical
*/
inline bool operator==( const Degree& lhs, const Degree& rhs )
{
}
/**
- * @brief Compare inequality between two degrees.
+ * @brief Compares inequality between two degrees.
*
* @SINCE_1_0.0
* @param[in] lhs Degree to compare
* @param[in] rhs Degree to compare to
- * @return true if the values are not identical
+ * @return True if the values are not identical
*/
inline bool operator!=( const Degree& lhs, const Degree& rhs )
{
}
/**
- * @brief Clamp a radian value
+ * @brief Clamps a radian value.
* @SINCE_1_0.0
* @param angle to clamp
* @param min value
* @param max value
- * @return the resulting radian
+ * @return The resulting radian
*/
inline Degree Clamp( Degree angle, float min, float max )
{
* If i is zero returns 1.
* @SINCE_1_0.0
* @param[in] i Input number
- * @return The next power of two or i itself in case it's a power of two
+ * @return The next power of two or i itself in case it's a power of two
*/
inline unsigned int NextPowerOfTwo( unsigned int i )
{
* @brief The Matrix class represents transformations and projections.
*
* It is agnostic w.r.t. row/column major notation - it operates on a flat array.
- * Each axis is contiguous in memory, so the x axis corresponds to elements 0, 1, 2 and 3, the y axis dorresponds to elements 4, 5, 6, 7, etc.
+ * Each axis is contiguous in memory, so the x axis corresponds to elements 0, 1, 2 and 3, the y axis corresponds to elements 4, 5, 6, 7, etc.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API Matrix
/**
* @brief Constructor.
*
- * Zero initialises the matrix
+ * Zero initializes the matrix.
* @SINCE_1_0.0
*/
Matrix();
explicit Matrix( bool initialize );
/**
- * @brief Constructor
+ * @brief Constructor.
*
- * The matrix is initialised with the contents of 'array' which must contain 16 floats.
+ * The matrix is initialized with the contents of 'array' which must contain 16 floats.
* The order of the values for a transform matrix is:
*
* @code
* @endcode
*
* @SINCE_1_0.0
- * @param [in] array Pointer of 16 floats data
+ * @param[in] array Pointer of 16 floats data
*/
explicit Matrix(const float* array);
* @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] matrix A reference to the copied matrix
+ * @param[in] matrix A reference to the copied matrix
*/
Matrix( const Matrix& matrix );
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] matrix A reference to the copied matrix
+ * @param[in] matrix A reference to the copied matrix
* @return A reference to this
*/
Matrix& operator=( const Matrix& matrix );
void SetIdentityAndScale( const Vector3& scale );
/**
- * @brief Invert a transform Matrix.
+ * @brief Inverts a transform Matrix.
*
* Any Matrix representing only a rotation and/or translation
* can be inverted using this function. It is faster and more accurate then using Invert().
* @SINCE_1_0.0
- * @param [out] result The inverse of this matrix
+ * @param[out] result The inverse of this matrix
*/
void InvertTransform(Matrix& result) const;
* Using the Matrix invert function for the specific type
* of matrix you are dealing with is faster, more accurate.
* @SINCE_1_0.0
- * @return true if successful
+ * @return True if successful
*/
bool Invert();
* @brief Returns the xAxis from a Transform matrix.
*
* @SINCE_1_0.0
- * @return the x axis
+ * @return The x axis
*/
Vector3 GetXAxis() const;
* @brief Returns the yAxis from a Transform matrix.
*
* @SINCE_1_0.0
- * @return the y axis
+ * @return The y axis
*/
Vector3 GetYAxis() const;
* @brief Returns the zAxis from a Transform matrix.
*
* @SINCE_1_0.0
- * @return the z axis
+ * @return The z axis
*/
Vector3 GetZAxis() const;
*
* This assumes the matrix is a transform matrix.
* @SINCE_1_0.0
- * @return the translation
+ * @return The translation
* @note inlined for performance reasons (generates less code than a function call)
*/
const Vector4& GetTranslation() const { return reinterpret_cast<const Vector4&>(mMatrix[12]); }
*
* This assumes the matrix is a transform matrix.
* @SINCE_1_0.0
- * @return the translation
+ * @return The translation
* @note inlined for performance reasons (generates less code than a function call)
*/
const Vector3& GetTranslation3() const { return reinterpret_cast<const Vector3&>(mMatrix[12]); }
* @endcode
*
* @SINCE_1_0.0
- * @return the matrix contents as an array of 16 floats.
+ * @return The matrix contents as an array of 16 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
const float* AsFloat() const {return mMatrix;}
* @endcode
*
* @SINCE_1_0.0
- * @return the matrix contents as an array of 16 floats.
+ * @return The matrix contents as an array of 16 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
float* AsFloat() {return mMatrix;}
/**
* @brief Function to multiply two matrices and store the result onto third.
*
- * Use this method in time critical path as it does not require temporaries
+ * Use this method in time critical path as it does not require temporaries.
* @SINCE_1_0.0
* @param[out] result Result of the multiplication
* @param[in] lhs Matrix, this can be same matrix as result
/**
* @brief Function to multiply a matrix and quaternion and store the result onto third.
*
- * Use this method in time critical path as it does not require temporaries
+ * Use this method in time critical path as it does not require temporaries.
* @SINCE_1_0.0
* @param[out] result Result of the multiplication
* @param[in] lhs Matrix, this can be same matrix as result
/**
* @brief The equality operator.
*
- * Utilises appropriate machine epsilon values.
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The Matrix to compare this to
/**
* @brief The inequality operator.
*
- * Utilises appropriate machine epsilon values.
+ * Utilizes appropriate machine epsilon values.
* @SINCE_1_0.0
* @param[in] rhs The Matrix to compare this to
* @return true if the matrices are not equal.
};
/**
- * @brief Print a matrix.
+ * @brief Prints a matrix.
*
* It is printed in memory order, i.e. each printed row is contiguous in memory.
* @SINCE_1_0.0
- * @param[in] o The output stream operator.
- * @param[in] matrix The matrix to print.
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] matrix The matrix to print
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Matrix& matrix);
friend std::ostream& operator<< (std::ostream& o, const Matrix3& matrix);
/**
- * @brief The identity matrix
+ * @brief The identity matrix.
*/
static const Matrix3 IDENTITY;
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] m A 4x4 matrix. The translation and shear components are ignored.
+ * @param[in] m A 4x4 matrix. The translation and shear components are ignored
*/
Matrix3(const Matrix& m);
Matrix3(float s00, float s01, float s02, float s10, float s11, float s12, float s20, float s21, float s22);
/**
- * @brief Assignment Operator
+ * @brief Assignment Operator.
* @SINCE_1_0.0
- * @param[in] matrix from which to copy values
- * @return reference to this object
+ * @param[in] matrix From which to copy values
+ * @return Reference to this object
*/
Matrix3& operator=( const Matrix3& matrix );
/**
- * @brief Assignment Operator
+ * @brief Assignment Operator.
* @SINCE_1_0.0
* @param[in] matrix A reference to the copied matrix
* @return A reference to this
/**
* @brief The equality operator.
*
- * Utilises appropriate machine epsilon values.
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The Matrix to compare this to
- * @return true if the matrices are equal
+ * @return True if the matrices are equal
*/
bool operator==(const Matrix3 & rhs) const;
/**
* @brief The inequality operator.
*
- * Utilises appropriate machine epsilon values.
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The Matrix to compare this to
* @endcode
*
* @SINCE_1_0.0
- * @return the matrix contents as an array of 9 floats.
+ * @return The matrix contents as an array of 9 floats
*/
const float* AsFloat() const {return &mElements[0];}
* @endcode
*
* @SINCE_1_0.0
- * @return the matrix contents as an array of 9 floats.
+ * @return The matrix contents as an array of 9 floats
*/
float* AsFloat() {return &mElements[0];}
* @brief Inverts the matrix.
*
* @SINCE_1_0.0
- * @return true if successful
+ * @return True if successful
*/
bool Invert();
/**
- * @brief Swaps the rows to columns
+ * @brief Swaps the rows to columns.
* @SINCE_1_0.0
- * @return true if successful
+ * @return True if successful
*/
bool Transpose();
* @brief Multiplies all elements of the matrix by the scale value.
*
* @SINCE_1_0.0
- * @param[in] scale The value by which to scale the whole matrix.
+ * @param[in] scale The value by which to scale the whole matrix
*
*/
void Scale(float scale);
*
* (The Magnitude of the unit matrix is therefore 1)
* @SINCE_1_0.0
- * @return the magnitude - always positive.
+ * @return The magnitude - always positive
*/
float Magnitude() const;
* If the matrix is not invertible, then the matrix is left unchanged.
*
* @SINCE_1_0.0
- * @return true if the matrix is invertible, otherwise false
+ * @return @c true if the matrix is invertible, otherwise @c false
*/
bool ScaledInverseTranspose();
};
/**
- * @brief Print a 3x3 matrix.
+ * @brief Prints a 3x3 matrix.
*
* @SINCE_1_0.0
- * @param[in] o The output stream operator.
- * @param[in] matrix The matrix to print.
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] matrix The matrix to print
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Matrix3& matrix);
public:
/**
- * @brief Default Constructor
+ * @brief Default Constructor.
* @SINCE_1_0.0
*/
Quaternion();
/**
- * @brief Construct from a quaternion represented by floats.
+ * @brief Constructs from a quaternion represented by floats.
*
* @SINCE_1_0.0
* @param[in] cosThetaBy2
Quaternion( float cosThetaBy2, float iBySineTheta, float jBySineTheta, float kBySineTheta );
/**
- * @brief Construct from a quaternion represented by a vector.
+ * @brief Constructs from a quaternion represented by a vector.
*
* @SINCE_1_0.0
* @param[in] vector x,y,z fields represent i,j,k coefficients, w represents cos(theta/2)
Quaternion( Radian angle, const Vector3& axis );
/**
- * @brief Construct from Euler angles.
+ * @brief Constructs from Euler angles.
*
* @SINCE_1_0.0
* @param[in] pitch
Quaternion( Radian pitch, Radian yaw, Radian roll );
/**
- * @brief Construct from a matrix.
+ * @brief Constructs from a matrix.
*
* @SINCE_1_0.0
* @param[in] matrix
explicit Quaternion(const Matrix& matrix);
/**
- * @brief Construct from 3 orthonormal axes.
+ * @brief Constructs from 3 orthonormal axes.
*
* @SINCE_1_0.0
* @param[in] xAxis The X axis
explicit Quaternion( const Vector3& xAxis, const Vector3& yAxis, const Vector3& zAxis );
/**
- * @brief Construct quaternion which describes minimum rotation to align v0 with v1
+ * @brief Constructs quaternion which describes minimum rotation to align v0 with v1.
* @SINCE_1_0.0
* @param[in] v0 First normalized vector
* @param[in] v1 Second normalized vector
static const Quaternion IDENTITY; ///< (0.0f,0.0f,0.0f,1.0f)
/**
- * @brief Helper to check if this is an identity quaternion
+ * @brief Helper to check if this is an identity quaternion.
*
* @SINCE_1_0.0
- * @return true if this is identity quaternion
+ * @return True if this is identity quaternion
*/
bool IsIdentity() const;
/**
- * @brief Convert the quaternion to an axis/angle pair.
+ * @brief Converts the quaternion to an axis/angle pair.
*
* @SINCE_1_0.0
* @param[out] axis
* @param[out] angle Angle in radians
- * @return true if converted correctly
+ * @return True if converted correctly
*/
bool ToAxisAngle( Vector3& axis, Radian& angle ) const;
/**
- * @brief Return the quaternion as a vector.
+ * @brief Returns the quaternion as a vector.
*
* @SINCE_1_0.0
- * @return the vector representation of the quaternion
+ * @return The vector representation of the quaternion
*/
const Vector4& AsVector() const;
void SetEuler( Radian pitch, Radian yaw, Radian roll );
/**
- * @brief returns the Euler angles from a rotation Quaternion.
+ * @brief Returns the Euler angles from a rotation Quaternion.
*
* @SINCE_1_0.0
- * @return a vector of Euler angles (x == pitch, y == yaw, z == roll)
+ * @return A vector of Euler angles (x == pitch, y == yaw, z == roll)
*/
Vector4 EulerAngles() const;
* @brief Equality operator.
*
* @SINCE_1_0.0
- * @param[in] rhs The quaterion to compare with.
- * @return True if the quaternions are equal.
+ * @param[in] rhs The quaternion to compare with
+ * @return True if the quaternions are equal
*/
bool operator==( const Quaternion& rhs ) const;
* @brief Inequality operator.
*
* @SINCE_1_0.0
- * @param[in] rhs The quaterion to compare with.
- * @return True if the quaternions are not equal.
+ * @param[in] rhs The quaternion to compare with
+ * @return True if the quaternions are not equal
*/
bool operator!=( const Quaternion& rhs ) const;
/**
- * @brief Return the length of the quaternion.
+ * @brief Returns the length of the quaternion.
*
* @SINCE_1_0.0
- * @return the length of the quaternion
+ * @return The length of the quaternion
*/
float Length() const;
/**
- * @brief Return the squared length of the quaternion.
+ * @brief Returns the squared length of the quaternion.
*
* @SINCE_1_0.0
- * @return the squared length of the quaternion
+ * @return The squared length of the quaternion
*/
float LengthSquared() const;
/**
- * @brief Normalize this to unit length.
+ * @brief Normalizes this to unit length.
*
* @SINCE_1_0.0
*/
* @brief Normalized.
*
* @SINCE_1_0.0
- * @return a normalized version of this quaternion
+ * @return A normalized version of this quaternion
*/
Quaternion Normalized() const;
/**
- * @brief Conjugate this quaternion.
+ * @brief Conjugates this quaternion.
*
* @SINCE_1_0.0
*/
void Conjugate();
/**
- * @brief Invert this quaternion.
+ * @brief Inverts this quaternion.
*
* @SINCE_1_0.0
*/
* @brief Performs the logarithm of a Quaternion = v*a where q = (cos(a),v*sin(a)).
*
* @SINCE_1_0.0
- * @return a quaternion representing the logarithm
+ * @return A quaternion representing the logarithm
*/
Quaternion Log() const;
* @brief Performs an exponent e^Quaternion = Exp(v*a) = (cos(a),vsin(a)).
*
* @SINCE_1_0.0
- * @return a quaternion representing the exponent
+ * @return A quaternion representing the exponent
*/
Quaternion Exp() const;
/**
- * @brief Return the dot product of two quaternions.
+ * @brief Returns the dot product of two quaternions.
*
* @SINCE_1_0.0
* @param[in] q1 The first quaternion
* @param[in] q2 The second quaternion
- * @return the dot product of the two quaternions
+ * @return The dot product of the two quaternions
*/
static float Dot( const Quaternion &q1, const Quaternion &q2 );
* @SINCE_1_0.0
* @param[in] q1 The start quaternion
* @param[in] q2 The end quaternion
- * @param[in] t A progress value between 0 and 1
- * @return the interpolated quaternion
+ * @param[in] t A progress value between 0 and 1
+ * @return The interpolated quaternion
*/
static Quaternion Lerp( const Quaternion &q1, const Quaternion &q2, float t );
* @param[in] q1 The start quaternion
* @param[in] q2 The end quaternion
* @param[in] progress A progress value between 0 and 1
- * @return the interpolated quaternion
+ * @return The interpolated quaternion
*/
static Quaternion Slerp( const Quaternion &q1, const Quaternion &q2, float progress );
* @SINCE_1_0.0
* @param[in] q1 The start quaternion
* @param[in] q2 The end quaternion
- * @param[in] t A progress value between 0 and 1
- * @return the interpolated quaternion
+ * @param[in] t A progress value between 0 and 1
+ * @return The interpolated quaternion
*/
static Quaternion SlerpNoInvert( const Quaternion &q1, const Quaternion &q2, float t );
* @param[in] end The end quaternion
* @param[in] ctrl1 The control quaternion for q1
* @param[in] ctrl2 The control quaternion for q2
- * @param[in] t A progress value between 0 and 1
- * @return the interpolated quaternion
+ * @param[in] t A progress value between 0 and 1
+ * @return The interpolated quaternion
*/
static Quaternion Squad( const Quaternion& start, const Quaternion& end, const Quaternion& ctrl1, const Quaternion& ctrl2, float t );
* @SINCE_1_0.0
* @param[in] q1 The first quaternion
* @param[in] q2 The second quaternion
- * @return The angle between the two quaternions.
+ * @return The angle between the two quaternions
*/
static float AngleBetween( const Quaternion& q1, const Quaternion& q2 );
/**
- * @brief Rotate v by this Quaternion (Quaternion must be unit).
+ * @brief Rotates v by this Quaternion (Quaternion must be unit).
*
* @SINCE_1_0.0
* @param[in] vector A vector to rotate
- * @return the rotated vector
+ * @return The rotated vector
*/
Vector4 Rotate( const Vector4& vector ) const;
/**
- * @brief Rotate v by this Quaternion (Quaternion must be unit).
+ * @brief Rotates v by this Quaternion (Quaternion must be unit).
*
* @SINCE_1_0.0
* @param[in] vector A vector to rotate
- * @return the rotated vector
+ * @return The rotated vector
*/
Vector3 Rotate( const Vector3& vector ) const;
/// @cond internal
/**
- * @brief Set the quaternion from 3 orthonormal axes.
+ * @brief Sets the quaternion from 3 orthonormal axes.
*
* @SINCE_1_0.0
* @param[in] xAxis The X axis
};
/**
- * @brief Print a Quaternion.
+ * @brief Prints a Quaternion.
*
* @SINCE_1_0.0
- * @param [in] o The output stream operator.
- * @param [in] quaternion The quaternion to print.
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] quaternion The quaternion to print
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Quaternion& quaternion);
struct Radian
{
/**
- * @brief default constructor, initialises to 0.
+ * @brief Default constructor, initializes to 0.
* @SINCE_1_0.0
*/
Radian()
{ }
/**
- * @brief Create an angle in radians.
+ * @brief Creates an angle in radians.
*
* @SINCE_1_0.0
- * @param[in] value The initial value in radians.
+ * @param[in] value The initial value in radians
*/
explicit Radian( float value )
: radian( value )
{ }
/**
- * @brief Create an angle in radians from an angle in degrees.
+ * @brief Creates an angle in radians from an angle in degrees.
*
* @SINCE_1_0.0
- * @param[in] degree The initial value in degrees.
+ * @param[in] degree The initial value in degrees
*/
Radian( Degree degree )
: radian( degree.degree * Math::PI_OVER_180 )
{ }
/**
- * @brief Assign an angle from a float value.
+ * @brief Assigns an angle from a float value.
*
* @SINCE_1_0.0
* @param[in] value Float value in radians
}
/**
- * @brief Assign an angle from a Degree value.
+ * @brief Assigns an angle from a Degree value.
*
* @SINCE_1_0.0
- * @param[in] degree The value in degrees.
+ * @param[in] degree The value in degrees
* @return A reference to this
*/
Radian& operator=( Degree degree )
}
/**
- * @brief Conversion to float
+ * @brief Conversion to float.
* @SINCE_1_0.0
- * @return the float value of this Radian
+ * @return The float value of this Radian
*/
operator float() const
{
// compiler generated destructor, copy constructor and assignment operators are ok as this class is POD
/**
- * @brief Compare equality between two radians.
+ * @brief Compares equality between two radians.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Radian to compare to
- * @return true if the values are identical
+ * @return True if the values are identical
*/
inline bool operator==( Radian lhs, Radian rhs )
{
}
/**
- * @brief Compare inequality between two radians.
+ * @brief Compares inequality between two radians.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Radian to compare to
- * @return true if the values are not identical
+ * @return True if the values are not identical
*/
inline bool operator!=( Radian lhs, Radian rhs )
{
}
/**
- * @brief Compare equality between a radian and degree.
+ * @brief Compares equality between a radian and degree.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Degree to compare to
- * @return true if the values are identical
+ * @return True if the values are identical
*/
inline bool operator==( Radian lhs, Degree rhs )
{
}
/**
- * @brief Compare inequality between a radian and a degree.
+ * @brief Compares inequality between a radian and a degree.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Degree to compare to
- * @return true if the values are not identical
+ * @return True if the values are not identical
*/
inline bool operator!=( Radian lhs, Degree rhs )
{
}
/**
- * @brief Compare equality between a degree and a radian.
+ * @brief Compares equality between a degree and a radian.
*
* @SINCE_1_0.0
* @param[in] lhs Degree to compare
* @param[in] rhs Radian to compare to
- * @return true if the values are identical
+ * @return True if the values are identical
*/
inline bool operator==( Degree lhs, Radian rhs )
{
}
/**
- * @brief Compare inequality between a degree and a radian.
+ * @brief Compares inequality between a degree and a radian.
*
* @SINCE_1_0.0
* @param[in] lhs Degree to compare
* @param[in] rhs Radian to compare to
- * @return true if the values are not identical
+ * @return True if the values are not identical
*/
inline bool operator!=( Degree lhs, Radian rhs )
{
}
/**
- * @brief Compare greater than between two radians
+ * @brief Compares greater than between two radians
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Radian to compare to
- * @return true if lhs is greater than rhs
+ * @return True if lhs is greater than rhs
*/
inline bool operator>( Radian lhs, Radian rhs )
{
}
/**
- * @brief Compare greater than between a radian and a degree.
+ * @brief Compares greater than between a radian and a degree.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Degree to compare to
- * @return true if lhs is greater than rhs
+ * @return True if lhs is greater than rhs
*/
inline bool operator>( Radian lhs, Degree rhs )
{
}
/**
- * @brief Compare greater than between a radian and a degree.
+ * @brief Compares greater than between a radian and a degree.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Degree to compare to
- * @return true if lhs is greater than rhs
+ * @return True if lhs is greater than rhs
*/
inline bool operator>( Degree lhs, Radian rhs )
{
}
/**
- * @brief Compare less than between two radians.
+ * @brief Compares less than between two radians.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Radian to compare to
- * @return true if lhs is less than rhs
+ * @return True if lhs is less than rhs
*/
inline bool operator<( Radian lhs, Radian rhs )
{
}
/**
- * @brief Compare less than between a radian and a degree.
+ * @brief Compares less than between a radian and a degree.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to compare
* @param[in] rhs Degree to compare to
- * @return true if lhs is less than rhs
+ * @return True if lhs is less than rhs
*/
inline bool operator<( Radian lhs, Degree rhs )
{
}
/**
- * @brief Compare less than between a degree and a radian.
+ * @brief Compares less than between a degree and a radian.
*
* @SINCE_1_0.0
* @param[in] lhs Degree to compare
* @param[in] rhs Radian to compare to
- * @return true if lhs is less than rhs
+ * @return True if lhs is less than rhs
*/
inline bool operator<( Degree lhs, Radian rhs )
{
}
/**
- * @brief Multiply Radian with a float
+ * @brief Multiplies Radian with a float.
*
* @SINCE_1_0.0
* @param[in] lhs Radian to multiply
* @param[in] rhs float to multiply
- * @return result of the multiplication
+ * @return Result of the multiplication
*/
inline Radian operator*( Radian lhs, float rhs )
{
}
/**
- * @brief Negate the radian
+ * @brief Negates the radian.
* @SINCE_1_0.0
* @param[in] in Radian to negate
* @return The negative angle
}
/**
- * @brief Clamp a radian value
+ * @brief Clamps a radian value.
* @SINCE_1_0.0
* @param angle to clamp
* @param min value
* @param max value
- * @return the resulting radian
+ * @return The resulting radian
*/
inline Radian Clamp( Radian angle, float min, float max )
{
* @SINCE_1_0.0
* @param[in] f0 The lower bound
* @param[in] f1 The upper bound
- * @return a random value between the lower and upper bound
+ * @return A random value between the lower and upper bound
*/
inline float Range(float f0, float f1)
{
* @brief Function to return a normalized axis in a random direction.
*
* @SINCE_1_0.0
- * @return the axis
+ * @return The axis
*/
inline Vector4 Axis()
{
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param [in] x x coordinate (or left)
- * @param [in] y y coordinate (or right)
- * @param [in] width width (or bottom)
- * @param [in] height height (or top)
+ * @param[in] x X coordinate (or left)
+ * @param[in] y Y coordinate (or right)
+ * @param[in] width Width (or bottom)
+ * @param[in] height Height (or top)
*/
Rect(T x, T y, T width, T height)
: x(x),
* @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] rhs The original object
+ * @param[in] rhs The original object
*/
Rect(const Rect<T>& rhs)
{
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] rhs The original object
- * @return reference to this
+ * @param[in] rhs The original object
+ * @return Reference to this
*/
Rect<T>& operator= (const Rect<T>& rhs)
{
* @brief Assignment from individual values.
*
* @SINCE_1_0.0
- * @param[in] newX x coordinate
- * @param[in] newY y coordinate
- * @param[in] newWidth width
- * @param[in] newHeight height
+ * @param[in] newX X coordinate
+ * @param[in] newY Y coordinate
+ * @param[in] newWidth Width
+ * @param[in] newHeight Height
*/
void Set(T newX, T newY, T newWidth, T newHeight)
{
* @brief Determines whether or not this Rectangle is empty.
*
* @SINCE_1_0.0
- * @return true if width or height are zero
+ * @return True if width or height are zero
*/
bool IsEmpty() const
{
}
/**
- * @brief Get the left of the rectangle.
+ * @brief Gets the left of the rectangle.
*
* @SINCE_1_0.0
* @return The left edge of the rectangle
return x;
}
/**
- * @brief Get the right of the rectangle.
+ * @brief Gets the right of the rectangle.
*
* @SINCE_1_0.0
* @return The right edge of the rectangle
}
/**
- * @brief Get the top of the rectangle.
+ * @brief Gets the top of the rectangle.
*
* @SINCE_1_0.0
* @return The top of the rectangle
}
/**
- * @brief Get the bottom of the rectangle.
+ * @brief Gets the bottom of the rectangle.
*
* @SINCE_1_0.0
* @return The bottom of the rectangle
}
/**
- * @brief Get the area of the rectangle.
+ * @brief Gets the area of the rectangle.
*
* @SINCE_1_0.0
* @return The area of the rectangle
* @brief Determines whether or not this rectangle and the specified rectangle intersect.
*
* @SINCE_1_0.0
- * @param[in] other The other rectangle to test against this rectangle
- * @return true if the rectangles intersect
+ * @param[in] other The other rectangle to test against this rectangle
+ * @return True if the rectangles intersect
*/
bool Intersects(const Rect<T>& other) const
{
* @brief Determines whether or not this Rectangle contains the specified rectangle.
*
* @SINCE_1_0.0
- * @param[in] other The other rectangle to test against this rectangle
- * @return true if the specified rectangle is contained
+ * @param[in] other The other rectangle to test against this rectangle
+ * @return True if the specified rectangle is contained
*/
bool Contains(const Rect<T>& other) const
{
* @SINCE_1_0.0
* @param[in] lhs First operand
* @param[in] rhs Second operand
- * @return true if boxes are exactly same
+ * @return True if boxes are exactly same
*/
template< typename T >
inline bool operator==( const Rect<T>& lhs, const Rect<T>& rhs )
* @SINCE_1_0.0
* @param[in] lhs The first rectangle
* @param[in] rhs The second rectangle
- * @return true if rectangles are not identical
+ * @return True if rectangles are not identical
*/
template< typename T >
inline bool operator!=( const Rect<T>& lhs, const Rect<T>& rhs )
* @SINCE_1_0.0
* @param[in] lhs The first rectangle
* @param[in] rhs The second rectangle
- * @return true if rectangles are exactly same
+ * @return True if rectangles are exactly same
*/
template<>
inline bool operator==( const Rect<float>& lhs, const Rect<float>& rhs )
* @brief IsEmpty specialization for float.
*
* @SINCE_1_0.0
- * @return true if the rectangle has zero size.
+ * @return True if the rectangle has zero size
*/
template<>
inline bool Rect<float>::IsEmpty() const
}
/**
- * @brief Convert the value of the rectangle into a string and insert in to an output stream.
+ * @brief Converts the value of the rectangle into a string and insert in to an output stream.
*
* @SINCE_1_0.0
- * @param [in] stream The output stream operator.
- * @param [in] rectangle the rectangle to output
- * @return The output stream operator.
+ * @param[in] stream The output stream operator
+ * @param[in] rectangle the rectangle to output
+ * @return The output stream operator
*/
template< typename T >
inline std::ostream& operator<< (std::ostream& stream, const Rect<T>& rectangle)
/**
* @brief Constructor taking separate x and y (width and height) parameters.
* @SINCE_1_0.0
- * @param[in] width The width or X dimension of the tuple. Make sure it is less than 65536,
- * @param[in] height The height or Y dimension of the tuple. Make sure it is less than 65536,
+ * @param[in] width The width or X dimension of the tuple. Make sure it is less than 65536
+ * @param[in] height The height or Y dimension of the tuple. Make sure it is less than 65536
*/
Uint16Pair( uint32_t width, uint32_t height )
{
/**
* @brief Sets the width.
* @SINCE_1_1.13
- * @param[in] width The x dimension to be stored in this 2-tuple.
+ * @param[in] width The x dimension to be stored in this 2-tuple
*/
void SetWidth( uint16_t width )
{
/**
* @brief Sets the height.
* @SINCE_1_1.13
- * @param[in] height The y dimension to be stored in this 2-tuple.
+ * @param[in] height The y dimension to be stored in this 2-tuple
*/
void SetHeight( uint16_t height )
{
/**
* @brief Sets the x dimension (same as width).
* @SINCE_1_1.14
- * @param[in] x The x dimension to be stored in this 2-tuple.
+ * @param[in] x The x dimension to be stored in this 2-tuple
*/
void SetX( uint16_t x )
{
/**
* @brief Sets the y dimension (same as height).
* @SINCE_1_1.14
- * @param[in] y The y dimension to be stored in this 2-tuple.
+ * @param[in] y The y dimension to be stored in this 2-tuple
*/
void SetY( uint16_t y )
{
}
/**
- * @brief Create an instance by rounding a floating point vector to closest
+ * @brief Creates an instance by rounding a floating point vector to closest
* integers.
*
* Uses a template for loose coupling, to save a header include, and allow any
* vector type with .x and .y members to be converted.
* @SINCE_1_0.0
* @param[in] from Floating point vector2
- * @return Closest integer value.
+ * @return Closest integer value
*/
template<typename FLOAT_VECTOR_N_TYPE>
static Uint16Pair FromFloatVec2( const FLOAT_VECTOR_N_TYPE& from )
}
/**
- * @brief Create an instance by rounding a floating point array to closest
+ * @brief Creates an instance by rounding a floating point array to closest
* integers.
*
* Uses a template to allow any vector type with operator [] to be converted
* in addition to plain arrays.
* @SINCE_1_0.0
* @param[in] from Floating point array
- * @return Closest integer value.
+ * @return Closest integer value
*/
template<typename FLOAT_ARRAY>
static Uint16Pair FromFloatArray( const FLOAT_ARRAY& from )
* @brief Conversion constructor from an array of two floats.
*
* @SINCE_1_0.0
- * @param [in] array Array of xy
+ * @param[in] array Array of xy
*/
explicit Vector2(const float* array)
: x(array[0]),
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param [in] vec3 Vector3 to create this vector from
+ * @param[in] vec3 Vector3 to create this vector from
*/
explicit Vector2(const Vector3& vec3);
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param [in] vec4 Vector4 to create this vector from
+ * @param[in] vec4 Vector4 to create this vector from
*/
explicit Vector2(const Vector4& vec4);
*
* @SINCE_1_0.0
* @param[in] array Array of floats
- * @return itself
+ * @return Itself
*/
Vector2& operator=(const float* array)
{
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to assign.
- * @return itself
+ * @param[in] rhs Vector to assign
+ * @return Itself
*/
Vector2& operator=(const Vector3& rhs);
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to assign.
- * @return itself
+ * @param[in] rhs Vector to assign
+ * @return Itself
*/
Vector2& operator=(const Vector4& rhs);
* @brief Addition operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to add.
+ * @param[in] rhs Vector to add
* @return A vector containing the result of the addition
*/
Vector2 operator+(const Vector2& rhs) const
* @brief Addition assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to add.
- * @return itself
+ * @param[in] rhs Vector to add
+ * @return Itself
*/
Vector2& operator+=(const Vector2& rhs)
{
* @brief Subtraction operator.
*
* @SINCE_1_0.0
- * @param[in] rhs The vector to subtract
+ * @param[in] rhs The vector to subtract
* @return A vector containing the result of the subtraction
*/
Vector2 operator-(const Vector2& rhs) const
*
* @SINCE_1_0.0
* @param[in] rhs The vector to subtract
- * @return itself
+ * @return Itself
*/
Vector2& operator-=(const Vector2& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The vector to multiply
- * @return itself
+ * @return Itself
*/
Vector2& operator*=(const Vector2& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The float value to scale the vector
- * @return itself
+ * @return Itself
*/
Vector2& operator*=(float rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The vector to divide
- * @return itself
+ * @return Itself
*/
Vector2& operator/=(const Vector2& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The float value to scale the vector by
- * @return itself
+ * @return Itself
*/
Vector2& operator/=(float rhs)
{
/**
* @brief Equality operator.
*
- * utilises appropriate machine epsilon values;
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The vector to test against
/**
* @brief Inequality operator.
*
- * utilises appropriate machine epsilon values;
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The vector to test against
/**
* @brief Const array subscript operator overload.
*
- * Asserts if index is out of range. Should be 0 or 1
+ * Asserts if index is out of range. Should be 0 or 1.
* @SINCE_1_0.0
* @param[in] index Subscript index
- * @return The float at the given index
+ * @return The float at the given index
*/
const float& operator[](const unsigned int index) const
{
/**
* @brief Mutable array subscript operator overload.
*
- * Asserts if index is out of range. Should be 0 or 1
+ * Asserts if index is out of range. Should be 0 or 1.
* @SINCE_1_0.0
* @param[in] index Subscript index
- * @return The float at the given index.
+ * @return The float at the given index
*/
float& operator[](const unsigned int index)
{
* @brief Returns the length of the vector.
*
* @SINCE_1_0.0
- * @return the length of the vector
+ * @return The length of the vector
*/
float Length() const;
* This is more efficient than Length() for threshold
* testing as it avoids the use of a square root.
* @SINCE_1_0.0
- * @return the length of the vector squared.
+ * @return The length of the vector squared
*/
float LengthSquared() const;
* @brief Clamps the vector between minimum and maximum vectors.
*
* @SINCE_1_0.0
- * @param [in] min The minimum vector
- * @param [in] max The maximum vector
+ * @param[in] min The minimum vector
+ * @param[in] max The maximum vector
*/
void Clamp( const Vector2& min, const Vector2& max );
* 0: x (or width)
* 1: y (or height)
* @SINCE_1_0.0
- * @return the vector contents as an array of 2 floats.
+ * @return The vector contents as an array of 2 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
const float* AsFloat() const {return &x;}
* 0: x (or width)
* 1: y (or height)
* @SINCE_1_0.0
- * @return the vector contents as an array of 2 floats.
+ * @return The vector contents as an array of 2 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
float* AsFloat() {return &x;}
};
/**
- * @brief Size is an alias of Dali::Vector2
+ * @brief Size is an alias of Dali::Vector2.
* @SINCE_1_0.0
*/
typedef Vector2 Size;
* @brief Print a Vector2.
*
* @SINCE_1_0.0
- * @param [in] o The output stream operator.
- * @param [in] vector The vector to print.
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] vector The vector to print
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Vector2& vector);
/**
* @brief Returns a vector with components set to the minimum of the corresponding component in a and b.
*
- * If a=0,1 and b=1,0 returns a vector of 0,0.
+ * If a=0,1 and b=1,0 returns a vector of 0,0.
* @SINCE_1_0.0
- * @param [in] a a vector
- * @param [in] b a vector
- * @return a vector containing the minimum of each component from a and b
+ * @param[in] a A vector
+ * @param[in] b A vector
+ * @return A vector containing the minimum of each component from a and b
*/
inline Vector2 Min( const Vector2& a, const Vector2& b )
{
/**
* @brief Returns a vector with components set to the maximum of the corresponding component in a and b.
*
- * If a=0,1 and b=1,0 returns a vector of 1,1
+ * If a=0,1 and b=1,0 returns a vector of 1,1.
* @SINCE_1_0.0
- * @param [in] a a vector
- * @param [in] b a vector
- * @return a vector containing the maximum of each component from a and b
+ * @param[in] a A vector
+ * @param[in] b A vector
+ * @return A vector containing the maximum of each component from a and b
*/
inline Vector2 Max( const Vector2& a, const Vector2& b )
{
* @brief Clamps each of vector v's components between minimum and maximum values.
*
* @SINCE_1_0.0
- * @param [in] v A vector
- * @param [in] min The minimum value
- * @param [in] max The maximum value
- * @return a vector containing the clamped components of v
+ * @param[in] v A vector
+ * @param[in] min The minimum value
+ * @param[in] max The maximum value
+ * @return A vector containing the clamped components of v
*/
DALI_IMPORT_API Vector2 Clamp( const Vector2& v, const float& min, const float& max );
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param [in] x (or width) component
- * @param [in] y (or height) component
- * @param [in] z (or depth) component
+ * @param[in] x (or width) component
+ * @param[in] y (or height) component
+ * @param[in] z (or depth) component
*/
explicit Vector3(float x, float y, float z)
: x(x),
* @brief Conversion constructor from an array of three floats.
*
* @SINCE_1_0.0
- * @param [in] array Array of xyz
+ * @param[in] array Array of xyz
*/
explicit Vector3(const float* array)
: x(array[0]),
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param [in] vec2 Vector2 to create this vector from
+ * @param[in] vec2 Vector2 to create this vector from
*/
explicit Vector3( const Vector2& vec2 );
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param [in] vec4 Vector4 to create this vector from
+ * @param[in] vec4 Vector4 to create this vector from
*/
explicit Vector3( const Vector4& vec4 );
*
* @SINCE_1_0.0
* @param[in] array Array of floats
- * @return itself
+ * @return Itself
*/
Vector3& operator=(const float* array)
{
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to assign.
- * @return itself
+ * @param[in] rhs Vector to assign
+ * @return Itself
*/
Vector3& operator=(const Vector2& rhs);
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to assign.
- * @return itself
+ * @param[in] rhs Vector to assign
+ * @return Itself
*/
Vector3& operator=(const Vector4& rhs);
* @brief Addition operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to add.
+ * @param[in] rhs Vector to add
* @return A vector containing the result of the addition
*/
Vector3 operator+(const Vector3& rhs) const
* @brief Addition assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to add.
- * @return itself
+ * @param[in] rhs Vector to add
+ * @return Itself
*/
Vector3& operator+=(const Vector3& rhs)
{
* @brief Subtraction operator.
*
* @SINCE_1_0.0
- * @param[in] rhs The vector to subtract
+ * @param[in] rhs The vector to subtract
* @return A vector containing the result of the subtraction
*/
Vector3 operator-(const Vector3& rhs) const
*
* @SINCE_1_0.0
* @param[in] rhs The vector to subtract
- * @return itself
+ * @return Itself
*/
Vector3& operator-=(const Vector3& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The vector to multiply
- * @return itself
+ * @return Itself
*/
Vector3& operator*=(const Vector3& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The float value to scale the vector
- * @return itself
+ * @return Itself
*/
Vector3& operator*=(float rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The Quaternion value to multiply the vector by
- * @return itself
+ * @return Itself
*/
Vector3& operator*=(const Quaternion& rhs);
*
* @SINCE_1_0.0
* @param[in] rhs The vector to divide
- * @return itself
+ * @return Itself
*/
Vector3& operator/=(const Vector3& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The float value to scale the vector by
- * @return itself
+ * @return Itself
*/
Vector3& operator/=(float rhs)
{
/**
* @brief Equality operator.
*
- * utilises appropriate machine epsilon values;
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The vector to test against
- * @return true if the vectors are equal
+ * @return True if the vectors are equal
*/
bool operator==(const Vector3& rhs) const;
/**
* @brief Inequality operator.
*
- * utilises appropriate machine epsilon values;
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The vector to test against
- * @return true if the vectors are not equal
+ * @return True if the vectors are not equal
*/
bool operator!=(const Vector3& rhs) const
{
/**
* @brief Const array subscript operator overload.
*
- * Asserts if index is out of range. Should be 0, 1 or 2
+ * Asserts if index is out of range. Should be 0, 1 or 2.
* @SINCE_1_0.0
* @param[in] index Subscript index
- * @return The float at the given index.
+ * @return The float at the given index
*/
const float& operator[](const unsigned int index) const
{
/**
* @brief Mutable array subscript operator overload.
*
- * Asserts if index is out of range. Should be 0, 1 or 2
+ * Asserts if index is out of range. Should be 0, 1 or 2.
* @SINCE_1_0.0
* @param[in] index Subscript index
- * @return The float at the given index.
+ * @return The float at the given index
*/
float& operator[](const unsigned int index)
{
* This is great for lighting, threshold testing the angle between two unit vectors,
* calculating the distance between two points in a particular direction.
* @SINCE_1_0.0
- * @param [in] other The other vector
- * @return The dot product
+ * @param[in] other The other vector
+ * @return The dot product
*/
float Dot(const Vector3& other) const;
* two vectors. This is great for calculating normals and making matrices orthogonal.
*
* @SINCE_1_0.0
- * @param [in] other The other vector
+ * @param[in] other The other vector
* @return The cross product
*/
Vector3 Cross(const Vector3& other) const;
* @brief Returns the length of the vector.
*
* @SINCE_1_0.0
- * @return the length of the vector
+ * @return The length of the vector
*/
float Length() const;
* This is more efficient than Length() for threshold
* testing as it avoids the use of a square root.
* @SINCE_1_0.0
- * @return the length of the vector squared.
+ * @return The length of the vector squared
*/
float LengthSquared() const;
* @brief Clamps the vector between minimum and maximum vectors.
*
* @SINCE_1_0.0
- * @param [in] min The minimum vector
- * @param [in] max The maximum vector
+ * @param[in] min The minimum vector
+ * @param[in] max The maximum vector
*/
void Clamp( const Vector3& min, const Vector3& max );
* 1: y (or height, or g)
* 2: z (or depth, or b)
* @SINCE_1_0.0
- * @return the vector contents as an array of 3 floats.
+ * @return The vector contents as an array of 3 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
const float* AsFloat() const {return &x;}
* 1: y (or height, or g)
* 2: z (or depth, or b)
* @SINCE_1_0.0
- * @return the vector contents as an array of 3 floats.
+ * @return The vector contents as an array of 3 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
float* AsFloat() {return &x;}
* @brief Returns the x & y components (or width & height, or r & g) as a Vector2.
*
* @SINCE_1_0.0
- * @return the partial vector contents as Vector2 (x,y)
+ * @return The partial vector contents as Vector2 (x,y)
* @note inlined for performance reasons (generates less code than a function call)
*/
const Vector2& GetVectorXY() const {return reinterpret_cast<const Vector2&>(x);}
* @brief Returns the x & y components (or width & height, or r & g) as a Vector2.
*
* @SINCE_1_0.0
- * @return the partial vector contents as Vector2 (x,y)
+ * @return The partial vector contents as Vector2 (x,y)
* @note inlined for performance reasons (generates less code than a function call)
*/
Vector2& GetVectorXY() {return reinterpret_cast<Vector2&>(x);}
* @brief Returns the y & z components (or height & depth, or g & b) as a Vector2.
*
* @SINCE_1_0.0
- * @return the partial vector contents as Vector2 (y,z)
+ * @return The partial vector contents as Vector2 (y,z)
* @note inlined for performance reasons (generates less code than a function call)
*/
const Vector2& GetVectorYZ() const {return reinterpret_cast<const Vector2&>(y);}
* @brief Returns the y & z components (or height & depth, or g & b) as a Vector2.
*
* @SINCE_1_0.0
- * @return the partial vector contents as Vector2 (y,z)
+ * @return The partial vector contents as Vector2 (y,z)
* @note inlined for performance reasons (generates less code than a function call)
*/
Vector2& GetVectorYZ() {return reinterpret_cast<Vector2&>(y);}
};
/**
- * @brief Print a Vector3.
+ * @brief Prints a Vector3.
*
* @SINCE_1_0.0
- * @param [in] o The output stream operator.
- * @param [in] vector The vector to print.
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] vector The vector to print
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<< (std::ostream& o, const Vector3& vector);
*
* If a=0,1,2 and b=2,1,0 returns a vector of 2,1,2.
* @SINCE_1_0.0
- * @param [in] a A vector
- * @param [in] b A vector
- * @return a vector containing the minimum of each component from a and b
+ * @param[in] a A vector
+ * @param[in] b A vector
+ * @return A vector containing the minimum of each component from a and b
*/
inline Vector3 Min( const Vector3& a, const Vector3& b )
{
/**
* @brief Returns a vector with components set to the maximum of the corresponding component in a and b.
*
- * If a=0,1 and b=1,0 returns a vector of 1,1
+ * If a=0,1 and b=1,0 returns a vector of 1,1.
* @SINCE_1_0.0
- * @param [in] a A vector
- * @param [in] b A vector
- * @return a vector containing the maximum of each component from a and b
+ * @param[in] a A vector
+ * @param[in] b A vector
+ * @return A vector containing the maximum of each component from a and b
*/
inline Vector3 Max( const Vector3& a, const Vector3& b )
{
* @brief Clamps each of vector v's components between minimum and maximum values.
*
* @SINCE_1_0.0
- * @param [in] v A vector
- * @param [in] min The minimum value
- * @param [in] max The maximum value
- * @return a vector containing the clamped components of v
+ * @param[in] v A vector
+ * @param[in] min The minimum value
+ * @param[in] max The maximum value
+ * @return A vector containing the clamped components of v
*/
DALI_IMPORT_API Vector3 Clamp( const Vector3& v, const float& min, const float& max );
/**
* @brief A four dimensional vector.
*
- * Components can be used as position or offset (x,y,z,w); color (r,g,b,a) or texture coords(s,t,p,q)
+ * Components can be used as position or offset (x,y,z,w); color (r,g,b,a) or texture coords(s,t,p,q).
* @SINCE_1_0.0
*/
struct DALI_IMPORT_API Vector4
* @brief Conversion constructor from four floats.
*
* @SINCE_1_0.0
- * @param [in] x (or r/s) component
- * @param [in] y (or g/t) component
- * @param [in] z (or b/p) component
- * @param [in] w (or a/q) component
+ * @param[in] x x (or r/s) component
+ * @param[in] y y (or g/t) component
+ * @param[in] z z (or b/p) component
+ * @param[in] w w (or a/q) component
*/
explicit Vector4(float x, float y, float z, float w)
: x(x),
* @brief Conversion constructor from an array of four floats.
*
* @SINCE_1_0.0
- * @param [in] array Array of either xyzw/rgba/stpq
+ * @param[in] array Array of either xyzw/rgba/stpq
*/
explicit Vector4(const float* array)
: x(array[0]),
* @brief Conversion constructor from Vector2.
*
* @SINCE_1_0.0
- * @param [in] vec2 Vector2 to copy from, z and w are initialized to 0
+ * @param[in] vec2 Vector2 to copy from, z and w are initialized to 0
*/
explicit Vector4( const Vector2& vec2 );
* @brief Conversion constructor from Vector3.
*
* @SINCE_1_0.0
- * @param [in] vec3 Vector3 to copy from, w is initialized to 0
+ * @param[in] vec3 Vector3 to copy from, w is initialized to 0
*/
explicit Vector4( const Vector3& vec3 );
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] array Array of floats
- * @return itself
+ * @param[in] array Array of floats
+ * @return Itself
*/
Vector4& operator=(const float* array)
{
/**
* @brief Assignment operator.
*
- * Only sets x and y. z and w are left as they were
+ * Only sets x and y. z and w are left as they were.
* @SINCE_1_0.0
- * @param [in] vec2 A reference to assign from.
- * @return itself
+ * @param[in] vec2 A reference to assign from
+ * @return Itself
*/
Vector4& operator=(const Vector2& vec2 );
/**
* @brief Assignment operator.
*
- * Only sets x and y and z. w is left as it was
+ * Only sets x and y and z. w is left as it was.
* @SINCE_1_0.0
- * @param [in] vec3 A reference to assign from
- * @return itself
+ * @param[in] vec3 A reference to assign from
+ * @return Itself
*/
Vector4& operator=(const Vector3& vec3 );
* @brief Addition operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to add.
+ * @param[in] rhs Vector to add
* @return A vector containing the result of the addition
*/
Vector4 operator+(const Vector4 & rhs) const
* @brief Addition assignment operator.
*
* @SINCE_1_0.0
- * @param[in] rhs Vector to add.
- * @return itself
+ * @param[in] rhs Vector to add
+ * @return Itself
*/
Vector4& operator+=(const Vector4& rhs)
{
* @brief Subtraction operator.
*
* @SINCE_1_0.0
- * @param[in] rhs The vector to subtract
+ * @param[in] rhs The vector to subtract
* @return A vector containing the result of the subtraction
*/
Vector4 operator-(const Vector4& rhs) const
*
* @SINCE_1_0.0
* @param[in] rhs The vector to subtract
- * @return itself
+ * @return Itself
*/
Vector4& operator-=(const Vector4& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The vector to multiply
- * @return itself
+ * @return Itself
*/
Vector4& operator*=(const Vector4& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The float value to scale the vector
- * @return itself
+ * @return Itself
*/
Vector4& operator*=(float rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The vector to divide
- * @return itself
+ * @return Itself
*/
Vector4& operator/=(const Vector4& rhs)
{
*
* @SINCE_1_0.0
* @param[in] rhs The float value to scale the vector by
- * @return itself
+ * @return Itself
*/
Vector4& operator/=(float rhs)
{
* @brief Unary negation operator.
*
* @SINCE_1_0.0
- * @return the negative value
+ * @return The negative value
*/
Vector4 operator-() const
{
/**
* @brief Equality operator.
*
- * Utilises appropriate machine epsilon values.
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The vector to test against
- * @return true if the vectors are equal
+ * @return True if the vectors are equal
*/
bool operator==(const Vector4 &rhs) const;
/**
* @brief Inequality operator.
*
- * Utilises appropriate machine epsilon values.
+ * Utilizes appropriate machine epsilon values.
*
* @SINCE_1_0.0
* @param[in] rhs The vector to test against
- * @return true if the vectors are not equal
+ * @return True if the vectors are not equal
*/
bool operator!=(const Vector4 &rhs) const
{
/**
* @brief Const array subscript operator overload.
*
- * Asserts if index is out of range. Should be 0, 1, 2 or 3
+ * Asserts if index is out of range. Should be 0, 1, 2 or 3.
* @SINCE_1_0.0
* @param[in] index Subscript index
- * @return The float at the given index
+ * @return The float at the given index
*/
const float& operator[](const unsigned int index) const
{
/**
* @brief Mutable array subscript operator overload.
*
- * Asserts if index is out of range. Should be 0, 1, 2 or 3
+ * Asserts if index is out of range. Should be 0, 1, 2 or 3.
* @SINCE_1_0.0
* @param[in] index Subscript index
- * @return The float at the given index
+ * @return The float at the given index
*/
float& operator[](const unsigned int index)
{
* This is great for lighting, threshold testing the angle between two unit vectors,
* calculating the distance between two points in a particular direction.
* @SINCE_1_0.0
- * @param [in] other The other vector
- * @return the dot product
+ * @param[in] other The other vector
+ * @return The dot product
*/
float Dot(const Vector3& other) const;
* This is great for lighting, threshold testing the angle between two unit vectors,
* calculating the distance between two points in a particular direction.
* @SINCE_1_0.0
- * @param [in] other The other vector
- * @return the dot product
+ * @param[in] other The other vector
+ * @return The dot product
*/
float Dot(const Vector4& other) const;
* @brief Returns the 4d dot product of this vector and another vector.
*
* @SINCE_1_0.0
- * @param [in] other The other vector
- * @return the dot product
+ * @param[in] other The other vector
+ * @return The dot product
*/
float Dot4(const Vector4& other) const;
* two vectors. This is great for calculating normals and making matrices orthogonal.
*
* @SINCE_1_0.0
- * @param [in] other The other vector
+ * @param[in] other The other vector
* @return A vector containing the cross product
*/
Vector4 Cross(const Vector4& other) const;
* @brief Returns the length of the vector.
*
* @SINCE_1_0.0
- * @return the length.
+ * @return The length
*/
float Length() const;
* This is faster than using Length() when performing
* threshold checks as it avoids use of the square root.
* @SINCE_1_0.0
- * @return the length of the vector squared.
+ * @return The length of the vector squared
*/
float LengthSquared() const;
* @brief Clamps the vector between minimum and maximum vectors.
*
* @SINCE_1_0.0
- * @param [in] min The minimum vector
- * @param [in] max The maximum vector
+ * @param[in] min The minimum vector
+ * @param[in] max The maximum vector
*/
void Clamp( const Vector4& min, const Vector4& max );
* @endcode
*
* @SINCE_1_0.0
- * @return the vector contents as an array of 4 floats.
+ * @return The vector contents as an array of 4 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
const float* AsFloat() const {return &x;}
* @endcode
*
* @SINCE_1_0.0
- * @return the vector contents as an array of 4 floats.
+ * @return The vector contents as an array of 4 floats
* @note inlined for performance reasons (generates less code than a function call)
*/
float* AsFloat() {return &x;}
* @brief Print a Vector4.
*
* @SINCE_1_0.0
- * @param [in] o The output stream operator.
- * @param [in] vector The vector to print.
- * @return The output stream operator.
+ * @param[in] o The output stream operator
+ * @param[in] vector The vector to print
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<<(std::ostream& o, const Vector4& vector);
/**
* @brief Returns a vector with components set to the minimum of the corresponding component in a and b.
*
- * If a=0,1,2,3 and b=4,0,1,2 returns a vector of 0,0,1,2
+ * If a=0,1,2,3 and b=4,0,1,2 returns a vector of 0,0,1,2.
* @SINCE_1_0.0
- * @param [in] a A vector
- * @param [in] b A vector
- * @return a vector containing the minimum of each component from a and b
+ * @param[in] a A vector
+ * @param[in] b A vector
+ * @return A vector containing the minimum of each component from a and b
*/
inline Vector4 Min( const Vector4& a, const Vector4& b )
{
/**
* @brief Returns a vector with components set to the maximum of the corresponding component in a and b.
*
- * If a=0,1,2,3 and b=4,0,1,2 returns a vector of 4,1,2,3
+ * If a=0,1,2,3 and b=4,0,1,2 returns a vector of 4,1,2,3.
* @SINCE_1_0.0
- * @param [in] a A vector
- * @param [in] b A vector
- * @return a vector containing the maximum of each component from a and b
+ * @param[in] a A vector
+ * @param[in] b A vector
+ * @return A vector containing the maximum of each component from a and b
*/
inline Vector4 Max( const Vector4& a, const Vector4& b )
{
* @brief Clamps each of vector v's components between minimum and maximum values.
*
* @SINCE_1_0.0
- * @param [in] v A vector
- * @param [in] min The minimum value
- * @param [in] max The maximum value
- * @return a vector containing the clamped components of v
+ * @param[in] v A vector
+ * @param[in] min The minimum value
+ * @param[in] max The maximum value
+ * @return A vector containing the clamped components of v
*/
DALI_IMPORT_API Vector4 Clamp( const Vector4& v, const float& min, const float& max );
DALI_IMPORT_API ~Any();
/**
- * @brief Pass Assert message
+ * @brief Passes Assert message.
*
* @SINCE_1_0.0
* @param[in] assertMessage Assert message to report
* @brief Constructs a Any type with the given value.
*
* @SINCE_1_0.0
- * @param[in] value The given value.
+ * @param[in] value The given value
*/
template<typename Type>
Any( const Type& value )
/**
* @brief Copy Constructor.
* @SINCE_1_0.0
- * @param[in] any Any to be copied.
+ * @param[in] any Any to be copied
*/
Any( const Any& any )
{
* @brief Assignment operator.
*
* @SINCE_1_0.0
- * @param [in] any Any to be assigned which contains a value of identical type to current contents.
+ * @param[in] any Any to be assigned which contains a value of identical type to current contents.
* @return A reference to this
* @exception DaliException If parameter any is of a different type.
*
DALI_IMPORT_API Any& operator=( const Any& any );
/**
- * @brief Get a value of type Type from container
+ * @brief Gets a value of type Type from container.
*
* @SINCE_1_0.0
* @param[in] type destination of type Type to write to
*
* @SINCE_1_0.0
* @return The std::type_info of the stored value or the type info of the void
- * type if there is no value stored.
+ * type if there is no value stored
*/
DALI_IMPORT_API const std::type_info& GetType() const;
* @brief Retrieves the stored value in the Any type.
*
* @SINCE_1_0.0
- * @return The stored value.
+ * @return The stored value
*/
template<typename Type>
const Type& Get() const
}
/**
- * @brief Return pointer of Type to the value stored
+ * @brief Returns pointer of Type to the value stored.
*
* @SINCE_1_0.0
- * @return pointer to the value or NULL if no value is contained
+ * @return pointer to the value, or NULL if no value is contained
*/
template<typename Type>
Type* GetPointer()
}
/**
- * @brief Return pointer of Type to the value stored
+ * @brief Returns pointer of Type to the value stored.
*
* @SINCE_1_0.0
- * @return pointer to the value or NULL if no value is contained
+ * @return pointer to the value, or NULL if no value is contained
*/
template<typename Type>
const Type* GetPointer() const
}
/**
- * @brief Returns whether container holds a value
+ * @brief Returns whether container holds a value.
*
* @SINCE_1_0.0
- * @return true if the container is empty, else false.
+ * @return @c true if the container is empty, else @c false
*/
bool Empty() const
{
typedef void (*DeleteFunc)( const AnyContainerBase* base );
/**
- * @brief Base container to hold type for match verification and instance cloning function
+ * @brief Base container to hold type for match verification and instance cloning function.
*
* @SINCE_1_0.0
*/
struct AnyContainerBase
{
/**
- * @brief Constructor of base container
+ * @brief Constructor of base container.
*
* @SINCE_1_0.0
* @param[in] type typeid of container
{}
/**
- * @brief Get the typeid of this container
+ * @brief Gets the typeid of this container.
*
* @SINCE_1_0.0
- * @return type
+ * @return Type
*/
const std::type_info& GetType() const
{
/**
- * @brief Templated Clone function from container base
+ * @brief Templated Clone function from container base.
*
* @SINCE_1_0.0
- * @param[in] base reference to container
+ * @param[in] base The reference to container
*/
template<typename Type>
struct AnyContainerImplCloner
};
/**
- * @brief Templated Delete function from container base
+ * @brief Templated Delete function from container base.
*
* @SINCE_1_0.0
- * @param[in] base pointer to container
+ * @param[in] base The pointer to container
*/
template<typename Type>
struct AnyContainerImplDelete
};
/**
- * @brief Templated class to hold value for type
+ * @brief Templated class to hold value for type.
*
* @SINCE_1_0.0
*/
public:
/**
- * @brief Constructor to create container holding value of type Type
+ * @brief Constructor to create container holding value of type Type.
*
* @SINCE_1_0.0
* @param[in] value Value of Type
{}
/**
- * @brief Constructor to create new container of type from and existing container (cloning)
+ * @brief Constructor to create new container of type from and existing container (cloning).
*
* @SINCE_1_0.0
- * @param[in] base reference to base container to copy from
+ * @param[in] base The reference to base container to copy from
*/
AnyContainerImpl( const AnyContainerBase& base )
: AnyContainerBase( typeid( Type ),
}
/**
- * @brief Get the container's stored value
+ * @brief Gets the container's stored value.
*
* @SINCE_1_0.0
- * @return value of type Type
+ * @return Value of type Type
*/
const Type& GetValue() const
{
}
/**
- * @brief Set the container's stored value
+ * @brief Sets the container's stored value.
*
* @SINCE_1_0.0
- * @param[in] value of type Type
+ * @param[in] value Value of type Type
*/
void SetValue( const Type& value )
{
}
/**
- * @brief Get a pointer to the value held
+ * @brief Gets a pointer to the value held.
*
* @SINCE_1_0.0
- * @return pointer to the value of type Type
+ * @return Pointer to the value of type Type
*/
Type* GetPointerToValue()
{
}
/**
- * @brief Get a pointer to the value held
+ * @brief Gets a pointer to the value held.
*
* @SINCE_1_0.0
- * @return pointer to the value of type Type
+ * @return Pointer to the value of type Type
*/
const Type* GetPointerToValue() const
{
*/
/**
- * @brief Extract a pointer to the held type of an Any object from a pointer to that Any object (NULL if empty )
+ * @brief Extracts a pointer to the held type of an Any object from a pointer to that Any object (NULL if empty).
*
* @SINCE_1_0.0
* @param[in] any Pointer to an Any object
}
/**
- * @brief Extract a const pointer to the held type of an Any object from a pointer to that Any object (NULL if empty )
+ * @brief Extracts a const pointer to the held type of an Any object from a pointer to that Any object (NULL if empty).
*
* @SINCE_1_0.0
* @param[in] any const Pointer to an Any object
}
/**
- * @brief Extract a held value of type Type from an Any object from a reference to that Any object
+ * @brief Extracts a held value of type Type from an Any object from a reference to that Any object.
*
* @SINCE_1_0.0
- * @param[in] any reference to an Any object
+ * @param[in] any The reference to an Any object
*
* @return Type value of type Type
*/
}
/**
- * @brief Extract a held value of type Type from an Any object from a const reference to that Any object
+ * @brief Extracts a held value of type Type from an Any object from a const reference to that Any object.
*
* @SINCE_1_0.0
- * @param[in] any reference to an Any object
+ * @param[in] any The reference to an Any object
*
* @return Type value of type Type
*/
}
/**
- * @brief Extract a reference to the held value of type Type from an Any object from a reference to that Any object
+ * @brief Extracts a reference to the held value of type Type from an Any object from a reference to that Any object
*
* @SINCE_1_0.0
- * @param[in] any reference to an Any object
+ * @param[in] any The reference to an Any object
*
* @return A reference to the Type value of type Type
*/
}
/**
- * @brief Extract a const reference to the held value of type Type from an Any object from a const reference to that Any object
+ * @brief Extracts a const reference to the held value of type Type from an Any object from a const reference to that Any object.
*
* @SINCE_1_0.0
- * @param[in] any reference to an Any object
+ * @param[in] any The reference to an Any object
*
* @return A const reference to the Type value of type Type
*/
* @brief This constructor is used by Dali New() methods.
*
* @SINCE_1_0.0
- * @param [in] handle A pointer to a newly allocated Dali resource
+ * @param[in] handle A pointer to a newly allocated Dali resource
*/
BaseHandle(Dali::BaseObject* handle);
BaseHandle();
/**
- * @brief Dali::BaseHandle is intended as a base class
+ * @brief Dali::BaseHandle is intended as a base class.
*
* This is non-virtual since derived BaseHandle types must not contain data.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
BaseHandle(const BaseHandle& handle);
*
* It makes this handle use the same BaseObject as the copied handle
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this handle
*/
BaseHandle& operator=(const BaseHandle& rhs);
* @brief Connects a void() functor to a specified signal.
*
* @SINCE_1_0.0
- * @param [in] connectionTracker A connection tracker which can be used to disconnect.
- * @param [in] signalName Name of the signal to connect to.
- * @param [in] functor The functor to copy.
- * @return True if the signal was available.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] signalName Name of the signal to connect to
+ * @param[in] functor The functor to copy
+ * @return True if the signal was available
* @pre The signal must be available in this object.
*/
template <class T>
}
/**
- * @brief Perform action on this object with the given action name and attributes.
+ * @brief Performs an action on this object with the given action name and attributes.
*
* Usage example: -
* @code
* handle.DoAction("show", attributes);
* @endcode
* @SINCE_1_0.0
- * @param [in] actionName The command for the action.
- * @param [in] attributes The list of attributes for the action.
- * @return The action is performed by the object or not.
+ * @param[in] actionName The command for the action
+ * @param[in] attributes The list of attributes for the action
+ * @return The action is performed by the object or not
*/
bool DoAction(const std::string& actionName, const Property::Map& attributes);
* have not registered with type-registry.
*
* @SINCE_1_0.0
- * @return The type name. Empty string if the typename does not exist.
+ * @return The type name. Empty string if the typename does not exist
*/
const std::string& GetTypeName() const;
// BaseHandle accessors
/**
- * @brief Retrieve the internal Dali resource.
+ * @brief Retrieves the internal Dali resource.
*
* This is useful for checking the reference count of the internal resource.
- * This method will not check the validity of the handle so the caller is expected to check it by using if (handle)
+ * This method will not check the validity of the handle so the caller is expected to check it by using if (handle).
* @SINCE_1_0.0
- * @return The BaseObject which is referenced by the BaseHandle.
+ * @return The BaseObject which is referenced by the BaseHandle
*/
BaseObject& GetBaseObject();
/**
- * @brief Retrieve the internal Dali resource.
+ * @brief Retrieves the internal Dali resource.
*
* This is useful for checking the reference count of the internal resource.
- * This method will not check the validity of the handle so the caller is expected to check it by using if (handle)
+ * This method will not check the validity of the handle so the caller is expected to check it by using if (handle).
* @SINCE_1_0.0
- * @return The BaseObject which is referenced by the BaseHandle.
+ * @return The BaseObject which is referenced by the BaseHandle
*/
const BaseObject& GetBaseObject() const;
* @brief Equality operator overload.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the compared handle.
- * @return true if the handle handles point to the same Dali resource, or if both are NULL.
+ * @param[in] rhs A reference to the compared handle
+ * @return True if the handle handles point to the same Dali resource, or if both are NULL
*/
bool operator==(const BaseHandle& rhs) const;
* @brief Inequality operator overload.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the compared handle.
- * @return true if the handle handles point to the different Dali resources.
+ * @param[in] rhs A reference to the compared handle
+ * @return True if the handle handles point to the different Dali resources
*/
bool operator!=(const BaseHandle& rhs) const;
/**
- * @brief Get the reference counted object pointer.
+ * @brief Gets the reference counted object pointer.
*
* @SINCE_1_0.0
- * @return A pointer to the reference counted object.
+ * @return A pointer to the reference counted object
*/
Dali::RefObject* GetObjectPtr() const;
* @brief Not intended for application developers.
*
* @SINCE_1_0.0
- * @param [in] connectionTracker A connection tracker which can be used to disconnect.
- * @param [in] signalName Name of the signal to connect to.
- * @param [in] functorDelegate A newly allocatated functor delegate (takes ownership).
- * @return True if the signal was available.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] signalName Name of the signal to connect to
+ * @param[in] functorDelegate A newly allocated functor delegate (takes ownership)
+ * @return True if the signal was available
*/
bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
* @brief Template wrapper to downcast a base object handle to derived class handle.
*
* @SINCE_1_0.0
- * @param[in] handle to a base object
- * @return handle pointer to either a valid deriving handle or an uninitialized handle
+ * @param[in] handle Handle to a base object
+ * @return Handle pointer to either a valid deriving handle or an uninitialized handle
* @pre The BaseHandle has been initialized.
*/
template< class T >
// See also BaseHandle::BooleanType() conversion
/**
- * @brief Equality operator
+ * @brief Equality operator.
* @SINCE_1_0.0
* @param[in] lhs A reference to compare
* @param[in] rhs A reference to compare to
- * @return true if the handle handles point to the same Dali resource, or if both are NULL
+ * @return True if the handle handles point to the same Dali resource, or if both are NULL
*/
template <typename T>
inline bool operator==(const BaseHandle& lhs, const T& rhs)
}
/**
- * @brief Equality operator
+ * @brief Equality operator.
* @SINCE_1_0.0
* @param[in] lhs A reference to compare
* @param[in] rhs A reference to compare to
- * @return true if the handle handles point to the different Dali resources
+ * @return True if the handle handles point to the different Dali resources
*/
template <typename T>
inline bool operator!=(const BaseHandle& lhs, const T& rhs)
}
/**
- * @brief Less than operator
+ * @brief Less than operator.
* @SINCE_1_0.0
* @param[in] lhs A reference to compare
* @param[in] rhs A reference to compare to
- * @return true if lhs less than rhs
+ * @return True if lhs less than rhs
*/
inline bool operator<(const BaseHandle& lhs, const BaseHandle& rhs)
{
* @brief Connects a void() functor to a specified signal.
*
* @SINCE_1_0.0
- * @param [in] connectionTracker A connection tracker which can be used to disconnect.
- * @param [in] signalName Name of the signal to connect to.
- * @param [in] functor The functor to copy.
- * @return True if the signal was available.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] signalName Name of the signal to connect to
+ * @param[in] functor The functor to copy
+ * @return True if the signal was available
* @pre The signal must be available in this object.
*/
template <class T>
* @brief Not intended for application developers.
*
* @SINCE_1_0.0
- * @param [in] connectionTracker A connection tracker which can be used to disconnect.
- * @param [in] signalName Name of the signal to connect to.
- * @param [in] functorDelegate A newly allocatated functor delegate (takes ownership).
- * @return True if the signal was available.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] signalName Name of the signal to connect to
+ * @param[in] functorDelegate A newly allocated functor delegate (takes ownership)
+ * @return True if the signal was available
*/
bool DoConnectSignal( ConnectionTrackerInterface* connectionTracker, const std::string& signalName, FunctorDelegate* functorDelegate );
// Helpers for public-api forwarding methods
/**
- * @brief Get the implementation of a handle.
+ * @brief Gets the implementation of a handle.
*
* @SINCE_1_0.0
* @param[in] handle The handle
- * @return A reference to the object the handle points at.
+ * @return A reference to the object the handle points at
*/
inline BaseObject& GetImplementation(Dali::BaseHandle& handle)
{
}
/**
- * @brief Get the implementation of a handle.
+ * @brief Gets the implementation of a handle.
*
* @SINCE_1_0.0
* @param[in] handle The handle
- * @return A reference to the object the handle points at.
+ * @return A reference to the object the handle points at
*/
inline const BaseObject& GetImplementation(const Dali::BaseHandle& handle)
{
public:
/**
- * @brief An Handle's capabilities can be queried using Handle::Supports()
+ * @brief Enumeration for Handle's capabilities that can be queried using Handle::Supports().
* @SINCE_1_0.0
*/
enum Capability
* @brief This constructor is used by Dali New() methods.
*
* @SINCE_1_0.0
- * @param [in] handle A pointer to a newly allocated Dali resource
+ * @param[in] handle A pointer to a newly allocated Dali resource
*/
Handle( Dali::Internal::Object* handle );
Handle();
/**
- * @brief Create a new object.
+ * @brief Creates a new object.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated object.
+ * @return A handle to a newly allocated object
*/
static Handle New();
/**
- * @brief Dali::Handle is intended as a base class
+ * @brief Dali::Handle is intended as a base class.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
Handle( const Handle& handle );
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
Handle& operator=( const Handle& rhs );
/**
- * @brief Downcast to a handle.
+ * @brief Downcasts to a handle.
*
- * If not the returned handle is left uninitialized.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
* @param[in] handle to An object
* @return handle or an uninitialized handle
static Handle DownCast( BaseHandle handle );
/**
- * @brief Query whether an handle supports a given capability.
+ * @brief Queries whether an handle supports a given capability.
*
* @SINCE_1_0.0
- * @param[in] capability The queried capability.
- * @return True if the capability is supported.
+ * @param[in] capability The queried capability
+ * @return True if the capability is supported
*/
bool Supports( Capability capability ) const;
// Properties
/**
- * @brief Query how many properties are provided by an handle.
+ * @brief Queries how many properties are provided by an handle.
*
* This may vary between instances of a class, if dynamic properties are supported.
* @SINCE_1_0.0
- * @return The number of properties.
+ * @return The number of properties
*/
unsigned int GetPropertyCount() const;
/**
- * @brief Query the name of a property.
+ * @brief Queries the name of a property.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return The name of the property.
+ * @param[in] index The index of the property
+ * @return The name of the property
*/
std::string GetPropertyName( Property::Index index ) const;
/**
- * @brief Query the index of a property.
+ * @brief Queries the index of a property.
*
* Returns the first property index that matches the given name exactly.
*
* @SINCE_1_0.0
- * @param [in] name The name of the property.
- * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name.
+ * @param[in] name The name of the property
+ * @return The index of the property, or Property::INVALID_INDEX if no property exists with the given name
*/
Property::Index GetPropertyIndex( const std::string& name ) const;
/**
- * @brief Query whether a property can be set using SetProperty().
+ * @brief Queries whether a property can be set using SetProperty().
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return True if the property is writable.
+ * @param[in] index The index of the property
+ * @return True if the property is writable
* @pre Property::INVALID_INDEX < index.
*/
bool IsPropertyWritable( Property::Index index ) const;
/**
- * @brief Query whether a writable property can be the target of an animation or constraint.
+ * @brief Queries whether a writable property can be the target of an animation or constraint.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return True if the property is animatable.
+ * @param[in] index The index of the property
+ * @return True if the property is animatable
*/
bool IsPropertyAnimatable( Property::Index index ) const;
/**
- * @brief Query whether a property can be used as in input to a constraint.
+ * @brief Queries whether a property can be used as in input to a constraint.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return True if the property can be used as a constraint input.
+ * @param[in] index The index of the property
+ * @return True if the property can be used as a constraint input
*/
bool IsPropertyAConstraintInput( Property::Index index ) const;
/**
- * @brief Query the type of a property.
+ * @brief Queries the type of a property.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return The type of the property.
+ * @param[in] index The index of the property
+ * @return The type of the property
*/
Property::Type GetPropertyType( Property::Index index ) const;
/**
- * @brief Set the value of an existing property.
+ * @brief Sets the value of an existing property.
*
* Property should be write-able. Setting a read-only property is a no-op.
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @param [in] propertyValue The new value of the property.
+ * @param[in] index The index of the property
+ * @param[in] propertyValue The new value of the property
* @pre The property types match i.e. propertyValue.GetType() is equal to GetPropertyType(index).
*/
void SetProperty( Property::Index index, const Property::Value& propertyValue );
/**
- * @brief Register a new animatable property.
+ * @brief Registers a new animatable property.
*
* @SINCE_1_0.0
- * @param [in] name The name of the property.
- * @param [in] propertyValue The new value of the property.
+ * @param[in] name The name of the property
+ * @param[in] propertyValue The new value of the property
* @return The index of the property or Property::INVALID_INDEX if registration failed
* @pre The object supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
* Property names are expected to be unique, but this is not enforced.
Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue );
/**
- * @brief Register a new property.
+ * @brief Registers a new property.
*
* Properties can be set as non animatable using property attributes.
* @SINCE_1_0.0
- * @param [in] name The name of the property.
- * @param [in] propertyValue The new value of the property.
- * @param [in] accessMode The property access mode (writable, animatable etc).
+ * @param[in] name The name of the property
+ * @param[in] propertyValue The new value of the property
+ * @param[in] accessMode The property access mode (writable, animatable etc)
* @return The index of the property
* @pre The handle supports dynamic properties i.e. Supports(Handle::DYNAMIC_PROPERTIES) returns true.
* @pre name is unused i.e. GetPropertyIndex(name) returns PropertyIndex::INVALID.
Property::Index RegisterProperty( const std::string& name, const Property::Value& propertyValue, Property::AccessMode accessMode );
/**
- * @brief Retrieve a property value.
+ * @brief Retrieves a property value.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return The property value.
+ * @param[in] index The index of the property
+ * @return The property value
*/
Property::Value GetProperty( Property::Index index ) const;
* @brief Convenience function for obtaining a property of a known type.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @return The property value.
+ * @param[in] index The index of the property
+ * @return The property value
* @pre The property types match i.e. PropertyTypes::Get<T>() is equal to GetPropertyType(index).
*/
template <typename T>
}
/**
- * @brief Retrieve all the property indices for this object (including custom properties).
+ * @brief Retrieves all the property indices for this object (including custom properties).
*
* @SINCE_1_0.0
- * @param[out] indices A container of property indices for this object.
- * @note the added container is cleared
+ * @param[out] indices A container of property indices for this object
+ * @note The added container is cleared.
*/
void GetPropertyIndices( Property::IndexContainer& indices ) const;
/**
- * @brief Add a property notification to this object.
+ * @brief Adds a property notification to this object.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @param [in] condition The notification will be triggered when this condition is satisfied.
- *
+ * @param[in] index The index of the property
+ * @param[in] condition The notification will be triggered when this condition is satisfied
* @return A handle to the newly created PropertyNotification
*/
PropertyNotification AddPropertyNotification( Property::Index index,
const PropertyCondition& condition );
/**
- * @brief Add a property notification to this object.
+ * @brief Adds a property notification to this object.
*
* @SINCE_1_0.0
- * @param [in] index The index of the property.
- * @param [in] componentIndex Index to the component of a complex property such as a Vector
- * @param [in] condition The notification will be triggered when this condition is satisfied.
- *
+ * @param[in] index The index of the property
+ * @param[in] componentIndex Index to the component of a complex property such as a Vector
+ * @param[in] condition The notification will be triggered when this condition is satisfied
* @return A handle to the newly created PropertyNotification
*/
PropertyNotification AddPropertyNotification( Property::Index index,
const PropertyCondition& condition );
/**
- * @brief Remove a property notification from this object.
+ * @brief Removes a property notification from this object.
*
* @SINCE_1_0.0
- * @param [in] propertyNotification The propertyNotification to be removed.
+ * @param[in] propertyNotification The propertyNotification to be removed
*/
void RemovePropertyNotification( Dali::PropertyNotification propertyNotification );
/**
- * @brief Remove all property notifications from this object.
+ * @brief Removes all property notifications from this object.
* @SINCE_1_0.0
*/
void RemovePropertyNotifications();
// Constraints
/**
- * @brief Remove all constraints from an Object.
+ * @brief Removes all constraints from an Object.
*
* @SINCE_1_0.0
* @pre The object has been initialized.
void RemoveConstraints();
/**
- * @brief Remove all the constraint from the Object with a matching tag.
+ * @brief Removes all the constraint from the Object with a matching tag.
*
* @SINCE_1_0.0
* @param[in] tag The tag of the constraints which will be removed
* @brief Convenience function to create an object with a custom "weight" property.
*
* @SINCE_1_0.0
- * @return A handle to a newly allocated object.
+ * @return A handle to a newly allocated object
*/
DALI_IMPORT_API Handle New();
*
* Care should be taken to not store the handle in the Observer, as this will
* have adverse effect on the life time of the Internal Object. The Handle
- * should only be used to connect to signals
+ * should only be used to connect to signals.
*
* Usage:
* ObjectRegistry registry = Stage::GetObjectRegistry();
// Typedefs
/**
- * @brief Object created signal
+ * @brief Object created signal.
* @SINCE_1_0.0
*/
typedef Signal< void ( BaseHandle ) > ObjectCreatedSignalType;
/**
- * @brief Object destroyed signal
+ * @brief Object destroyed signal.
* @SINCE_1_0.0
*/
typedef Signal< void ( const Dali::RefObject* ) > ObjectDestroyedSignalType;
ObjectRegistry();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
ObjectRegistry(const ObjectRegistry& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
ObjectRegistry& operator=(const ObjectRegistry& rhs);
* void YourCallbackName(BaseHandle object);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
ObjectCreatedSignalType& ObjectCreatedSignal();
* void YourCallbackName(const Dali::RefObject* objectPointer);
* @endcode
* @SINCE_1_0.0
- * @return The signal to connect to.
+ * @return The signal to connect to
* @pre The Object has been initialized.
*/
ObjectDestroyedSignalType& ObjectDestroyedSignal();
* @brief This constructor is used by Dali Get() method.
*
* @SINCE_1_0.0
- * @param [in] objectRegistry A pointer to a Dali resource
+ * @param[in] objectRegistry A pointer to a Dali resource
*/
explicit DALI_INTERNAL ObjectRegistry(Internal::ObjectRegistry* objectRegistry);
/// @endcond
* @brief Copy Constructor.
*
* @SINCE_1_0.0
- * @param[in] other The Array to copy from.
+ * @param[in] other The Array to copy from
*/
Array( const Array& other );
~Array();
/**
- * @brief Retrieve the number of elements in the array.
+ * @brief Retrieves the number of elements in the array.
*
* @SINCE_1_0.0
- * @return The number of elements in the array.
+ * @return The number of elements in the array
*/
SizeType Size() const
{
}
/**
- * @brief Retrieve the number of elements in the array.
+ * @brief Retrieves the number of elements in the array.
*
* @SINCE_1_0.0
- * @return The number of elements in the array.
+ * @return The number of elements in the array
*/
SizeType Count() const;
* @brief Returns whether the array is empty.
*
* @SINCE_1_0.0
- * @return true if empty, false otherwise
+ * @return @c true if empty, @c false otherwise
*/
bool Empty() const
{
void Clear();
/**
- * @brief Increase the capcity of the array.
+ * @brief Increases the capacity of the array.
* @SINCE_1_0.0
* @param[in] size The size to reserve
*/
void Reserve( SizeType size );
/**
- * @brief Resize to size.
+ * @brief Resizes to size.
* @SINCE_1_0.0
* @param[in] size The size to resize
*/
void Resize( SizeType size );
/**
- * @brief Retrieve the capacity of the array.
+ * @brief Retrieves the capacity of the array.
*
* @SINCE_1_0.0
* @return The allocated capacity of the array
SizeType Capacity();
/**
- * @brief Add an element to the array.
+ * @brief Adds an element to the array.
*
* @SINCE_1_0.0
* @param[in] value The value to add to the end of the array
* @brief Const access an element.
*
* @SINCE_1_0.0
- * @param[in] index The element index to access. No bounds checking is performed.
- *
- * @return The a reference to the element.
+ * @param[in] index The element index to access. No bounds checking is performed
+ * @return The a reference to the element
*/
const Value& GetElementAt( SizeType index ) const
{
}
/**
- * @brief Access an element.
+ * @brief Accesses an element.
*
* @SINCE_1_0.0
- * @param[in] index The element index to access. No bounds checking is performed.
- *
- * @return The a reference to the element.
+ * @param[in] index The element index to access. No bounds checking is performed
+ * @return The a reference to the element
*/
Value& GetElementAt( SizeType index )
{
* @brief Const operator to access an element.
*
* @SINCE_1_0.0
- * @param[in] index The element index to access. No bounds checking is performed.
- *
- * @return The a reference to the element.
+ * @param[in] index The element index to access. No bounds checking is performed
+ * @return The a reference to the element
*
*/
const Value& operator[]( SizeType index ) const;
* @brief Operator to access an element.
*
* @SINCE_1_0.0
- * @param[in] index The element index to access. No bounds checking is performed.
- *
- * @return The a reference to the element.
+ * @param[in] index The element index to access. No bounds checking is performed
+ * @return The a reference to the element
*
*/
Value& operator[]( SizeType index );
/**
- * @brief Assignment Operator
+ * @brief Assignment Operator.
*
* @SINCE_1_0.0
- * @param[in] other The array to copy from.
+ * @param[in] other The array to copy from
*
* @return The copied array.
*/
Array& operator=( const Array& other );
/**
- * @brief output to stream
+ * @brief Output to stream.
* @SINCE_1_1.28
*/
friend std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
};
/**
- * @brief Convert the values of the property array into a string and append to an output stream.
+ * @brief Converts the values of the property array into a string and append to an output stream.
*
* @SINCE_1_1.28
- * @param [in] stream The output stream operator.
- * @param [in] array The array to insert
- * @return The output stream operator.
+ * @param[in] stream The output stream operator
+ * @param[in] array The array to insert
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
PropertyCondition( const PropertyCondition& handle );
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
PropertyCondition& operator=( const PropertyCondition& rhs );
public:
/**
- * @brief Retrieve the arguments that this condition uses.
+ * @brief Retrieves the arguments that this condition uses.
*
* @SINCE_1_0.0
* @return The arguments used for this condition
std::size_t GetArgumentCount() const;
/**
- * @brief Retrieve the arguments that this condition uses.
+ * @brief Retrieves the arguments that this condition uses.
*
* @SINCE_1_0.0
* @param[in] index The condition index to get the argument
DALI_IMPORT_API PropertyCondition OutsideCondition( float arg0, float arg1 );
/**
- * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount
+ * @brief Detects when a property changes by stepAmount from initialValue, in both positive and negative directions. This will continue checking for multiples of stepAmount.
*
* property type:
* float (float)
DALI_IMPORT_API PropertyCondition StepCondition( float stepAmount, float initialValue = 0.0f );
/**
- * @brief Receive notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending
+ * @brief Receives notifications as a property goes above/below the inputted values. Values must be ordered and can be either ascending or descending.
*
* property type:
* float (float)
*/
/**
- * @brief These are the property index ranges.
+ * @brief Enumeration for the property index ranges.
*
* Enumerations are being used here rather than static constants so that switch statements can be
* used to compare property indices.
virtual ~PropertyInput() = 0;
/**
- * @brief Query the type of property input.
+ * @brief Queries the type of property input.
*
* @SINCE_1_0.0
- * @return The property type.
+ * @return The property type
*/
virtual Property::Type GetType() const = 0;
/**
- * @brief Retrieve a boolean value.
+ * @brief Retrieves a boolean value.
*
* @SINCE_1_0.0
- * @return The boolean value.
+ * @return The boolean value
* @pre GetType() returns Property::BOOLEAN.
*/
virtual const bool& GetBoolean() const = 0;
/**
- * @brief Retrieve a float value.
+ * @brief Retrieves a float value.
*
* @SINCE_1_0.0
- * @return The float value.
+ * @return The float value
* @pre GetType() returns Property::FLOAT.
*/
virtual const float& GetFloat() const = 0;
/**
- * @brief Retrieve an integer value.
+ * @brief Retrieves an integer value.
*
* @SINCE_1_0.0
- * @return The integer value.
+ * @return The integer value
* @pre GetType() returns Property::INTEGER.
*/
virtual const int& GetInteger() const = 0;
/**
- * @brief Retrieve a Vector2 value.
+ * @brief Retrieves a Vector2 value.
*
* @SINCE_1_0.0
- * @return The Vector2 value.
+ * @return The Vector2 value
* @pre GetType() returns Property::VECTOR2.
*/
virtual const Vector2& GetVector2() const = 0;
/**
- * @brief Retrieve a Vector3 value.
+ * @brief Retrieves a Vector3 value.
*
* @SINCE_1_0.0
- * @return The Vector3 value.
+ * @return The Vector3 value
* @pre GetType() returns Property::VECTOR3.
*/
virtual const Vector3& GetVector3() const = 0;
/**
- * @brief Retrieve a Vector4 value.
+ * @brief Retrieves a Vector4 value.
*
* @SINCE_1_0.0
- * @return The Vector4 value.
+ * @return The Vector4 value
* @pre GetType() returns Property::VECTOR4.
*/
virtual const Vector4& GetVector4() const = 0;
/**
- * @brief Retrieve a Matrix (3x3) value.
+ * @brief Retrieves a Matrix (3x3) value.
*
* @SINCE_1_0.0
- * @return The Matrix value.
+ * @return The Matrix value
* @pre GetType() returns Property::Matrix3.
*/
virtual const Matrix3& GetMatrix3() const = 0;
/**
- * @brief Retrieve a Matrix (4x4) value.
+ * @brief Retrieves a Matrix (4x4) value.
*
* @SINCE_1_0.0
- * @return The Matrix value.
+ * @return The Matrix value
* @pre GetType() returns Property::Matrix4.
*/
virtual const Matrix& GetMatrix() const = 0;
/**
- * @brief Retrieve a Quaternion value.
+ * @brief Retrieves a Quaternion value.
*
* @SINCE_1_0.0
- * @return The Quaternion value.
+ * @return The Quaternion value
* @pre GetType() returns Property::Quaternion.
*/
virtual const Quaternion& GetQuaternion() const = 0;
/**
- * @brief Retrieve the extension for the PropertyInput
+ * @brief Retrieves the extension for the PropertyInput
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
* @brief Copy Constructor.
*
* @SINCE_1_0.0
- * @param[in] other The Map to copy from.
+ * @param[in] other The Map to copy from
*/
Map( const Map& other );
~Map();
/**
- * @brief Retrieve the number of elements in the map.
+ * @brief Retrieves the number of elements in the map.
*
* @SINCE_1_0.0
- * @return The number of elements in the map.
+ * @return The number of elements in the map
*/
SizeType Count() const;
* @brief Returns whether the map is empty.
*
* @SINCE_1_0.0
- * @return true if empty, false otherwise
+ * @return @c true if empty, @c false otherwise
*/
bool Empty() const;
/**
* @brief Inserts the key-value pair in the Map, with the key type as string.
*
- * Does not check for duplicates
+ * Does not check for duplicates.
* @SINCE_1_0.0
- * @param[in] key to insert
- * @param[in] value to insert
+ * @param[in] key The key to insert
+ * @param[in] value The value to insert
*/
void Insert( const char* key, const Value& value );
/**
* @brief Inserts the key-value pair in the Map, with the key type as string.
*
- * Does not check for duplicates
+ * Does not check for duplicates.
* @SINCE_1_0.0
- * @param[in] key to insert
- * @param[in] value to insert
+ * @param[in] key The key to insert
+ * @param[in] value The value to insert
*/
void Insert( const std::string& key, const Value& value );
/**
* @brief Inserts the key-value pair in the Map, with the key type as index.
*
- * Does not check for duplicates
+ * Does not check for duplicates.
* @SINCE_1_1.39
- * @param[in] key to insert
- * @param[in] value to insert
+ * @param[in] key The key to insert
+ * @param[in] value The value to insert
*/
void Insert( Property::Index key, const Value& value );
}
/**
- * @brief Retrieve the value at the specified position.
+ * @brief Retrieves the value at the specified position.
*
* @SINCE_1_0.0
* @param[in] position The specified position
- * @return A reference to the value at the specified position.
+ * @return A reference to the value at the specified position
*
* @note Will assert if position >= Count()
*/
/**
* DEPRECATED_1_1.39 Position based retrieval is no longer supported after extending the key type to both Index and String.
*
- * @brief Retrieve the key at the specified position.
+ * @brief Retrieves the key at the specified position.
*
* @SINCE_1_0.0
* @param[in] position The specified position
- * @return A const reference to the key at the specified position.
+ * @return A const reference to the key at the specified position
*
* @note Will assert if position >= Count()
*/
/**
* DEPRECATED_1_1.39 Position based retrieval is no longer supported after extending the key type to both Index and String.
*
- * @brief Retrieve the key & the value at the specified position.
+ * @brief Retrieves the key & the value at the specified position.
*
* @SINCE_1_0.0
* @param[in] position The specified position
- * @return A reference to the pair of key and value at the specified position.
+ * @return A reference to the pair of key and value at the specified position
*
* @note Will assert if position >= Count() or key at position is an index key.
*/
* @brief Finds the value for the specified key if it exists.
*
* @SINCE_1_0.0
- * @param[in] key The key to find.
+ * @param[in] key The key to find
*
* @return A const pointer to the value if it exists, NULL otherwise
*/
* @brief Finds the value for the specified key if it exists.
*
* @SINCE_1_0.0
- * @param[in] key The key to find.
+ * @param[in] key The key to find
*
* @return A const pointer to the value if it exists, NULL otherwise
*/
* @brief Finds the value for the specified key if it exists.
*
* @SINCE_1_1.39
- * @param[in] key The key to find.
+ * @param[in] key The key to find
*
* @return A const pointer to the value if it exists, NULL otherwise
*/
* Will search for the index key first.
*
* @SINCE_1_1.45
- * @param[in] indexKey The index key to find.
- * @param[in] stringKey The string key to find.
+ * @param[in] indexKey The index key to find
+ * @param[in] stringKey The string key to find
*
* @return A const pointer to the value if it exists, NULL otherwise
*/
Value* Find( Property::Index indexKey, const std::string& stringKey ) const;
/**
- * @brief Finds the value for the specified key if it exists and its type is type
+ * @brief Finds the value for the specified key if it exists and its type is type.
*
* @SINCE_1_0.0
- * @param[in] key The key to find.
- * @param[in] type The type to check.
+ * @param[in] key The key to find
+ * @param[in] type The type to check
*
* @return A const pointer to the value if it exists, NULL otherwise
*/
Value* Find( const std::string& key, Property::Type type ) const;
/**
- * @brief Finds the value for the specified key if it exists and its type is type
+ * @brief Finds the value for the specified key if it exists and its type is type.
*
* @SINCE_1_1.39
- * @param[in] key The key to find.
- * @param[in] type The type to check.
+ * @param[in] key The key to find
+ * @param[in] type The type to check
*
* @return A const pointer to the value if it exists, NULL otherwise
*/
* Any values in 'from' will overwrite the values in the current map.
*
* @SINCE_1_0.0
- * @param[in] from The map to merge from.
+ * @param[in] from The map to merge from
*/
void Merge( const Map& from );
* @brief Const operator to access element with the specified string key.
*
* @SINCE_1_0.0
- * @param[in] key The key whose value to access.
+ * @param[in] key The key whose value to access
*
- * @return The value for the element with the specified key, if key doesn't exist, then Property::NONE is returned.
+ * @return The value for the element with the specified key, if key doesn't exist, then Property::NONE is returned
*
* @note Will assert if invalid-key is given.
*/
* @brief Operator to access the element with the specified string key.
*
* @SINCE_1_0.0
- * @param[in] key The key whose value to access.
+ * @param[in] key The key whose value to access
*
- * @return A reference to the value for the element with the specified key.
+ * @return A reference to the value for the element with the specified key
*
* @note If an element with the key does not exist, then it is created.
*/
* @brief Const operator to access element with the specified index key.
*
* @SINCE_1_1.39
- * @param[in] key The key whose value to access.
+ * @param[in] key The key whose value to access
*
- * @return The value for the element with the specified key, if key doesn't exist, then Property::NONE is returned.
+ * @return The value for the element with the specified key, if key doesn't exist, then Property::NONE is returned
*
* @note Will assert if invalid-key is given.
*/
* @brief Operator to access the element with the specified index key.
*
* @SINCE_1_1.39
- * @param[in] key The key whose value to access.
+ * @param[in] key The key whose value to access
*
- * @return A reference to the value for the element with the specified key.
+ * @return A reference to the value for the element with the specified key
*
* @note If an element with the key does not exist, then it is created.
*/
Value& operator[]( Property::Index key );
/**
- * @brief Assignment Operator
+ * @brief Assignment Operator.
*
* @SINCE_1_0.0
- * @param[in] other The map to copy from.
+ * @param[in] other The map to copy from
*
- * @return The copied map.
+ * @return The copied map
*/
Map& operator=( const Map& other );
/**
- * @brief output to stream
+ * @brief Output to stream.
* @SINCE_1_1.28
*/
friend std::ostream& operator<<( std::ostream& stream, const Property::Map& map );
};
/**
- * @brief Convert the key/value pairs of the property map into a string and append to an output stream.
+ * @brief Converts the key/value pairs of the property map into a string and append to an output stream.
*
* @SINCE_1_1.28
- * @param [in] stream The output stream operator.
- * @param [in] map The map to insert
- * @return The output stream operator.
+ * @param[in] stream The output stream operator
+ * @param[in] map The map to insert
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<<( std::ostream& stream, const Property::Map& map );
{
public:
/**
- * @brief Enumeration to describe how to check condition
+ * @brief Enumeration for description of how to check condition.
* @SINCE_1_0.0
*/
enum NotifyMode
public:
/**
- * @brief Create an uninitialized PropertyNotification; this can be initialized with PropertyNotification::New().
+ * @brief Creates an uninitialized PropertyNotification; this can be initialized with PropertyNotification::New().
*
* Calling member functions with an uninitialized Dali::Object is not allowed.
* @SINCE_1_0.0
PropertyNotification();
/**
- * @brief Downcast a handle to PropertyNotification handle.
+ * @brief Downcasts a handle to PropertyNotification handle.
*
- * If handle points to an PropertyNotification object the downcast
- * produces valid handle. If not the returned handle is left
+ * If handle points to a PropertyNotification object, the downcast
+ * produces valid handle. If not, the returned handle is left
* uninitialized.
*
* @SINCE_1_0.0
static PropertyNotification DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
PropertyNotification(const PropertyNotification& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
PropertyNotification& operator=(const PropertyNotification& rhs);
/**
- * @brief Get the condition of this notification
+ * @brief Gets the condition of this notification.
*
* @SINCE_1_0.0
* @return The condition is returned
PropertyCondition GetCondition();
/**
- * @brief Get the condition of this notification
+ * @brief Gets the condition of this notification.
*
* @SINCE_1_0.0
* @return The condition is returned
const PropertyCondition& GetCondition() const;
/**
- * @brief Get the target handle that this notification is observing.
+ * @brief Gets the target handle that this notification is observing.
* @SINCE_1_0.0
* @return The target handle
*/
Dali::Handle GetTarget() const;
/**
- * @brief Get the target handle's property index that this notification
+ * @brief Gets the target handle's property index that this notification
* is observing.
*
* @SINCE_1_0.0
- * @return The target property.
+ * @return The target property
*/
Property::Index GetTargetProperty() const;
* @brief Retrieves the current Notification mode.
*
* @SINCE_1_0.0
- * @return Notification mode.
+ * @return Notification mode
*/
NotifyMode GetNotifyMode();
bool GetNotifyResult() const;
/**
- * @brief Connect to this signal to be notified when the notification has occurred.
+ * @brief Connects to this signal to be notified when the notification has occurred.
*
* @SINCE_1_0.0
- * @return A signal object to Connect() with.
+ * @return A signal object to Connect() with
*/
PropertyNotifySignalType& NotifySignal();
* @brief This constructor is used by Dali New() methods.
*
* @SINCE_1_0.0
- * @param [in] propertyNotification A pointer to a newly allocated Dali resource
+ * @param[in] propertyNotification A pointer to a newly allocated Dali resource
*/
explicit DALI_INTERNAL PropertyNotification(Internal::PropertyNotification* propertyNotification);
/// @endcond
{
/**
- * @brief Retrieve the name of a property type.
+ * @brief Retrieves the name of a property type.
*
* @SINCE_1_0.0
- * @param [in] type The property type.
- * @return The name of this type.
+ * @param[in] type The property type
+ * @return The name of this type
*/
DALI_IMPORT_API const char* GetName(Property::Type type);
/**
- * @brief Retrieve an enumerated property type.
+ * @brief Retrieves an enumerated property type.
*
* New versions of this templated function must be defined for future types.
* @SINCE_1_0.0
- * @return The property type.
+ * @return The property type
*/
template <typename T>
inline Property::Type Get() { return Property::NONE; }
Value();
/**
- * @brief Create a boolean property value.
+ * @brief Creates a boolean property value.
*
* @SINCE_1_0.0
- * @param [in] boolValue A boolean value.
+ * @param[in] boolValue A boolean value
*/
Value( bool boolValue );
/**
- * @brief Create an integer property value.
+ * @brief Creates an integer property value.
*
* @SINCE_1_0.0
- * @param [in] integerValue An integer value.
+ * @param[in] integerValue An integer value
*/
Value( int integerValue );
/**
- * @brief Create a float property value.
+ * @brief Creates a float property value.
*
* @SINCE_1_0.0
- * @param [in] floatValue A floating-point value.
+ * @param[in] floatValue A floating-point value
*/
Value( float floatValue );
/**
- * @brief Create a Vector2 property value.
+ * @brief Creates a Vector2 property value.
*
* @SINCE_1_0.0
- * @param [in] vectorValue A vector of 2 floating-point values.
+ * @param[in] vectorValue A vector of 2 floating-point values
*/
Value( const Vector2& vectorValue );
/**
- * @brief Create a Vector3 property value.
+ * @brief Creates a Vector3 property value.
*
* @SINCE_1_0.0
- * @param [in] vectorValue A vector of 3 floating-point values.
+ * @param[in] vectorValue A vector of 3 floating-point values
*/
Value( const Vector3& vectorValue );
/**
- * @brief Create a Vector4 property value.
+ * @brief Creates a Vector4 property value.
*
* @SINCE_1_0.0
- * @param [in] vectorValue A vector of 4 floating-point values.
+ * @param[in] vectorValue A vector of 4 floating-point values
*/
Value( const Vector4& vectorValue );
/**
- * @brief Create a Matrix3 property value.
+ * @brief Creates a Matrix3 property value.
*
* @SINCE_1_0.0
- * @param [in] matrixValue A matrix of 3x3 floating-point values.
+ * @param[in] matrixValue A matrix of 3x3 floating-point values
*/
Value( const Matrix3& matrixValue );
/**
- * @brief Create a Matrix property value.
+ * @brief Creates a Matrix property value.
*
* @SINCE_1_0.0
- * @param [in] matrixValue A matrix of 4x4 floating-point values.
+ * @param[in] matrixValue A matrix of 4x4 floating-point values
*/
Value( const Matrix& matrixValue );
/**
- * @brief Create a Vector4 property value.
+ * @brief Creates a Vector4 property value.
*
* @SINCE_1_0.0
- * @param [in] vectorValue A vector of 4 integer values.
+ * @param[in] vectorValue A vector of 4 integer values
*/
Value( const Rect<int>& vectorValue );
/**
- * @brief Create an orientation property value.
+ * @brief Creates an orientation property value.
*
* @SINCE_1_0.0
- * @param [in] angleAxis An angle-axis representing the rotation.
+ * @param[in] angleAxis An angle-axis representing the rotation
*/
Value( const AngleAxis& angleAxis );
/**
- * @brief Create an orientation property value.
+ * @brief Creates an orientation property value.
*
* @SINCE_1_0.0
- * @param [in] quaternion A quaternion representing the rotation.
+ * @param[in] quaternion A quaternion representing the rotation
*/
Value( const Quaternion& quaternion );
/**
- * @brief Create an string property value.
+ * @brief Creates an string property value.
*
* @SINCE_1_0.0
- * @param [in] stringValue A string.
+ * @param[in] stringValue A string
*/
Value( const std::string& stringValue );
/**
- * @brief Create an string property value.
+ * @brief Creates a string property value.
*
* @SINCE_1_0.0
- * @param [in] stringValue A string.
+ * @param[in] stringValue A string
*/
Value( const char* stringValue );
/**
- * @brief Create an array property value.
+ * @brief Creates an array property value.
*
* @SINCE_1_0.0
- * @param [in] arrayValue An array
+ * @param[in] arrayValue An array
*/
Value( Property::Array& arrayValue );
/**
- * @brief Create a map property value.
+ * @brief Creates a map property value.
*
* @SINCE_1_0.0
- * @param [in] mapValue An array
+ * @param[in] mapValue An array
*/
Value( Property::Map& mapValue );
/**
- * @brief Explicitly set a type and initialize it.
+ * @brief Explicitly sets a type and initialize it.
*
* @SINCE_1_0.0
- * @param [in] type The property value type.
+ * @param[in] type The property value type
*/
explicit Value( Type type );
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_0.0
- * @param [in] value The property value to copy.
+ * @param[in] value The property value to copy
*/
Value( const Value& value );
/**
- * @brief Assign a property value.
+ * @brief Assigns a property value.
*
* @SINCE_1_0.0
- * @param [in] value The property value to assign from.
+ * @param[in] value The property value to assign from
* @return a reference to this
*/
Value& operator=( const Value& value );
~Value();
/**
- * @brief Query the type of this property value.
+ * @brief Queries the type of this property value.
*
* @SINCE_1_0.0
- * @return The type ID.
+ * @return The type ID
*/
Type GetType() const;
/**
- * @brief Retrieve a specific value.
+ * @brief Retrieves a specific value.
*
- * Works on a best-effort approach; if value type is not convertible returns a default value of the type
+ * Works on a best-effort approach; if value type is not convertible returns a default value of the type.
*
* @SINCE_1_0.0
- * @return A value of type T.
+ * @return A value of type T
*/
template <typename T>
T DALI_INTERNAL Get() const
}
/**
- * @brief Retrieve a boolean value.
+ * @brief Retrieves a boolean value.
*
* @SINCE_1_0.0
- * @param [out] boolValue On return, a boolean value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] boolValue On return, a boolean value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to bool.
*/
bool Get( bool& boolValue ) const;
/**
- * @brief Retrieve a floating-point value.
+ * @brief Retrieves a floating-point value.
*
* @SINCE_1_0.0
- * @param [out] floatValue On return, a floating-point value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] floatValue On return, a floating-point value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to float.
*/
bool Get( float& floatValue ) const;
/**
- * @brief Retrieve an integer value.
+ * @brief Retrieves an integer value.
*
* @SINCE_1_0.0
- * @param [out] integerValue On return, an integer value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] integerValue On return, an integer value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to int.
*/
bool Get( int& integerValue ) const;
/**
- * @brief Retrieve an integer rectangle.
+ * @brief Retrieves an integer rectangle.
*
* @SINCE_1_0.0
- * @param [out] rect On return, an integer rectangle.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] rect On return, an integer rectangle
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Rect<int>.
*/
bool Get( Rect<int>& rect ) const;
/**
- * @brief Retrieve a vector value.
+ * @brief Retrieves a vector value.
*
* @SINCE_1_0.0
- * @param [out] vectorValue On return, a vector value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] vectorValue On return, a vector value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Vector2.
*/
bool Get( Vector2& vectorValue ) const;
/**
- * @brief Retrieve a vector value.
+ * @brief Retrieves a vector value.
*
* @SINCE_1_0.0
- * @param [out] vectorValue On return, a vector value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] vectorValue On return, a vector value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Vector3.
*/
bool Get( Vector3& vectorValue ) const;
/**
- * @brief Retrieve a vector value.
+ * @brief Retrieves a vector value.
*
* @SINCE_1_0.0
- * @param [out] vectorValue On return, a vector value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] vectorValue On return, a vector value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Vector4.
*/
bool Get( Vector4& vectorValue ) const;
/**
- * @brief Retrieve a matrix3 value.
+ * @brief Retrieves a matrix3 value.
*
* @SINCE_1_0.0
- * @param [out] matrixValue On return, a matrix3 value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] matrixValue On return, a matrix3 value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Matrix3.
*/
bool Get( Matrix3& matrixValue ) const;
/**
- * @brief Retrieve a matrix value.
+ * @brief Retrieves a matrix value.
*
* @SINCE_1_0.0
- * @param [out] matrixValue On return, a matrix value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] matrixValue On return, a matrix value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Matrix.
*/
bool Get( Matrix& matrixValue ) const;
/**
- * @brief Retrieve an angle-axis value.
+ * @brief Retrieves an angle-axis value.
*
* @SINCE_1_0.0
- * @param [out] angleAxisValue On return, a angle-axis value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] angleAxisValue On return, a angle-axis value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to AngleAxis.
*/
bool Get( AngleAxis& angleAxisValue ) const;
/**
- * @brief Retrieve a quaternion value.
+ * @brief Retrieves a quaternion value.
*
* @SINCE_1_0.0
- * @param [out] quaternionValue On return, a quaternion value.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] quaternionValue On return, a quaternion value
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to Quaternion.
*/
bool Get( Quaternion& quaternionValue ) const;
/**
- * @brief Retrieve an string property value.
+ * @brief Retrieves an string property value.
*
* @SINCE_1_0.0
- * @param [out] stringValue A string.
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] stringValue A string
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() is a type convertible to string.
*/
bool Get( std::string& stringValue ) const;
/**
- * @brief Retrieve an array property value.
+ * @brief Retrieves an array property value.
*
* @SINCE_1_0.0
- * @param [out] arrayValue The array as a vector Property Values
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] arrayValue The array as a vector Property Values
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() returns Property::ARRAY.
*/
bool Get( Property::Array& arrayValue ) const;
/**
- * @brief Retrieve an map property value.
+ * @brief Retrieves an map property value.
*
* @SINCE_1_0.0
- * @param [out] mapValue The map as vector of string and Property Value pairs
- * @return true if the value is successfully retrieved, false if the type is not convertible
+ * @param[out] mapValue The map as vector of string and Property Value pairs
+ * @return @c true if the value is successfully retrieved, @c false if the type is not convertible
* @pre GetType() returns Property::MAP.
*/
bool Get( Property::Map& mapValue ) const;
/**
- * @brief Retrieve the Array API of the Property::Value without copying the contents of the map
+ * @brief Retrieves the Array API of the Property::Value without copying the contents of the map.
*
* @SINCE_1_0.0
- * @return the Array API of the Property::Value or NULL if not a Property::Array
+ * @return The Array API of the Property::Value or NULL if not a Property::Array
*/
Property::Array* GetArray() const;
/**
- * @brief Retrieve the Map API of the Property::Value without copying the contents of the map
+ * @brief Retrieves the Map API of the Property::Value without copying the contents of the map.
*
* @SINCE_1_0.0
- * @return the Map API of the Property::Value or NULL if not a Property::Map
+ * @return The Map API of the Property::Value or NULL if not a Property::Map
*/
Property::Map* GetMap() const;
/**
- * @brief output to stream
+ * @brief Output to stream.
* @SINCE_1_0.0
*/
friend std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
};
/**
- * @brief Convert the value of the property into a string and append to an output stream.
+ * @brief Converts the value of the property into a string and append to an output stream.
*
* @SINCE_1_0.0
- * @param [in] ouputStream The output stream operator.
- * @param [in] value The value to insert
- * @return The output stream operator.
+ * @param[in] ouputStream The output stream operator
+ * @param[in] value The value to insert
+ * @return The output stream operator
*/
DALI_IMPORT_API std::ostream& operator<<( std::ostream& ouputStream, const Property::Value& value );
class Array;
/**
- * @brief The property types supported.
+ * @brief Enumeration for the property types supported.
* @SINCE_1_0.0
*/
enum Type
};
/**
- * @brief The access mode for custom properties
+ * @brief Enumeration for the access mode for custom properties.
* @SINCE_1_0.0
*/
enum AccessMode
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyIndex The index of a property.
+ * @param[in] object A valid handle to the target object
+ * @param[in] propertyIndex The index of a property
*/
Property( Handle& object, Property::Index propertyIndex );
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyIndex The index of a property.
- * @param [in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
+ * @param[in] object A valid handle to the target object.
+ * @param[in] propertyIndex The index of a property.
+ * @param[in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
*/
Property( Handle& object, Property::Index propertyIndex, int componentIndex );
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyName The property name.
+ * @param[in] object A valid handle to the target object
+ * @param[in] propertyName The property name
* @note This performs a property index query and is therefore slower than
* constructing a Property directly with the index.
*/
Property( Handle& object, const std::string& propertyName );
/**
- * @brief Create a Property instance.
+ * @brief Creates a Property instance.
*
* @SINCE_1_0.0
- * @param [in] object A valid handle to the target object.
- * @param [in] propertyName The property name.
- * @param [in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
+ * @param[in] object A valid handle to the target object
+ * @param[in] propertyName The property name
+ * @param[in] componentIndex Index to a sub component of a property, for use with Vector2, Vector3 and Vector4. -1 for main property (default is -1)
* @note This performs a property index query and is therefore slower than
* constructing a Property directly with the index.
*/
public:
/**
- * @brief Increment the object's reference count.
+ * @brief Increments the object's reference count.
* @SINCE_1_0.0
*/
void Reference();
/**
- * @brief Decrement the object's reference count.
+ * @brief Decrements the object's reference count.
*
* When the reference count drops to zero, the object will self-destruct.
* @SINCE_1_0.0
void Unreference();
/**
- * @brief Retrieve the object's reference count.
+ * @brief Retrieves the object's reference count.
*
* @SINCE_1_0.0
* @return The reference count
* The newly copied object will have a reference count of zero.
* @SINCE_1_0.0
* @param[in] rhs The object to copy
- * @return a reference to this
+ * @return A reference to this
*/
RefObject& operator=(const RefObject& rhs);
* @brief Connects a callback function with the object's signals.
*
* @SINCE_1_0.0
- * @param[in] object The object providing the signal.
- * @param[in] tracker Used to disconnect the signal.
- * @param[in] signalName The signal to connect to.
- * @param[in] functor A newly allocated FunctorDelegate.
- * @return True if the signal was connected.
+ * @param[in] object The object providing the signal
+ * @param[in] tracker Used to disconnect the signal
+ * @param[in] signalName The signal to connect to
+ * @param[in] functor A newly allocated FunctorDelegate
+ * @return True if the signal was connected
* @post If a signal was connected, ownership of functor was passed to CallbackBase. Otherwise the caller is responsible for deleting the unused functor.
*/
typedef bool (*SignalConnectorFunction)(BaseObject* object, ConnectionTrackerInterface* tracker, const std::string& signalName, FunctorDelegate* functor);
* @brief Callback to set an event-thread only property.
*
* @SINCE_1_0.0
- * @param[in] object The object whose property should be set.
- * @param[in] index The index of the property being set.
- * @param[in] value The new value of the property for the object specified.
+ * @param[in] object The object whose property should be set
+ * @param[in] index The index of the property being set
+ * @param[in] value The new value of the property for the object specified
* @see PropertyRegistration.
*/
typedef void (*SetPropertyFunction)( BaseObject* object, Property::Index index, const Property::Value& value );
* @brief Callback to get the value of an event-thread only property.
*
* @SINCE_1_0.0
- * @param[in] object The object whose property value is required.
- * @param[in] index The index of the property required.
- * @return The current value of the property for the object specified.
+ * @param[in] object The object whose property value is required
+ * @param[in] index The index of the property required
+ * @return The current value of the property for the object specified
* @see PropertyRegistration.
*/
typedef Property::Value (*GetPropertyFunction)( BaseObject* object, Property::Index index );
TypeInfo();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
TypeInfo(const TypeInfo& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
TypeInfo& operator=(const TypeInfo& rhs);
/**
- * @brief Retrieve the type name for this type.
+ * @brief Retrieves the type name for this type.
*
* @SINCE_1_0.0
- * @return string name
+ * @return String name
*/
const std::string& GetName() const;
/**
- * @brief Retrieve the base type name for this type.
+ * @brief Retrieves the base type name for this type.
*
* @SINCE_1_0.0
- * @return string of base name
+ * @return String of base name
*/
const std::string& GetBaseName() const;
/**
- * @brief Create an object from this type.
+ * @brief Creates an object from this type.
*
* @SINCE_1_0.0
- * @return the BaseHandle for the newly created object
+ * @return The BaseHandle for the newly created object
*/
BaseHandle CreateInstance() const;
/**
- * @brief Retrieve the creator function for this type.
+ * @brief Retrieves the creator function for this type.
*
* @SINCE_1_0.0
- * @return the creator function
+ * @return The creator function
*/
CreateFunction GetCreator() const;
/**
- * @brief Retrieve the number of actions for this type.
+ * @brief Retrieves the number of actions for this type.
*
* @SINCE_1_0.0
* @return The count
size_t GetActionCount() const;
/**
- * @brief Retrieve the action name for the index.
+ * @brief Retrieves the action name for the index.
*
* @SINCE_1_0.0
* @param[in] index Index to lookup
- * @return action name or empty string where index is invalid
+ * @return Action name or empty string where index is invalid
*/
std::string GetActionName(size_t index);
/**
- * @brief Retrieve the number of signals for this type.
+ * @brief Retrieves the number of signals for this type.
*
* @SINCE_1_0.0
* @return The count
size_t GetSignalCount() const;
/**
- * @brief Retrieve the signal name for the index.
+ * @brief Retrieves the signal name for the index.
*
* @SINCE_1_0.0
* @param[in] index Index to lookup
- * @return signal name or empty string where index is invalid
+ * @return Signal name or empty string where index is invalid
*/
std::string GetSignalName(size_t index);
/**
- * @brief Retrieve the number of event side type registered properties for this type.
+ * @brief Retrieves the number of event side type registered properties for this type.
*
- * This count does not include all properties
+ * This count does not include all properties.
* @SINCE_1_0.0
* @return The count
*/
// Properties
/**
- * @brief Retrieve all the property indices for this type.
+ * @brief Retrieves all the property indices for this type.
*
* @SINCE_1_0.0
* @param[out] indices Container of property indices
* @brief Given a property index, retrieve the property name associated with it.
*
* @SINCE_1_0.0
- * @param[in] index The property index.
- * @return The name of the property at the given index.
+ * @param[in] index The property index
+ * @return The name of the property at the given index
* @exception DaliException If index is not valid.
*
*/
* @brief This constructor is used by Dali Get() method.
*
* @SINCE_1_0.0
- * @param [in] typeInfo A pointer to a Dali resource
+ * @param[in] typeInfo A pointer to a Dali resource
*/
explicit DALI_INTERNAL TypeInfo(Internal::TypeInfo* typeInfo);
/// @endcond
#include <dali/public-api/object/type-registry.h>
/**
- * @brief These macros are used internally by the property macros.
+ * @brief Definition for macros that are used internally by the property macros.
* Use the the property macros in the section below this one (without the _INTERNAL postfix) when defining properties.
* These internal macros exist as to perform the compile-time check on the enumeration order, the __COUNTER__ macro is used twice.
* Using it twice within the same macro would result in two different values.
* PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000
* };
*
- * ///< @brief An enumeration of properties belonging to the Button class.
+ * ///< @brief Enumeration for the instance of properties belonging to the Button class.
* struct Property
* {
* enum
{
public:
/**
- * @brief Get Type Registry handle.
+ * @brief Gets Type Registry handle.
*
* @SINCE_1_0.0
* @return TypeRegistry handle
TypeRegistry();
/**
- * @brief destructor.
+ * @brief Destructor.
* @SINCE_1_0.0
*/
~TypeRegistry();
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
TypeRegistry(const TypeRegistry& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
TypeRegistry& operator=(const TypeRegistry& rhs);
/**
- * @brief Get TypeInfo for a registered type.
+ * @brief Gets TypeInfo for a registered type.
*
* @SINCE_1_0.0
- * @param [in] uniqueTypeName A unique type name
- * @return TypeInfo if the type exists otherwise an empty handle
+ * @param[in] uniqueTypeName A unique type name
+ * @return TypeInfo if the type exists, otherwise an empty handle
*/
TypeInfo GetTypeInfo( const std::string &uniqueTypeName );
/**
- * @brief Get TypeInfo for a registered type.
+ * @brief Gets TypeInfo for a registered type.
*
* @SINCE_1_0.0
- * @param [in] registerType The registered type info
- * @return TypeInfo if the type exists otherwise an empty handle
+ * @param[in] registerType The registered type info
+ * @return TypeInfo if the type exists, otherwise an empty handle
*/
TypeInfo GetTypeInfo( const std::type_info& registerType );
/**
- * @brief Get type name count.
+ * @brief Gets type name count.
*
* @SINCE_1_0.0
* @return The count
size_t GetTypeNameCount() const;
/**
- * @brief Get type names by index.
+ * @brief Gets type names by index.
*
* @SINCE_1_0.0
* @param[in] index The index to get the type name
* @brief This constructor is used by Dali Get() method.
*
* @SINCE_1_0.0
- * @param [in] typeRegistry A pointer to a Dali resource
+ * @param[in] typeRegistry A pointer to a Dali resource
*/
explicit DALI_INTERNAL TypeRegistry(Internal::TypeRegistry*typeRegistry);
/// @endcond
};
/**
- * @brief Register a type from type info.
+ * @brief Registers a type from type info.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API TypeRegistration
* @brief Constructor registers the type creation function.
*
* @SINCE_1_0.0
- * @param [in] registerType the type info for the type to be registered
- * @param [in] baseType the base type info of registerType
- * @param [in] f registerType instance creation function
+ * @param[in] registerType The type info for the type to be registered
+ * @param[in] baseType The base type info of registerType
+ * @param[in] f registerType Instance creation function
*/
TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
TypeInfo::CreateFunction f );
* @brief Constructor registers the type creation function.
*
* @SINCE_1_0.0
- * @param [in] registerType the type info for the type to be registered
- * @param [in] baseType the base type info of registerType
- * @param [in] f registerType instance creation function
- * @param [in] callCreateOnInit If true the creation function is called as part of Dali initialisation
+ * @param[in] registerType the type info for the type to be registered
+ * @param[in] baseType the base type info of registerType
+ * @param[in] f registerType instance creation function
+ * @param[in] callCreateOnInit If true the creation function is called as part of Dali initialization
*/
TypeRegistration( const std::type_info& registerType, const std::type_info& baseType,
TypeInfo::CreateFunction f, bool callCreateOnInit );
* This allows types to be created dynamically from script. The name must be
* unique for successful registration.
* @SINCE_1_0.0
- * @param [in] name the name of the type to be registered
- * @param [in] baseType the base type info of registerType
- * @param [in] f registerType instance creation function
+ * @param[in] name the name of the type to be registered
+ * @param[in] baseType the base type info of registerType
+ * @param[in] f registerType instance creation function
*/
TypeRegistration( const std::string& name, const std::type_info& baseType,
TypeInfo::CreateFunction f );
* @brief The name the type is registered under (derived from type_info).
*
* @SINCE_1_0.0
- * @return the registered name or empty if unregistered
+ * @return The registered name or empty if unregistered
*/
const std::string RegisteredName() const;
};
/**
- * @brief Register a signal connector function to a registered type.
+ * @brief Registers a signal connector function to a registered type.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API SignalConnectorType
* @brief Constructor registers the type creation function.
*
* @SINCE_1_0.0
- * @param [in] typeRegistration The TypeRegistration object
- * @param [in] name The signal name
- * @param [in] func The signal connector function
+ * @param[in] typeRegistration The TypeRegistration object
+ * @param[in] name The signal name
+ * @param[in] func The signal connector function
*/
SignalConnectorType( TypeRegistration& typeRegistration, const std::string& name, TypeInfo::SignalConnectorFunction func );
};
/**
- * @brief Register an action function.
+ * @brief Registers an action function.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API TypeAction
* @brief Constructor registers the type creation function.
*
* @SINCE_1_0.0
- * @param [in] registered The TypeRegistration object
- * @param [in] name The action name
- * @param [in] f The action function
+ * @param[in] registered The TypeRegistration object
+ * @param[in] name The action name
+ * @param[in] f The action function
*/
TypeAction( TypeRegistration ®istered, const std::string &name, TypeInfo::ActionFunction f);
};
/**
- * @brief Register a property for the given type.
+ * @brief Registers a property for the given type.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API PropertyRegistration
* @endcode
*
* @SINCE_1_0.0
- * @param [in] registered The TypeRegistration object
- * @param [in] name The name of the property
- * @param [in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive.
- * @param [in] type The property value type.
- * @param [in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only.
- * @param [in] getFunc The function to call to retrieve the current value of the property. MUST be provided.
- *
+ * @param[in] registered The TypeRegistration object
+ * @param[in] name The name of the property
+ * @param[in] index The property index. Must be a value between PROPERTY_REGISTRATION_START_INDEX and PROPERTY_REGISTRATION_MAX_INDEX inclusive
+ * @param[in] type The property value type
+ * @param[in] setFunc The function to call when setting the property. If NULL, then the property becomes read-only
+ * @param[in] getFunc The function to call to retrieve the current value of the property. MUST be provided
* @pre "registered" must be registered with the TypeRegistry.
* @note The "index" value must be between START_INDEX and MAX_INDEX inclusive.
* @note If "setFunc" is NULL, then the property becomes a read-only property.
- * @note "getFunc" MUST be provided
+ * @note "getFunc" MUST be provided.
*
*/
PropertyRegistration( TypeRegistration& registered,
};
/**
- * @brief Register an animatable property for the given type.
+ * @brief Registers an animatable property for the given type.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API AnimatablePropertyRegistration
* functions.
*
* @SINCE_1_0.0
- * @param [in] registered The TypeRegistration object
- * @param [in] name The name of the property
- * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
- * @param [in] type The property value type.
- *
+ * @param[in] registered The TypeRegistration object
+ * @param[in] name The name of the property
+ * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
+ * @param[in] type The property value type
* @pre "registered" must be registered with the TypeRegistry.
*/
AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
* functions.
*
* @SINCE_1_1.18
- * @param [in] registered The TypeRegistration object
- * @param [in] name The name of the property
- * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
- * @param [in] value The property default value.
- *
+ * @param[in] registered The TypeRegistration object
+ * @param[in] name The name of the property
+ * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
+ * @param[in] value The property default value
* @pre "registered" must be registered with the TypeRegistry.
*/
AnimatablePropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, const Property::Value& value );
};
/**
- * @brief Register a component of animatable property for the given component index.
+ * @brief Registers a component of animatable property for the given component index.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API AnimatablePropertyComponentRegistration
* value of the property can be retrieved and set via specified functions.
*
* @SINCE_1_0.0
- * @param [in] registered The TypeRegistration object
- * @param [in] name The name of the component
- * @param [in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
- * @param [in] baseIndex The index of the base animatable property. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
- * @param [in] componentIndex The index of the component (e.g. 0 for the x component of a Vector2 property and 1 for the y component of a Vector2 property).
- *
+ * @param[in] registered The TypeRegistration object
+ * @param[in] name The name of the component
+ * @param[in] index The property index. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
+ * @param[in] baseIndex The index of the base animatable property. Must be a value between ANIMATABLE_PROPERTY_REGISTRATION_START_INDEX and ANIMATABLE_PROPERTY_REGISTRATION_MAX_INDEX inclusive
+ * @param[in] componentIndex The index of the component (e.g. 0 for the x component of a Vector2 property and 1 for the y component of a Vector2 property)
* @pre "registered" must be registered with the TypeRegistry.
*/
AnimatablePropertyComponentRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Index baseIndex, unsigned int componentIndex );
};
/**
- * @brief Register a child property for the given type.
+ * @brief Registers a child property for the given type.
* @SINCE_1_1.35
*/
class DALI_IMPORT_API ChildPropertyRegistration
* that the parent supports in its children) with the registered type.
*
* @SINCE_1_1.35
- * @param [in] registered The TypeRegistration object
- * @param [in] name The name of the property
- * @param [in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive.
- * @param [in] type The property value type.
- *
+ * @param[in] registered The TypeRegistration object
+ * @param[in] name The name of the property
+ * @param[in] index The property index. Must be a value between CHILD_PROPERTY_REGISTRATION_START_INDEX and CHILD_PROPERTY_REGISTRATION_MAX_INDEX inclusive
+ * @param[in] type The property value type
* @pre "registered" must be registered with the TypeRegistry.
*/
ChildPropertyRegistration( TypeRegistration& registered, const std::string& name, Property::Index index, Property::Type type );
public:
/**
- * @brief Create an empty RenderTaskList handle.
+ * @brief Creates an empty RenderTaskList handle.
*
* This can be initialised with Stage::GetRenderTaskList().
* @SINCE_1_0.0
RenderTaskList();
/**
- * @brief Downcast a handle to RenderTaskList handle.
+ * @brief Downcasts a handle to RenderTaskList handle.
*
* If handle points to a RenderTaskList the downcast produces valid
- * handle. If not the returned handle is left uninitialized.
+ * handle. If not, the returned handle is left uninitialized.
*
* @SINCE_1_0.0
- * @param[in] handle A handle to an object.
- * @return A handle to a RenderTaskList or an uninitialized handle.
+ * @param[in] handle A handle to an object
+ * @return A handle to a RenderTaskList or an uninitialized handle
*/
static RenderTaskList DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param [in] rhs A reference to the copied handle
* @return A reference to this
*/
RenderTaskList& operator=(const RenderTaskList& rhs);
/**
- * @brief Create a new RenderTask.
+ * @brief Creates a new RenderTask.
*
* This will be appended to the list of render-tasks.
* @SINCE_1_0.0
- * @return A valid handle to a new RenderTask.
+ * @return A valid handle to a new RenderTask
*/
RenderTask CreateTask();
/**
- * @brief Remove a RenderTask from the list of render-tasks.
+ * @brief Removes a RenderTask from the list of render-tasks.
* @SINCE_1_0.0
* @param[in] task The render-task to remove.
*/
void RemoveTask( RenderTask task );
/**
- * @brief Query the number of render-tasks in the list.
+ * @brief Queries the number of render-tasks in the list.
*
* This is ordered i.e. the task with index 0 is the first to be processed each frame.
* @SINCE_1_0.0
- * @return The number of render-tasks.
+ * @return The number of render-tasks
*/
unsigned int GetTaskCount() const;
/**
- * @brief Retrieve a render-task.
+ * @brief Retrieves a render-task.
*
* @SINCE_1_0.0
* @param[in] index The index of the render task to retrieve
- * @return A handle to the render-task.
+ * @return A handle to the render-task
* @pre index should be in range i.e. less than GetTaskCount().
*/
RenderTask GetTask( unsigned int index ) const;
/// @cond internal
/**
- * @brief This constructor is used by Dali New() methods
+ * @brief This constructor is used by Dali New() methods.
*
* @SINCE_1_0.0
* @param [in] renderTask A pointer to a newly allocated render-task
*
* All RenderTasks which target a frame-buffer (i.e. off screen) will be rendered before all RenderTasks
* which target the default GL surface. This allows the user to render intermediate targets which are used
- * later when targetting the screen.
+ * later when targeting the screen.
*
- * A RenderTask targetting a frame-buffer can still be hit-tested, provided that the
+ * A RenderTask targeting a frame-buffer can still be hit-tested, provided that the
* screen->frame-buffer coordinate conversion is successful; see SetScreenToFrameBufferFunction().
*
* If the refresh rate id REFRESH_ONCE and a "Finish" signal is connected, it will be emitted when the RenderTask is completed.
public:
/**
- * @brief An enumeration of properties belonging to the RenderTask class.
+ * @brief Enumeration for instances of properties belonging to the RenderTask class.
* @SINCE_1_0.0
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the RenderTask class.
+ * @brief Enumeration for instances of properties belonging to the RenderTask class.
* @SINCE_1_0.0
*/
enum
* @details By default, the sync object is not created.
* When native image source is used as render target, in order to track when the render to pixmap is completed, the GL sync should be enabled.
* Thus the RENDER_ONCE finished signal can be emit at the correct timing.
- * @note The use of GL sync might cause deadlock with multiple access to the single pixmap happening in the same time.
* @SINCE_1_1.29
+ * @note The use of GL sync might cause deadlock with multiple access to the single pixmap happening in the same time.
*/
REQUIRES_SYNC,
};
/**
* @brief A pointer to a function for converting screen to frame-buffer coordinates.
* @SINCE_1_0.0
- * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen.
- * @return True if the conversion was successful, otherwise coordinates should be unmodified.
+ * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen
+ * @return True if the conversion was successful, otherwise coordinates should be unmodified
*/
typedef bool (* ScreenToFrameBufferFunction)( Vector2& coordinates );
/**
* @brief A pointer to a function for converting screen to frame-buffer coordinates.
* @SINCE_1_0.0
- * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen.
- * @return True if the conversion was successful, otherwise coordinates should be unmodified.
+ * @param[in,out] coordinates The screen coordinates to convert where (0,0) is the top-left of the screen
+ * @return True if the conversion was successful, otherwise coordinates should be unmodified
*/
typedef bool (* const ConstScreenToFrameBufferFunction)( Vector2& coordinates );
static ConstScreenToFrameBufferFunction FULLSCREEN_FRAMEBUFFER_FUNCTION;
/**
- * @brief The refresh-rate of the RenderTask.
+ * @brief Enumeration for the refresh-rate of the RenderTask.
* @SINCE_1_0.0
*/
enum RefreshRate
static const unsigned int DEFAULT_REFRESH_RATE; ///< REFRESH_ALWAYS
/**
- * @brief Create an empty RenderTask handle.
+ * @brief Creates an empty RenderTask handle.
*
* This can be initialised with RenderTaskList::CreateRenderTask().
* @SINCE_1_0.0
RenderTask();
/**
- * @brief Downcast a handle to RenderTask handle.
+ * @brief Downcasts a handle to RenderTask handle.
*
- * If handle points to a RenderTask the
- * downcast produces valid handle. If not the returned handle is left uninitialized.
+ * If handle points to a RenderTask, the
+ * downcast produces valid handle. If not, the returned handle is left uninitialized.
* @SINCE_1_0.0
- * @param[in] handle A handle to an object.
- * @return A handle to a RenderTask or an uninitialized handle.
+ * @param[in] handle A handle to an object
+ * @return A handle to a RenderTask or an uninitialized handle
*/
static RenderTask DownCast( BaseHandle handle );
/**
- * @brief Destructor
+ * @brief Destructor.
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
* @brief This copy constructor is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] handle A reference to the copied handle
+ * @param[in] handle A reference to the copied handle
*/
RenderTask(const RenderTask& handle);
* @brief This assignment operator is required for (smart) pointer semantics.
*
* @SINCE_1_0.0
- * @param [in] rhs A reference to the copied handle
+ * @param[in] rhs A reference to the copied handle
* @return A reference to this
*/
RenderTask& operator=(const RenderTask& rhs);
/**
- * @brief Set the actors to be rendered.
+ * @brief Sets the actors to be rendered.
* @SINCE_1_0.0
* @param[in] actor This actor and its children will be rendered.
- * If actor is an empty handle, then nothing will be rendered.
+ * If actor is an empty handle, then nothing will be rendered
*/
void SetSourceActor( Actor actor );
/**
- * @brief Retrieve the actors to be rendered.
+ * @brief Retrieves the actors to be rendered.
* @SINCE_1_0.0
- * @return This actor and its children will be rendered.
+ * @return This actor and its children will be rendered
*/
Actor GetSourceActor() const;
/**
- * @brief Set whether the RenderTask has exclusive access to the source actors; the default is false.
+ * @brief Sets whether the RenderTask has exclusive access to the source actors; the default is false.
* @SINCE_1_0.0
- * @param[in] exclusive True if the source actors will only be rendered by this render-task.
+ * @param[in] exclusive True if the source actors will only be rendered by this render-task
*/
void SetExclusive( bool exclusive );
/**
- * @brief Query whether the RenderTask has exclusive access to the source actors.
+ * @brief Queries whether the RenderTask has exclusive access to the source actors.
* @SINCE_1_0.0
- * @return True if the source actors will only be rendered by this render-task.
+ * @return True if the source actors will only be rendered by this render-task
*/
bool IsExclusive() const;
/**
- * @brief Set whether the render-task should be considered for input handling; the default is true.
+ * @brief Sets whether the render-task should be considered for input handling; the default is true.
*
* The task used for input handling will be last task in the RenderTaskList which has input enabled,
* and has a valid source & camera actor.
* A RenderTask targetting a frame-buffer can still be hit-tested, provided that the screen->frame-buffer
* coordinate conversion is successful; see also SetScreenToFrameBufferFunction().
* @SINCE_1_0.0
- * @param[in] enabled True if the render-task should be considered for input handling.
+ * @param[in] enabled True if the render-task should be considered for input handling
*/
void SetInputEnabled( bool enabled );
/**
- * @brief Query whether the render-task should be considered for input handling.
+ * @brief Queries whether the render-task should be considered for input handling.
* @SINCE_1_0.0
- * @return True if the render-task should be considered for input handling.
+ * @return True if the render-task should be considered for input handling
*/
bool GetInputEnabled() const;
/**
- * @brief Set the actor from which the scene is viewed.
+ * @brief Sets the actor from which the scene is viewed.
* @SINCE_1_0.0
- * @param[in] cameraActor The scene is viewed from the perspective of this actor.
+ * @param[in] cameraActor The scene is viewed from the perspective of this actor
*/
void SetCameraActor( CameraActor cameraActor );
/**
- * @brief Retrieve the actor from which the scene is viewed.
+ * @brief Retrieves the actor from which the scene is viewed.
* @SINCE_1_0.0
- * @return The scene is viewed from the perspective of this actor.
+ * @return The scene is viewed from the perspective of this actor
*/
CameraActor GetCameraActor() const;
/**
- * @brief Set the frame-buffer used as a render target.
+ * @brief Sets the frame-buffer used as a render target.
* @SINCE_1_0.0
- * @param[in] frameBuffer A valid frame-buffer handle to enable off-screen rendering, or an uninitialized handle to disable.
+ * @param[in] frameBuffer A valid frame-buffer handle to enable off-screen rendering, or an uninitialized handle to disable
*/
void SetTargetFrameBuffer( FrameBufferImage frameBuffer );
/**
- * @brief Retrieve the frame-buffer used as a render target.
+ * @brief Retrieves the frame-buffer used as a render target.
* @SINCE_1_0.0
- * @return A valid frame-buffer handle, or an uninitialised handle if off-screen rendering is disabled.
+ * @return A valid frame-buffer handle, or an uninitialised handle if off-screen rendering is disabled
*/
FrameBufferImage GetTargetFrameBuffer() const;
/**
- * @brief Set the frame-buffer used as a render target.
+ * @brief Sets the frame-buffer used as a render target.
* @SINCE_1_1.38
- * @param[in] frameBuffer er A valid FrameBuffer handle to enable off-screen rendering, or an uninitialized handle to disable it.
+ * @param[in] frameBuffer er A valid FrameBuffer handle to enable off-screen rendering, or an uninitialized handle to disable it
*/
void SetFrameBuffer( FrameBuffer frameBuffer );
/**
- * @brief Retrieve the frame-buffer used as a render target.
+ * @brief Retrieves the frame-buffer used as a render target.
* @SINCE_1_1.38
* @return The framebuffer
*/
FrameBuffer GetFrameBuffer() const;
/**
- * @brief Set the function used to convert screen coordinates to frame-buffer coordinates.
+ * @brief Sets the function used to convert screen coordinates to frame-buffer coordinates.
*
* This is useful for hit-testing actors which are rendered off-screen.
* @SINCE_1_0.0
- * @param[in] conversionFunction The conversion function.
+ * @param[in] conversionFunction The conversion function
*/
void SetScreenToFrameBufferFunction( ScreenToFrameBufferFunction conversionFunction );
/**
- * @brief Retrieve the function used to convert screen coordinates to frame-buffer coordinates.
+ * @brief Retrieves the function used to convert screen coordinates to frame-buffer coordinates.
* @SINCE_1_0.0
- * @return The conversion function.
+ * @return The conversion function
*/
ScreenToFrameBufferFunction GetScreenToFrameBufferFunction() const;
/**
- * @brief Set the actor used to convert screen coordinates to frame-buffer coordinates.
+ * @brief Sets the actor used to convert screen coordinates to frame-buffer coordinates.
*
* The local coordinates of the actor are mapped as frame-buffer coordinates.
* This is useful for hit-testing actors which are rendered off-screen.
* @SINCE_1_0.0
- * @param[in] mappingActor The actor used for conversion.
+ * @param[in] mappingActor The actor used for conversion
* @note The mapping actor needs to be rendered by the default render task to make the mapping work properly.
*/
void SetScreenToFrameBufferMappingActor( Actor mappingActor );
/**
- * @brief Retrieve the actor used to convert screen coordinates to frame-buffer coordinates.
+ * @brief Retrieves the actor used to convert screen coordinates to frame-buffer coordinates.
* @SINCE_1_0.0
- * @return The actor used for conversion.
+ * @return The actor used for conversion
*/
Actor GetScreenToFrameBufferMappingActor() const;
/**
- * @brief Set the GL viewport position used when rendering.
+ * @brief Sets the GL viewport position used when rendering.
*
* This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
* By default this will match the target window or frame-buffer size.
void SetViewportPosition( Vector2 position );
/**
- * @brief Retrieve the GL viewport position used when rendering.
+ * @brief Retrieves the GL viewport position used when rendering.
* @SINCE_1_0.0
- * @return The viewport.
+ * @return The viewport
*/
Vector2 GetCurrentViewportPosition() const;
/**
- * @brief Set the GL viewport size used when rendering.
+ * @brief Sets the GL viewport size used when rendering.
*
* This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
* By default this will match the target window or frame-buffer size.
void SetViewportSize( Vector2 size );
/**
- * @brief Retrieve the GL viewport size used when rendering.
+ * @brief Retrieves the GL viewport size used when rendering.
* @SINCE_1_0.0
- * @return The viewport.
+ * @return The viewport
*/
Vector2 GetCurrentViewportSize() const;
/**
- * @brief Set the GL viewport used when rendering.
+ * @brief Sets the GL viewport used when rendering.
*
* This specifies the transformation between normalized device coordinates and target window (or frame-buffer) coordinates.
* By default this will match the target window or frame-buffer size.
* @SINCE_1_0.0
- * @param[in] viewport The new viewport.
+ * @param[in] viewport The new viewport
* @note Unlike the glViewport method, the x & y coordinates refer to the top-left of the viewport rectangle.
*/
void SetViewport( Viewport viewport );
/**
- * @brief Retrieve the GL viewport used when rendering.
+ * @brief Retrieves the GL viewport used when rendering.
* @SINCE_1_0.0
- * @return The viewport.
+ * @return The viewport
*/
Viewport GetViewport() const;
/**
- * @brief Set the clear color used when SetClearEnabled(true) is used.
+ * @brief Sets the clear color used when SetClearEnabled(true) is used.
* @SINCE_1_0.0
- * @param[in] color The new clear color.
+ * @param[in] color The new clear color
*/
void SetClearColor( const Vector4& color );
/**
- * @brief Retrieve the clear color used when SetClearEnabled(true) is used.
+ * @brief Retrieves the clear color used when SetClearEnabled(true) is used.
* @SINCE_1_0.0
- * @return The clear color.
+ * @return The clear color
* @note This property can be animated; the return value may not match the value written with SetClearColor().
*/
Vector4 GetClearColor() const;
/**
- * @brief Set whether the render-task will clear the results of previous render-tasks.
+ * @brief Sets whether the render-task will clear the results of previous render-tasks.
*
* The default is false.
*
* @SINCE_1_0.0
- * @param[in] enabled True if the render-task should clear.
+ * @param[in] enabled True if the render-task should clear
* @note The default GL surface is cleared automatically at the
* beginning of each frame; this setting is only useful when 2+
* render-tasks are used, and the result of the first task needs to
void SetClearEnabled( bool enabled );
/**
- * @brief Query whether the render-task will clear the results of previous render-tasks.
+ * @brief Queries whether the render-task will clear the results of previous render-tasks.
* @SINCE_1_0.0
- * @return True if the render-task should clear.
+ * @return True if the render-task should clear
*/
bool GetClearEnabled() const;
/**
- * @brief Set whether the render task will cull the actors to the camera's view frustum.
+ * @brief Sets whether the render task will cull the actors to the camera's view frustum.
*
* @SINCE_1_0.0
- * @param[in] cullMode True if the renderers should be culled.
+ * @param[in] cullMode True if the renderers should be culled
* @note The default mode is to cull actors.
* @note If the shader uses @ref Shader::Hint::MODIFIES_GEOMETRY then culling optimizations are disabled.
* @see Shader::Hint
void SetCullMode( bool cullMode );
/**
- * @brief Get the cull mode.
+ * @brief Gets the cull mode.
*
* @SINCE_1_0.0
* @return True if the render task should cull the actors to the camera's view frustum
bool GetCullMode() const;
/**
- * @brief Set the refresh-rate of the RenderTask.
+ * @brief Sets the refresh-rate of the RenderTask.
*
* The default is REFRESH_ALWAYS (1), meaning that the RenderTask
* will be processed every frame if the scene graph is changing. It
* may be desirable to process less frequently. For example,
* SetRefreshRate(3) will process once every 3 frames if the scene
- * graph is changing. If the scene graph is not changing, then the
+ * graph is changing. If the scene graph is not changing, then the
* render task will not be rendered, regardless of this value.
*
* The REFRESH_ONCE value means that the RenderTask will be
* snap-shots to be taken.
*
* @SINCE_1_0.0
- * @param[in] refreshRate The new refresh rate.
+ * @param[in] refreshRate The new refresh rate
*/
void SetRefreshRate( unsigned int refreshRate );
/**
- * @brief Query the refresh-rate of the RenderTask.
+ * @brief Queries the refresh-rate of the RenderTask.
* @SINCE_1_0.0
- * @return The refresh-rate.
+ * @return The refresh-rate
*/
unsigned int GetRefreshRate() const;
/*
- * @brief Get viewport coordinates for given world position
+ * @brief Gets viewport coordinates for given world position.
*
* @SINCE_1_1.13
- *
- * @param[in] position The world position.
- * @param[out] viewportX The viewport x position.
- * @param[out] viewportY The viewport y position.
+ * @param[in] position The world position
+ * @param[out] viewportX The viewport x position
+ * @param[out] viewportY The viewport y position
* @return true if the position has a screen coordinate
*/
bool WorldToViewport(const Vector3 &position, float& viewportX, float& viewportY) const;
/*
- * @brief Get actor local coordinates for given viewport coordinates
+ * @brief Gets actor local coordinates for given viewport coordinates.
*
* @SINCE_1_1.13
- *
- * @param[in] actor The actor describing local coordinate system.
- * @param[in] viewportX The viewport x position.
- * @param[in] viewportY The viewport y position.
- * @param[out] localX The local x position.
- * @param[out] localY The local y position.
+ * @param[in] actor The actor describing local coordinate system
+ * @param[in] viewportX The viewport x position
+ * @param[in] viewportY The viewport y position
+ * @param[out] localX The local x position
+ * @param[out] localY The local y position
* @return true if the screen position has a local coordinate
*/
bool ViewportToLocal(Actor actor, float viewportX, float viewportY, float &localX, float &localY) const;
/**
* @brief This constructor is used by Dali New() methods.
* @SINCE_1_0.0
- * @param [in] renderTask A pointer to a newly allocated render-task
+ * @param[in] renderTask A pointer to a newly allocated render-task
*/
explicit DALI_INTERNAL RenderTask( Internal::RenderTask* renderTask );
/// @endcond
}
/**
- * @brief FrameBuffer is a collection of textures that can be used as the destination for rendering
+ * @brief FrameBuffer is a collection of textures that can be used as the destination for rendering.
* @SINCE_1_1.43
*/
class DALI_IMPORT_API FrameBuffer : public BaseHandle
struct Attachment
{
/**
- * @brief The bit-mask value
+ * @brief Enumeration for the bit-mask value.
* @SINCE_1_1.45
*/
enum Mask
};
/**
- * @brief Creates a new FrameBuffer object
+ * @brief Creates a new FrameBuffer object.
*
* @SINCE_1_1.43
* @param[in] width The width of the FrameBuffer
* @param[in] height The height of the FrameBuffer
- * @param[in] attachments The attachments comprising the format of the FrameBuffer (the type is int to allow multiple bitmasks to be ORd).
+ * @param[in] attachments The attachments comprising the format of the FrameBuffer (the type is int to allow multiple bitmasks to be ORd)
* @return A handle to a newly allocated FrameBuffer
*/
static FrameBuffer New( unsigned int width, unsigned int height, unsigned int attachments );
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*/
FrameBuffer();
/**
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_1.43
*/
~FrameBuffer();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
FrameBuffer( const FrameBuffer& handle );
/**
- * @brief Downcast to a FrameBuffer.
- *
+ * @brief Downcasts to a FrameBuffer.
+ * If not, the returned handle is left uninitialized.
* @SINCE_1_1.43
- * If not the returned handle is left uninitialized.
* @param[in] handle Handle to an object
* @return FrameBuffer handle or an uninitialized handle
*/
static FrameBuffer DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
* @SINCE_1_1.43
* @param[in] texture The texture that will be used as output when rendering
* @note The texture has to have the same size than the FrameBuffer
- * otherwise it won't be attached
+ * otherwise it won't be attached.
*/
void AttachColorTexture( Texture& texture );
* @param[in] mipmapLevel The mipmap of the texture to be attached
* @param[in] layer Indicates which layer of a cube map or array texture to attach. Unused for 2D textures
* @note The specified texture mipmap has to have the same size than the FrameBuffer
- * otherwise it won't be attached
+ * otherwise it won't be attached.
*/
void AttachColorTexture( Texture& texture, unsigned int mipmapLevel, unsigned int layer );
/**
- * @brief Get the color texture used as output in the FrameBuffer
+ * @brief Gets the color texture used as output in the FrameBuffer.
*
* @SINCE_1_1.43
* @returns A handle to the texture used as color output, or an uninitialized handle
public:
/**
- * @brief Describes the type of geometry, used to determine how the coordinates will be used.
+ * @brief Enumeration for the description of the type of geometry, used to determine how the coordinates will be used.
* @SINCE_1_1.45
*/
enum Type
/**
- * @brief Creates a new Geometry object
+ * @brief Creates a new Geometry object.
*
* @SINCE_1_1.43
* @return A handle to a newly allocated Geometry object
static Geometry New();
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
Geometry();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
~Geometry();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Geometry( const Geometry& handle );
/**
- * @brief Downcast to a geometry.
- * If not the returned handle is left uninitialized.
+ * @brief Downcasts to a geometry.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
- * @return geometry Handle or an uninitialized handle
+ * @return Geometry handle or an uninitialized handle
*/
static Geometry DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Geometry& operator=( const Geometry& handle );
/**
- * @brief Add a PropertyBuffer to be used as source of geometry vertices
+ * @brief Adds a PropertyBuffer to be used as source of geometry vertices.
*
* @SINCE_1_1.43
* @param[in] vertexBuffer PropertyBuffer to be used as source of geometry vertices
std::size_t AddVertexBuffer( PropertyBuffer& vertexBuffer );
/**
- * @brief Retrieve the number of vertex buffers that have been added to this geometry
+ * @brief Retrieves the number of vertex buffers that have been added to this geometry.
*
* @SINCE_1_1.43
* @return Number of vertex buffers that have been added to this geometry
std::size_t GetNumberOfVertexBuffers() const;
/**
- * @brief Remove a vertex buffer
- * The index must be between 0 and GetNumberOfVertexBuffers()
+ * @brief Removes a vertex buffer.
+ * The index must be between 0 and GetNumberOfVertexBuffers().
*
* @SINCE_1_1.43
* @param[in] index Index to the vertex buffer to remove
void RemoveVertexBuffer( std::size_t index );
/**
- * @brief Set a the index data to be used as a source of indices for the geometry
+ * @brief Sets a the index data to be used as a source of indices for the geometry
* Setting this buffer will cause the geometry to be rendered using indices.
- * To unset call SetIndexBuffer with a null pointer or count 0
+ * To unset call SetIndexBuffer with a null pointer or count 0.
*
* @SINCE_1_1.43
* @param[in] indices Array of indices
void SetIndexBuffer( const unsigned short* indices, size_t count );
/**
- * @brief Set the type of primitives this geometry contains
+ * @brief Sets the type of primitives this geometry contains.
*
* @SINCE_1_1.43
* @param[in] geometryType Type of primitives this geometry contains
void SetType( Type geometryType );
/**
- * @brief Get the type of primitives this geometry contains
- * Calling this function sets the property GEOMETRY_TYPE
+ * @brief Gets the type of primitives this geometry contains.
+ * Calling this function sets the property GEOMETRY_TYPE.
*
* @SINCE_1_1.43
* @return Type of primitives this geometry contains
public:
/**
- * @brief The constructor
+ * @brief The constructor.
* @note Not intended for application developers.
* @SINCE_1_1.43
* @param[in] pointer A pointer to a newly allocated Geometry
}
/**
- * @brief PropertyBuffer is a handle to an object that contains a buffer of structured properties
+ * @brief PropertyBuffer is a handle to an object that contains a buffer of structured properties.
*
* PropertyBuffers can be used to provide data to Geometry objects.
*
public:
/**
- * @brief Create a PropertyBuffer
+ * @brief Creates a PropertyBuffer.
* Static property buffers use less memory.
*
* @SINCE_1_1.43
static PropertyBuffer New( Dali::Property::Map& bufferFormat );
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
PropertyBuffer();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
~PropertyBuffer();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
PropertyBuffer( const PropertyBuffer& handle );
/**
- * @brief Downcast to a property buffer handle.
- * If not a property buffer the returned property buffer handle is left uninitialized.
+ * @brief Downcasts to a property buffer handle.
+ * If not, a property buffer the returned property buffer handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
static PropertyBuffer DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
PropertyBuffer& operator=( const PropertyBuffer& handle );
/**
- * @brief Update the whole buffer information
+ * @brief Updates the whole buffer information.
*
* This function expects a pointer to an array of structures with the same
* format that was given in the construction, and the number of elements to
* </pre>
*
* @SINCE_1_1.43
- * @param[in] data A pointer to the data that will be copied to the buffer.
- * @param[in] size Number of elements to expand or contract the buffer.
+ * @param[in] data A pointer to the data that will be copied to the buffer
+ * @param[in] size Number of elements to expand or contract the buffer
*/
void SetData( const void* data, std::size_t size );
/**
- * @brief Get the number of elements in the buffer
+ * @brief Gets the number of elements in the buffer.
*
* @SINCE_1_1.43
* @return Number of elements to expand or contract the buffer
public:
/**
- * @brief The constructor
+ * @brief The constructor.
* @note Not intended for application developers.
* @SINCE_1_1.43
* @param[in] pointer A pointer to a newly allocated PropertyBuffer
{
/**
- * @brief Face culling mode.
+ * @brief Enumeration for face culling mode.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Blend mode.
+ * @brief Enumeration for blend mode.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Blend Equation.
+ * @brief Enumeration for blend equation.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Blend Factor.
+ * @brief Enumeration for blend factor.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Depth buffer write modes.
+ * @brief Enumeration for depth buffer write modes.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Depth buffer test (read) modes.
+ * @brief Enumeration for depth buffer test (read) modes.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Depth functions.
+ * @brief Enumeration for depth functions.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Controls how this renderer uses its stencil properties and writes to the color buffer.
+ * @brief Enumeration for the controls of how this renderer uses its stencil properties and writes to the color buffer.
* @SINCE_1_2_5
*/
enum Type
{
/**
- * @brief The comparison function used on the stencil buffer.
+ * @brief Enumeration for the comparison function used on the stencil buffer.
* @SINCE_1_1.43
*/
enum Type
{
/**
- * @brief Specifies the action to take when the stencil (or depth) test fails during stencil test.
+ * @brief Enumeration for specifying the action to take when the stencil (or depth) test fails during stencil test.
* @SINCE_1_1.43
*/
enum Type
/**
- * @brief Renderer is a handle to an object used to show content by combining a Geometry, a TextureSet and a shader
+ * @brief Renderer is a handle to an object used to show content by combining a Geometry, a TextureSet and a shader.
*
* @SINCE_1_1.43
*/
public:
/**
- * @brief An enumeration of properties belonging to the Renderer class.
+ * @brief Enumeration for instances of properties belonging to the Renderer class.
* @SINCE_1_1.43
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Renderer class.
+ * @brief Enumeration for instances of properties belonging to the Renderer class.
* @SINCE_1_1.43
*/
enum
{
/**
- * @brief name "depthIndex", type INTEGER
- * @note The default value is 0
+ * @brief Name "depthIndex", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is 0.
*/
DEPTH_INDEX = DEFAULT_RENDERER_PROPERTY_START_INDEX,
/**
- * @brief name "faceCullingMode", type INTEGER
- * @note The default value is FaceCullingMode::NONE
+ * @brief Name "faceCullingMode", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is FaceCullingMode::NONE.
*/
FACE_CULLING_MODE,
/**
- * @brief name "blendMode", type INTEGER
- * @note The default value is BlendMode::AUTO
+ * @brief Name "blendMode", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendMode::AUTO.
*/
BLEND_MODE,
/**
- * @brief name "blendEquationRgb", type INTEGER
- * @note The default value is BlendEquation::ADD
+ * @brief Name "blendEquationRgb", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendEquation::ADD.
*/
BLEND_EQUATION_RGB,
/**
- * @brief name "blendEquationAlpha", type INTEGER
- * @note The default value is BlendEquation::ADD
+ * @brief Name "blendEquationAlpha", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendEquation::ADD.
*/
BLEND_EQUATION_ALPHA,
/**
- * @brief name "blendFactorSrcRgb", type INTEGER
- * @note The default value is BlendFactor::SRC_ALPHA
+ * @brief Name "blendFactorSrcRgb", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendFactor::SRC_ALPHA.
*/
BLEND_FACTOR_SRC_RGB,
/**
- * @brief name "blendFactorDestRgb", type INTEGER
- * @note The default value is BlendFactor::ONE_MINUS_SRC_ALPHA
+ * @brief Name "blendFactorDestRgb", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendFactor::ONE_MINUS_SRC_ALPHA.
*/
BLEND_FACTOR_DEST_RGB,
/**
- * @brief name "blendFactorSrcAlpha", type INTEGER
- * @note The default value is BlendFactor::ONE
+ * @brief Name "blendFactorSrcAlpha", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendFactor::ONE.
*/
BLEND_FACTOR_SRC_ALPHA,
/**
- * @brief name "blendFactorDestAlpha", type INTEGER
- * @note The default value is BlendFactor::ONE_MINUS_SRC_ALPHA
+ * @brief Name "blendFactorDestAlpha", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is BlendFactor::ONE_MINUS_SRC_ALPHA.
*/
BLEND_FACTOR_DEST_ALPHA,
/**
- * @brief name "blendColor", type VECTOR4
- * @note The default value is Color::TRANSPARENT
+ * @brief Name "blendColor", type VECTOR4.
* @SINCE_1_1.43
+ * @note The default value is Color::TRANSPARENT.
*/
BLEND_COLOR,
/**
- * @brief name "blendPreMultipledAlpha", type BOOLEAN
- * @note The default value is false
+ * @brief Name "blendPreMultipledAlpha", type BOOLEAN.
* @SINCE_1_1.43
+ * @note The default value is false.
*/
BLEND_PRE_MULTIPLIED_ALPHA,
/**
- * @brief name "indexRangeFirst", type INTEGER
- * @note The default value is 0
+ * @brief Name "indexRangeFirst", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is 0.
*/
INDEX_RANGE_FIRST,
/**
- * @brief name "indexRangeCount", type INTEGER
- * @note The default (0) means that whole range of indices will be used
+ * @brief Name "indexRangeCount", type INTEGER.
* @SINCE_1_1.43
+ * @note The default (0) means that whole range of indices will be used.
*/
INDEX_RANGE_COUNT,
/**
- * @brief name "depthWriteMode", type INTEGER
- * @see DepthWriteMode
- * @note The default value is DepthWriteMode::AUTO
+ * @brief Name "depthWriteMode", type INTEGER.
* @SINCE_1_1.43
+ * @see DepthWriteMode
+ * @note The default value is DepthWriteMode::AUTO.
*/
DEPTH_WRITE_MODE,
/**
- * @brief name "depthFunction", type INTEGER
- * @see DepthFunction
- * @note The default value is DepthFunction::LESS
+ * @brief Name "depthFunction", type INTEGER.
* @SINCE_1_1.43
+ * @see DepthFunction
+ * @note The default value is DepthFunction::LESS.
*/
DEPTH_FUNCTION,
/**
- * @brief name "depthTestMode", type INTEGER
- * @see DepthTestMode
- * @note The default value is DepthTestMode::AUTO
+ * @brief Name "depthTestMode", type INTEGER.
* @SINCE_1_1.43
+ * @see DepthTestMode
+ * @note The default value is DepthTestMode::AUTO.
*/
DEPTH_TEST_MODE,
/**
- * @brief name "renderMode", type INTEGER
- * @see RenderMode
- * @note The default value is RenderMode::AUTO
+ * @brief Name "renderMode", type INTEGER.
* @SINCE_1_2_5
+ * @see RenderMode
+ * @note The default value is RenderMode::AUTO.
*/
RENDER_MODE,
/**
- * @brief name "stencilFunction", type INTEGER
- * @see StencilFunction
- * @note The default value is StencilFunction::ALWAYS
+ * @brief Name "stencilFunction", type INTEGER.
* @SINCE_1_1.43
+ * @see StencilFunction
+ * @note The default value is StencilFunction::ALWAYS.
*/
STENCIL_FUNCTION,
/**
- * @brief name "stencilFunctionMask", type INTEGER
- * @note The default value is 0xFF
+ * @brief Name "stencilFunctionMask", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is 0xFF.
*/
STENCIL_FUNCTION_MASK,
/**
- * @brief name "stencilFunctionReference", type INTEGER
- * @note The default value is 0
+ * @brief Name "stencilFunctionReference", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is 0.
*/
STENCIL_FUNCTION_REFERENCE,
/**
- * @brief name "stencilMask", type INTEGER
- * @note The default value is 0xFF
+ * @brief Name "stencilMask", type INTEGER.
* @SINCE_1_1.43
+ * @note The default value is 0xFF.
*/
STENCIL_MASK,
/**
- * @brief name "stencilOperationOnFail", type INTEGER
+ * @brief Name "stencilOperationOnFail", type INTEGER.
+ * @SINCE_1_1.43
* @see StencilOperation
* @note The default value is StencilOperation::KEEP
- * @SINCE_1_1.43
*/
STENCIL_OPERATION_ON_FAIL,
/**
- * @brief name "stencilOperationOnZFail", type INTEGER
- * @see StencilOperation
- * @note The default value is StencilOperation::KEEP
+ * @brief Name "stencilOperationOnZFail", type INTEGER.
* @SINCE_1_1.43
+ * @see StencilOperation
+ * @note The default value is StencilOperation::KEEP.
*/
STENCIL_OPERATION_ON_Z_FAIL,
/**
- * @brief name "stencilOperationOnZPass", type INTEGER
- * @see StencilOperation
- * @note The default value is StencilOperation::KEEP
+ * @brief Name "stencilOperationOnZPass", type INTEGER.
* @SINCE_1_1.43
+ * @see StencilOperation
+ * @note The default value is StencilOperation::KEEP.
*/
STENCIL_OPERATION_ON_Z_PASS,
};
};
/**
- * @brief Creates a new Renderer object
+ * @brief Creates a new Renderer object.
*
* @SINCE_1_1.43
* @param[in] geometry Geometry to be used by this renderer
Renderer();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
~Renderer();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Renderer( const Renderer& handle );
/**
- * @brief Downcast to a renderer handle.
- * If not a renderer the returned renderer handle is left uninitialized.
+ * @brief Downcasts to a renderer handle.
+ * If not, a renderer the returned renderer handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
static Renderer DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Renderer& operator=( const Renderer& handle );
/**
- * @brief Sets the geometry to be used by this renderer
+ * @brief Sets the geometry to be used by this renderer.
*
* @SINCE_1_1.43
* @param[in] geometry The geometry to be used by this renderer
void SetGeometry( Geometry& geometry );
/**
- * @brief Gets the geometry used by this renderer
+ * @brief Gets the geometry used by this renderer.
*
* @SINCE_1_1.43
* @return The geometry used by the renderer
Geometry GetGeometry() const;
/**
- * @brief Sets effective range of indices to draw from bound index buffer
+ * @brief Sets effective range of indices to draw from bound index buffer.
*
* @SINCE_1_1.43
* @param[in] firstElement The First element to draw
}
/**
- * @brief Sets the texture set to be used by this renderer
+ * @brief Sets the texture set to be used by this renderer.
*
* @SINCE_1_1.43
* @param[in] textureSet The texture set to be used by this renderer
void SetTextures( TextureSet& textureSet );
/**
- * @brief Gets the texture set used by this renderer
+ * @brief Gets the texture set used by this renderer.
*
* @SINCE_1_1.43
* @return The texture set used by the renderer
TextureSet GetTextures() const;
/**
- * @brief Set the shader used by this renderer
+ * @brief Sets the shader used by this renderer.
*
* @SINCE_1_1.43
* @param[in] shader The shader to be used by this renderer
void SetShader( Shader& shader );
/**
- * @brief Get the shader used by this renderer
+ * @brief Gets the shader used by this renderer.
*
* @SINCE_1_1.43
* @return The shader used by the renderer
}
/**
- * @brief Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures
+ * @brief Sampler is a handle to an object that can be used to provide the sampling parameters to sample textures.
*
* @SINCE_1_1.43
*/
public:
/**
- * @brief Creates a new Sampler object
+ * @brief Creates a new Sampler object.
*
* @SINCE_1_1.43
* @return A handle to the Sampler
static Sampler New();
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
Sampler();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
~Sampler();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Sampler( const Sampler& handle );
/**
- * @brief Downcast to a sampler handle.
- * If not the returned handle is left uninitialized.
+ * @brief Downcasts to a sampler handle.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
static Sampler DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
/**
- * @brief Set the filter modes for this sampler
+ * @brief Sets the filter modes for this sampler.
* Calling this function sets the properties MINIFICATION_FILTER and MAGNIFICATION_FILTER.
*
* @SINCE_1_1.43
void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
/**
- * @brief Set the wrap modes for this sampler
+ * @brief Sets the wrap modes for this sampler.
*
* @SINCE_1_1.43
* @param[in] uWrap Wrap mode for u coordinates
void SetWrapMode( WrapMode::Type uWrap, WrapMode::Type vWrap );
/**
- * @brief Set the wrap modes for this sampler
+ * @brief Sets the wrap modes for this sampler.
*
* @SINCE_1_1.43
* @param[in] rWrap Wrap mode for the z direction
public:
/**
- * @brief The constructor
+ * @brief The constructor.
* @note Not intended for application developers.
* @SINCE_1_1.43
* @param[in] pointer A pointer to a newly allocated Sampler
struct Hint
{
/**
- * @brief Hint value
+ * @brief Enumeration for the hint value.
* @SINCE_1_1.45
*/
enum Value
};
/**
- * @brief An enumeration of properties belonging to the Shader class.
+ * @brief Enumeration for instances of properties belonging to the Shader class.
* @SINCE_1_1.43
*/
struct Property
{
/**
- * @brief An enumeration of properties belonging to the Shader class.
+ * @brief Enumeration for instances of properties belonging to the Shader class.
* @SINCE_1_1.43
*/
enum
{
/**
- * @brief Name: "program", Type: MAP
- * @note The default value is empty
- * @note Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
+ * @brief Name: "program", Type: MAP.
+ * @note The default value is empty.
+ * @note Format: {"vertex":"","fragment":"",hints:"","vertexPrefix":"","fragmentPrefix":""}
* @SINCE_1_1.43
*/
PROGRAM = DEFAULT_OBJECT_PROPERTY_START_INDEX
};
/**
- * @brief Create Shader.
+ * @brief Creates Shader.
*
* @SINCE_1_1.43
* @param[in] vertexShader Vertex shader code for the effect.
Hint::Value hints = Hint::NONE );
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
Shader();
/**
- * @brief Destructor
+ * @brief Destructor.
* This is non-virtual since derived Handle types must not contain data or virtual methods.
*
* @SINCE_1_1.43
~Shader();
/**
- * @brief Copy constructor
+ * @brief Copy constructor.
*
* @SINCE_1_1.43
* @param[in] handle A handle to a Shader object
Shader( const Shader& handle );
/**
- * @brief Downcast to a shader handle.
- * If not a shader the returned shader handle is left uninitialized.
+ * @brief Downcasts to a shader handle.
+ * If not, a shader the returned shader handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
static Shader DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
public:
/**
- * @brief Creates a new TextureSet object
+ * @brief Creates a new TextureSet object.
*
* @SINCE_1_1.43
* @return A handle to a newly allocated TextureSet
static TextureSet New();
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
TextureSet();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
~TextureSet();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
TextureSet( const TextureSet& handle );
/**
- * @brief Downcast to a TextureSet handle.
- *
- * @SINCE_1_1.43
+ * @brief Downcasts to a TextureSet handle.
* If handle is not a TextureSet, the returned handle is left uninitialized.
+ * @SINCE_1_1.43
* @param[in] handle Handle to an object
* @return TextureSet handle or an uninitialized handle
*/
static TextureSet DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
TextureSet& operator=( const TextureSet& handle );
/**
- * @brief Set the texture at position "index"
+ * @brief Sets the texture at position "index".
*
* @SINCE_1_1.43
* @param[in] index The position in the texture set of the texture
void SetTexture( size_t index, Texture texture );
/**
- * @brief Get the image at position "index"
+ * @brief Gets the image at position "index".
*
* @SINCE_1_1.43
* @param[in] index The position in the texture set of the image
Texture GetTexture( size_t index ) const;
/**
- * @brief Set the sampler to be used by the image at position "index"
+ * @brief Sets the sampler to be used by the image at position "index".
*
* @SINCE_1_1.43
* @param[in] index The position in the texture set of the sampler
void SetSampler( size_t index, Sampler sampler );
/**
- * @brief Set the sampler to be used by the image at position "index"
+ * @brief Sets the sampler to be used by the image at position "index".
*
* @SINCE_1_1.43
* @param[in] index The position in the texture set of the image
Sampler GetSampler( size_t index ) const;
/**
- * @brief Get the number of textures present in the TextureSet
+ * @brief Gets the number of textures present in the TextureSet.
*
* @SINCE_1_1.43
* @return The number of textures in the TextureSet
{
/**
- * @brief Texture types
+ * @brief Enumeration for texture types.
* @SINCE_1_1.43
*/
enum Type
public:
/**
- * @brief Creates a new Texture object
+ * @brief Creates a new Texture object.
*
* @SINCE_1_1.43
* @param[in] type The type of the texture
static Texture New( TextureType::Type type, Pixel::Format format, unsigned int width, unsigned int height );
/**
- * @brief Creates a new Texture object from a native image
+ * @brief Creates a new Texture object from a native image.
*
* @SINCE_1_1.43
* @param[in] nativeImageInterface A native image
static Texture New( NativeImageInterface& nativeImageInterface );
/**
- * @brief Default constructor, creates an empty handle
+ * @brief Default constructor, creates an empty handle.
*
* @SINCE_1_1.43
*/
Texture();
/**
- * @brief Destructor
+ * @brief Destructor.
*
* @SINCE_1_1.43
*/
~Texture();
/**
- * @brief Copy constructor, creates a new handle to the same object
+ * @brief Copy constructor, creates a new handle to the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Texture( const Texture& handle );
/**
- * @brief Downcast to a texture.
- * If not the returned handle is left uninitialized.
+ * @brief Downcasts to a texture.
+ * If not, the returned handle is left uninitialized.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
static Texture DownCast( BaseHandle handle );
/**
- * @brief Assignment operator, changes this handle to point at the same object
+ * @brief Assignment operator, changes this handle to point at the same object.
*
* @SINCE_1_1.43
* @param[in] handle Handle to an object
Texture& operator=( const Texture& handle );
/**
- * @brief Upload data to the texture from a PixelData object
+ * @brief Uploads data to the texture from a PixelData object.
*
* @SINCE_1_1.43
* @param[in] pixelData The pixelData object
bool Upload( PixelData pixelData );
/**
- * @brief Upload data to the texture from a PixelData object
+ * @brief Uploads data to the texture from a PixelData object.
* @note Upload does not upsample or downsample pixel data to fit the specified rectangular area in the texture.
*
* @SINCE_1_1.43
unsigned int width, unsigned int height );
/**
- * @brief Generate mipmaps for the texture
- * This will auto generate all the mipmaps for the texture based on the data in the base level
+ * @brief Generates mipmaps for the texture.
+ * This will auto generate all the mipmaps for the texture based on the data in the base level.
*
* @SINCE_1_1.43
*/
void GenerateMipmaps();
/**
- * @brief Returns the width of the texture
+ * @brief Returns the width of the texture.
*
* @SINCE_1_1.43
* @return The width, in pixels, of the texture
unsigned int GetWidth() const;
/**
- * @brief Returns the height of the texture
+ * @brief Returns the height of the texture.
*
* @SINCE_1_1.43
* @return The height, in pixels, of the texture
public:
/**
- * @brief The constructor
+ * @brief The constructor.
* @note Not intended for application developers.
* @SINCE_1_1.43
* @param[in] pointer A pointer to a newly allocated Texture
* <tr><td> %Callback 2 </td><td> Slot Observer 2 </td></tr>
* </table>
*
- * When the connection tracker is destroyed, SlotDisconnected() is called on every slot observer ( signal )
- * Signals implement the Slot Observer interface, to be told when a slot has disconnected
- * Connection tracker implements the Signal Observer interface, to be told when a signal has disconnected (died)
+ * When the connection tracker is destroyed, SlotDisconnected() is called on every slot observer ( signal ).
+ * Signals implement the Slot Observer interface, to be told when a slot has disconnected.
+ * Connection tracker implements the Signal Observer interface, to be told when a signal has disconnected (died).
*
* @SINCE_1_0.0
*/
virtual ~BaseSignal();
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
* @return True if there are any slots connected to the signal.
bool Empty() const;
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const;
struct EmitGuard
{
/**
- * @brief Create the guard.
+ * @brief Creates the guard.
*
* @SINCE_1_0.0
- * @param[in,out] flag This flag will be set to true during Emit() calls.
+ * @param[in,out] flag This flag will be set to true during Emit() calls
*/
EmitGuard( bool& flag );
~EmitGuard();
/**
- * @brief Determine if an error occured.
+ * @brief Determines if an error occurred.
*
* @SINCE_1_0.0
* @return True if an error occurred i.e. if Emit() was called during Emit()
};
/**
- * @brief Emit a signal with no parameters.
+ * @brief Emits a signal with no parameters.
*
* @SINCE_1_0.0
* @pre Cannot be called from inside the same Signal's Emit methods.
void Emit();
/**
- * @brief Emit a signal with no parameters.
+ * @brief Emits a signal with no parameters.
*
* @SINCE_1_0.0
- * @return The value returned by the last callback.
+ * @return The value returned by the last callback
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Ret >
}
/**
- * @brief Emit a signal with 1 parameter.
+ * @brief Emits a signal with 1 parameter.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first parameter.
+ * @param[in] arg0 The first parameter
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Arg0 >
}
/**
- * @brief Emit a signal with 1 parameter.
+ * @brief Emits a signal with 1 parameter.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first parameter.
- * @return The value returned by the last callback.
+ * @param[in] arg0 The first parameter
+ * @return The value returned by the last callback
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Ret, typename Arg0 >
}
/**
- * @brief Emit a signal with 2 parameters.
+ * @brief Emits a signal with 2 parameters.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first parameter.
- * @param[in] arg1 The second parameter.
+ * @param[in] arg0 The first parameter
+ * @param[in] arg1 The second parameter
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Arg0, typename Arg1 >
}
/**
- * @brief Emit a signal with 2 parameters.
+ * @brief Emits a signal with 2 parameters.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first parameter.
- * @param[in] arg1 The second parameter.
- * @return The value returned by the last callback.
+ * @param[in] arg0 The first parameter
+ * @param[in] arg1 The second parameter
+ * @return The value returned by the last callback
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Ret, typename Arg0, typename Arg1 >
}
/**
- * @brief Emit a signal with 3 parameters.
+ * @brief Emits a signal with 3 parameters.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first parameter.
- * @param[in] arg1 The second parameter.
- * @param[in] arg2 The third parameter.
+ * @param[in] arg0 The first parameter
+ * @param[in] arg1 The second parameter
+ * @param[in] arg2 The third parameter
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Arg0, typename Arg1, typename Arg2 >
}
/**
- * @brief Emit a signal with 3 parameters.
+ * @brief Emits a signal with 3 parameters.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first parameter.
- * @param[in] arg1 The second parameter.
- * @param[in] arg2 The third parameter.
- * @return The value returned by the last callback.
+ * @param[in] arg0 The first parameter
+ * @param[in] arg1 The second parameter
+ * @param[in] arg2 The third parameter
+ * @return The value returned by the last callback
* @pre Cannot be called from inside the same Signal's Emit methods.
*/
template< typename Ret, typename Arg0, typename Arg1, typename Arg2 >
// Connect / Disconnect function for use by Signal implementations
/**
- * @brief Called by Signal implementations, when the user calls Signal.Connect( ... )
+ * @brief Called by Signal implementations, when the user calls Signal.Connect( ... ).
*
* @SINCE_1_0.0
- * @param[in] callback A newly allocated callback object (takes ownership).
+ * @param[in] callback A newly allocated callback object (takes ownership)
*/
void OnConnect( CallbackBase* callback );
/**
- * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... )
+ * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... ).
*
* @SINCE_1_0.0
- * @param[in] callback A newly allocated callback object (takes ownership).
+ * @param[in] callback A newly allocated callback object (takes ownership)
*/
void OnDisconnect( CallbackBase* callback );
/**
- * @brief Called by Signal implementations, when the user calls Signal.Connect( ... )
+ * @brief Called by Signal implementations, when the user calls Signal.Connect( ... ).
*
* @SINCE_1_0.0
- * @param[in] tracker The connection tracker.
- * @param[in] callback A newly allocated callback object (takes ownership).
+ * @param[in] tracker The connection tracker
+ * @param[in] callback A newly allocated callback object (takes ownership)
*/
void OnConnect( ConnectionTrackerInterface* tracker, CallbackBase* callback );
/**
- * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... )
+ * @brief Called by Signal implementations, when the user calls Signal.Disconnect( ... ).
*
* @SINCE_1_0.0
- * @param[in] tracker The connection tracker.
- * @param[in] callback A newly allocated callback object (takes ownership).
+ * @param[in] tracker The connection tracker
+ * @param[in] callback A newly allocated callback object (takes ownership)
*/
void OnDisconnect( ConnectionTrackerInterface* tracker, CallbackBase* callback );
* @brief Returns a callback given an index in to the connection array.
*
* @SINCE_1_0.0
- * @param[in] connectionIndex The index of the callback.
- * @return The callback, or NULL if the connection has been deleted.
+ * @param[in] connectionIndex The index of the callback
+ * @return The callback, or NULL if the connection has been deleted
*/
CallbackBase* GetCallback( std::size_t connectionIndex ) const;
* @brief Helper to find whether a callback is connected.
*
* @SINCE_1_0.0
- * @param[in] callback The call back object.
- * @return A valid index if the callback is connected.
+ * @param[in] callback The call back object
+ * @return A valid index if the callback is connected
*/
int FindCallback( CallbackBase* callback );
* @brief Deletes a connection object from the list of connections.
*
* @SINCE_1_0.0
- * @param[in] connectionIndex The index of the callback.
+ * @param[in] connectionIndex The index of the callback
*/
void DeleteConnection( std::size_t connectionIndex );
public:
/**
- * @brief Default constructor
+ * @brief Default constructor.
* @SINCE_1_0.0
*/
CallbackBase();
/**
- * @brief Destructor
+ * @brief Destructor.
* @SINCE_1_0.0
*/
~CallbackBase();
void Reset();
/**
- * @brief Function to call the function or member function dispatcher
+ * @brief Function to call the function or member function dispatcher.
*
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
+ * @param[in] callback The callback to call
*/
static void Execute( CallbackBase& callback )
{
* @brief Function to call the function or member function dispatcher.
*
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @return value from the function
+ * @param[in] callback The callback to call
+ * @return The value from the function
*/
template< typename R >
static R ExecuteReturn( CallbackBase& callback )
/**
* @brief Function to call the function or member function dispatcher.
*
- * This function template gets instantiated at the call site
+ * This function template gets instantiated at the call site.
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @param[in] param1 The first parameter to pass into the function.
+ * @param[in] callback The callback to call
+ * @param[in] param1 The first parameter to pass into the function
*/
template< typename P1 >
static void Execute( CallbackBase& callback, P1 param1 )
/**
* @brief Function to call the function or member function dispatcher.
*
- * This function template gets instantiated at the call site
+ * This function template gets instantiated at the call site.
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @param[in] param1 The first parameter to pass into the function.
- * @return the value from the function
+ * @param[in] callback The callback to call
+ * @param[in] param1 The first parameter to pass into the function
+ * @return The value from the function
*/
template< typename R, typename P1 >
static R ExecuteReturn( CallbackBase& callback, P1 param1 )
*
* This function template gets instantiated at the call site.
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @param[in] param1 The first parameter to pass into the function.
- * @param[in] param2 The second parameter to pass into the function.
+ * @param[in] callback The callback to call
+ * @param[in] param1 The first parameter to pass into the function
+ * @param[in] param2 The second parameter to pass into the function
*/
template< typename P1, typename P2 >
static void Execute( CallbackBase& callback, P1 param1, P2 param2 )
/**
* @brief Function to call the function or member function dispatcher.
*
- * This function template gets instantiated at the call site
+ * This function template gets instantiated at the call site.
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @param[in] param1 The first parameter to pass into the function.
- * @param[in] param2 The second parameter to pass into the function.
+ * @param[in] callback The callback to call
+ * @param[in] param1 The first parameter to pass into the function
+ * @param[in] param2 The second parameter to pass into the function
* @return The return value from the function
*/
template< typename R, typename P1, typename P2 >
*
* This function template gets instantiated at the call site.
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @param[in] param1 The first parameter to pass into the function.
- * @param[in] param2 The second parameter to pass into the function.
- * @param[in] param3 The third parameter to pass into the function.
+ * @param[in] callback The callback to call
+ * @param[in] param1 The first parameter to pass into the function
+ * @param[in] param2 The second parameter to pass into the function
+ * @param[in] param3 The third parameter to pass into the function
*/
template< typename P1, typename P2, typename P3 >
static void Execute( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
/**
* @brief Function to call the function or member function dispatcher.
*
- * This function template gets instantiated at the call site
+ * This function template gets instantiated at the call site.
* @SINCE_1_0.0
- * @param[in] callback The callback to call.
- * @param[in] param1 The first parameter to pass into the function.
- * @param[in] param2 The second parameter to pass into the function.
- * @param[in] param3 The third parameter to pass into the function.
+ * @param[in] callback The callback to call
+ * @param[in] param1 The first parameter to pass into the function
+ * @param[in] param2 The second parameter to pass into the function
+ * @param[in] param3 The third parameter to pass into the function
* @return The return value from the function
*/
template< typename R, typename P1, typename P2, typename P3 >
protected: // Constructors for deriving classes
/**
- * @brief Function with static linkage
+ * @brief Function with static linkage.
* @SINCE_1_0.0
*/
typedef void(*Function)(void);
/**
- * @brief Member function
+ * @brief Member function.
* @SINCE_1_0.0
*/
typedef void (CallbackBase::*MemberFunction)( void );
/**
- * @brief Used to call the correct member function
+ * @brief Used to call the correct member function.
* @SINCE_1_0.0
*/
typedef void (*Dispatcher)( CallbackBase& base );
/**
- * @brief Used to destroy mObjectPointer (NULL if not mObjectPointer is not owned)
+ * @brief Used to destroy mObjectPointer (NULL if not mObjectPointer is not owned).
* @SINCE_1_0.0
*/
typedef void(*Destructor)(void* object);
CallbackBase( const CallbackBase& rhs );
/**
- * @brief assignment operator not declared.
+ * @brief Assignment operator not declared.
* @SINCE_1_0.0
* @param[in] rhs Handle to an object
* @return A reference to this
* @brief Constructor for function with static linkage.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
+ * @param[in] function The function to call
*/
CallbackBase( Function function );
* @brief Constructor for member function.
*
* @SINCE_1_0.0
- * @param[in] object The object to call (not owned).
- * @param[in] function The member function of the object.
- * @param[in] dispatcher Used to call the actual object.
+ * @param[in] object The object to call (not owned)
+ * @param[in] function The member function of the object
+ * @param[in] dispatcher Used to call the actual object
*/
CallbackBase( void* object, MemberFunction function, Dispatcher dispatcher );
* @brief Constructor for member function.
*
* @SINCE_1_0.0
- * @param[in] object The object to call (owned).
- * @param[in] function The member function of the object.
- * @param dispatcher Used to call the actual object.
- * @param destructor Used to delete the owned object.
+ * @param[in] object The object to call (owned)
+ * @param[in] function The member function of the object
+ * @param dispatcher Used to call the actual object
+ * @param destructor Used to delete the owned object
*/
CallbackBase( void* object, MemberFunction function, Dispatcher dispatcher, Destructor destructor );
public: // Data for deriving classes & Dispatchers
/**
- * @brief struct to hold the extra data needed for member functions.
+ * @brief Struct to hold the extra data needed for member functions.
* @SINCE_1_0.0
*/
struct Impl
};
/**
- * @brief Non-member equality operator
+ * @brief Non-member equality operator.
* @SINCE_1_0.0
* @param[in] lhs A reference to compare
* @param[in] rhs A reference to compare to
- * @return true if lhs is same as rhs
+ * @return True if lhs is same as rhs
*/
bool operator==( const CallbackBase& lhs, const CallbackBase& rhs );
struct Dispatcher0
{
/**
- * @brief Call an actual member function.
+ * @brief Calls an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
+ * @param[in] callback The callback information
*/
static void Dispatch( CallbackBase& callback )
{
struct Dispatcher1
{
/**
- * @brief Call an actual member function.
+ * @brief Calls an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1 )
{
* @brief Call an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1, P2 param2 )
{
* @brief Call an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
- * @param[in] param3 The third parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
+ * @param[in] param3 The third parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
{
struct DispatcherReturn0
{
/**
- * @brief Call an actual member function.
+ * @brief Calls an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @return the value.
+ * @param[in] callback The callback information
+ * @return The value
*/
static R Dispatch( CallbackBase& callback )
{
struct DispatcherReturn1
{
/**
- * @brief Call an actual member function.
+ * @brief Calls an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1 )
struct DispatcherReturn2
{
/**
- * @brief Call an actual member function.
+ * @brief Calls an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1, P2 param2 )
struct DispatcherReturn3
{
/**
- * @brief Call an actual member function.
+ * @brief Calls an actual member function.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
- * @param[in] param3 The third parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
+ * @param[in] param3 The third parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
struct FunctorDispatcher0
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
+ * @param[in] callback The callback information
*/
static void Dispatch( CallbackBase& callback )
{
struct FunctorDispatcher1
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
+ * @param[in] callback The callback information
* @param[in] param1 The first parameter to pass to the real member function.
*/
static void Dispatch( CallbackBase& callback, P1 param1 )
struct FunctorDispatcher2
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1, P2 param2 )
{
struct FunctorDispatcher3
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
- * @param[in] param3 The third parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
+ * @param[in] param3 The third parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
{
struct FunctorDispatcherReturn0
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @return the value.
+ * @param[in] callback The callback information
+ * @return The value
*/
static R Dispatch( CallbackBase& callback )
{
struct FunctorDispatcherReturn1
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1 )
struct FunctorDispatcherReturn2
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1, P2 param2 )
struct FunctorDispatcherReturn3
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
- * @param[in] param3 The third parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
+ * @param[in] param3 The third parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
struct VoidFunctorDispatcher0
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
+ * @param[in] callback The callback information
*/
static void Dispatch( CallbackBase& callback )
{
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, ignoring any signal parameters
+ * This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
*/
template< class T, typename P1 >
struct VoidFunctorDispatcher1
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1 )
{
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, ignoring any signal parameters
+ * This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename P2 >
struct VoidFunctorDispatcher2
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1, P2 param2 )
{
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, ignoring any signal parameters
+ * This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename P2, typename P3 >
struct VoidFunctorDispatcher3
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
- * @param[in] param3 The third parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
+ * @param[in] param3 The third parameter to pass to the real member function
*/
static void Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
{
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, and returns a default-constructed value
+ * This variant calls a void() member, and returns a default-constructed value.
* @SINCE_1_0.0
*/
template< class T, typename R >
struct VoidFunctorDispatcherReturn0
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @return the value.
+ * @param[in] callback The callback information
+ * @return The value
*/
static R Dispatch( CallbackBase& callback )
{
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, and returns a default-constructed value
+ * This variant calls a void() member, and returns a default-constructed value.
* @SINCE_1_0.0
*/
template< class T, typename R, typename P1 >
struct VoidFunctorDispatcherReturn1
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1 )
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, and returns a default-constructed value
+ * This variant calls a void() member, and returns a default-constructed value.
* @SINCE_1_0.0
*/
template< class T, typename R, typename P1, typename P2 >
struct VoidFunctorDispatcherReturn2
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1, P2 param2 )
/**
* @brief Dispatcher to call a functor.
*
- * This variant calls a void() member, and returns a default-constructed value
+ * This variant calls a void() member, and returns a default-constructed value.
* @SINCE_1_0.0
*/
template< class T, typename R, typename P1, typename P2, typename P3 >
struct VoidFunctorDispatcherReturn3
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] callback The callback information.
- * @param[in] param1 The first parameter to pass to the real member function.
- * @param[in] param2 The second parameter to pass to the real member function.
- * @param[in] param3 The third parameter to pass to the real member function.
+ * @param[in] callback The callback information
+ * @param[in] param1 The first parameter to pass to the real member function
+ * @param[in] param2 The second parameter to pass to the real member function
+ * @param[in] param3 The third parameter to pass to the real member function
* @return The return value from the function
*/
static R Dispatch( CallbackBase& callback, P1 param1, P2 param2, P3 param3 )
/**
* @brief Thin template to provide type safety for member function callbacks.
*
- * version with two parameters and return value
+ * Version with two parameters and return value.
* @SINCE_1_0.0
*/
template< class T >
*
* Copies the function object.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] memberFunction The member function of the object.
+ * @param[in] object The object to call
+ * @param[in] memberFunction The member function of the object
*/
Callback( T* object, void(T::*memberFunction)(void) )
: CallbackBase( object,
* @brief Constructors for functions with static linkage.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
+ * @param[in] function The function to call
*/
CallbackFunction( void(*function)() )
: CallbackBase( reinterpret_cast< CallbackBase::Function >( function ) )
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctor0( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
class CallbackFunctorDelegate0 : public CallbackBase
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object A newly allocated object (ownership is transferred).
+ * @param[in] object A newly allocated object (ownership is transferred)
*/
CallbackFunctorDelegate0( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctor1( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegate1( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
};
/**
- * @brief Function object callback for matching callbacks to signal signature
+ * @brief Function object callback for matching callbacks to signal signature.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename P2 >
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctor2( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
template< typename P1, typename P2 >
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegate2( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
};
/**
- * @brief Function object callback for matching callbacks to signal signature
+ * @brief Function object callback for matching callbacks to signal signature.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename P2, typename P3 >
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctor3( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
template< typename P1, typename P2, typename P3 >
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegate3( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
};
/**
- * @brief Function object callback for matching callbacks to signal signature
+ * @brief Function object callback for matching callbacks to signal signature.
* @SINCE_1_0.0
*/
template< class T, typename R >
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorReturn0( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
template< typename R >
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegateReturn0( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
};
/**
- * @brief Function object callback for matching callbacks to signal signature
+ * @brief Function object callback for matching callbacks to signal signature.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename R >
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorReturn1( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
template< typename P1, typename R >
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegateReturn1( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
};
/**
- * @brief Function object callback for matching callbacks to signal signature
+ * @brief Function object callback for matching callbacks to signal signature.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename P2, typename R >
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorReturn2( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
template< typename P1, typename P2, typename R >
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegateReturn2( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
};
/**
- * @brief Function object callback for matching callbacks to signal signature
+ * @brief Function object callback for matching callbacks to signal signature.
* @SINCE_1_0.0
*/
template< class T, typename P1, typename P2, typename P3, typename R >
* @brief Constructor which copies a function object.
*
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorReturn3( const T& object )
: CallbackBase( reinterpret_cast< void* >( new T( object ) ), // copy the object
};
/**
- * @brief Function object callback for connecting void() methods
+ * @brief Function object callback for connecting void() methods.
* @SINCE_1_0.0
*/
template< typename P1, typename P2, typename P3, typename R >
*
* This variant calls a void() member, ignoring any signal parameters.
* @SINCE_1_0.0
- * @param[in] object The object to copy.
+ * @param[in] object The object to copy
*/
CallbackFunctorDelegateReturn3( FunctorDelegate* object )
: CallbackBase( reinterpret_cast< void* >( object ), // transfer ownership
* @brief Creates a callback from a C function or static member function with no parameters.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
inline CallbackBase* MakeCallback( void(*function)(void) )
{
* @brief Creates a callback from a C function or static member function with one parameter.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename P1 >
inline CallbackBase* MakeCallback( void(*function)(P1) )
* @brief Creates a callback from a C function or static member function with no parameters and a return type.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename R >
inline CallbackBase* MakeCallback( R(*function)(void) )
* @brief Creates a callback from a C function or static member function with one parameter and a return type.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename R, typename P1 >
inline CallbackBase* MakeCallback( R(*function)(P1) )
* @brief Creates a callback from a C function or static member function with two parameters.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename P1, typename P2 >
inline CallbackBase* MakeCallback( void(*function)(P1,P2) )
* @brief Creates a callback from a C function or static member function with two parameters and a return type.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename R, typename P1, typename P2 >
inline CallbackBase* MakeCallback( R(*function)(P1,P2) )
* @brief Creates a callback from a C function or static member function with three parameters.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename P1, typename P2, typename P3 >
inline CallbackBase* MakeCallback( void(*function)(P1,P2,P3) )
* @brief Creates a callback from a C function or static member function with three parameters and a return type.
*
* @SINCE_1_0.0
- * @param[in] function The function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] function The function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< typename R, typename P1, typename P2, typename P3 >
inline CallbackBase* MakeCallback( R(*function)(P1,P2,P3) )
/**
* @brief Creates a callback from a class member function with no parameters.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T >
inline CallbackBase* MakeCallback( T* object, void(T::*function)(void) )
/**
* @brief Creates a callback from a class member function with one parameter.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename P1 >
inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1) )
/**
* @brief Creates a callback from a class member function with two parameters.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename P1, typename P2 >
inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1,P2) )
/**
* @brief Creates a callback from a class member function with three parameters.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename P1, typename P2, typename P3 >
inline CallbackBase* MakeCallback( T* object, void(T::*function)(P1,P2,P3) )
/**
* @brief Creates a callback from a class member function with no parameters and a return type.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename R >
inline CallbackBase* MakeCallback( T* object, R(T::*function)() )
/**
* @brief Creates a callback from a class member function with one parameter and a return type.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename P1, typename R >
inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1) )
/**
* @brief Creates a callback from a class member function with two parameters and a return type.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename P1, typename P2, typename R >
inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1,P2) )
/**
* @brief Creates a callback from a class member function with three parameters and a return type.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, typename P1, typename P2, typename P3, typename R >
inline CallbackBase* MakeCallback( T* object, R(T::*function)(P1,P2,P3) )
/**
* @brief Creates a callback from a class's parent member function with no parameters.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, class Base >
inline CallbackBase* MakeCallback( T* object, void(Base::*function)(void) )
/**
* @brief Creates a callback from a class's parent member function with no parameters.
*
- * requires the function to be member of the same class
+ * Requires the function to be member of the same class.
* @SINCE_1_0.0
- * @param[in] object The object to call.
- * @param[in] function The member function to call.
- * @return a newly allocated Callback object, ownership transferred to caller
+ * @param[in] object The object to call
+ * @param[in] function The member function to call
+ * @return A newly allocated Callback object, ownership transferred to caller
*/
template< class T, class Base >
inline CallbackBase* MakeCallback( T& object, void(Base::*function)(void) )
* @brief Called when a signal is connected.
*
* @SINCE_1_0.0
- * @param[in] slotObserver The slot observer i.e. a signal. Ownership is not passed.
- * @param[in] callback The call back. Ownership is not passed.
+ * @param[in] slotObserver The slot observer i.e. a signal. Ownership is not passed
+ * @param[in] callback The call back. Ownership is not passed
*/
virtual void SignalConnected( SlotObserver* slotObserver, CallbackBase* callback ) = 0;
class SlotConnection;
/**
- * @brief Connection tracker concrete implementation
+ * @brief Connection tracker concrete implementation.
* @SINCE_1_0.0
*/
class DALI_IMPORT_API ConnectionTracker : public ConnectionTrackerInterface
virtual ~ConnectionTracker();
/**
- * @brief Disconnect all signals from this object.
+ * @brief Disconnects all signals from this object.
* @SINCE_1_0.0
*/
void DisconnectAll();
virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback );
/**
- * @brief returns the connection count
+ * @brief Returns the connection count.
* @SINCE_1_0.0
- * @return the connection count
+ * @return The connection count
*/
std::size_t GetConnectionCount() const;
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( void (*func)() )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( void (*func)() )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, void (X::*func)() )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, void (X::*func)() )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, void (X::*func)() )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, void (X::*func)() )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
* @SINCE_1_0.0
*/
void Emit()
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
return mImpl.GetConnectionCount();
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( Ret (*func)() )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( Ret (*func)() )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, Ret (X::*func)() )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, Ret (X::*func)() )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, Ret (X::*func)() )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, Ret (X::*func)() )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @return The value returned by the last callback, or a default constructed value if no callbacks are connected.
+ * @return The value returned by the last callback, or a default constructed value if no callbacks are connected
*/
Ret Emit()
{
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
return mImpl.GetConnectionCount();
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( void (*func)( Arg0 arg0 ) )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( void (*func)( Arg0 arg0 ) )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, void (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, void (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, void (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, void (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first value to pass to callbacks.
+ * @param[in] arg0 The first value to pass to callbacks
*/
void Emit( Arg0 arg0 )
{
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
return mImpl.GetConnectionCount();
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( Ret (*func)( Arg0 arg0 ) )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( Ret (*func)( Arg0 arg0 ) )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, Ret (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, Ret (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, Ret (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, Ret (X::*func)( Arg0 arg0 ) )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first value to pass to callbacks.
- * @return The value returned by the last callback, or a default constructed value if no callbacks are connected.
+ * @param[in] arg0 The first value to pass to callbacks
+ * @return The value returned by the last callback, or a default constructed value if no callbacks are connected
*/
Ret Emit( Arg0 arg0 )
{
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
return mImpl.GetConnectionCount();
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( void (*func)( Arg0 arg0, Arg1 arg1 ) )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( void (*func)( Arg0 arg0, Arg1 arg1 ) )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, void (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, void (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, void (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, void (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first value to pass to callbacks.
- * @param[in] arg1 The second value to pass to callbacks.
+ * @param[in] arg0 The first value to pass to callbacks
+ * @param[in] arg1 The second value to pass to callbacks
*/
void Emit( Arg0 arg0, Arg1 arg1 )
{
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
return mImpl.GetConnectionCount();
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( Ret (*func)( Arg0 arg0, Arg1 arg1 ) )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( Ret (*func)( Arg0 arg0, Arg1 arg1 ) )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, Ret (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, Ret (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, Ret (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, Ret (X::*func)( Arg0 arg0, Arg1 arg1 ) )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first value to pass to callbacks.
- * @param[in] arg1 The second value to pass to callbacks.
- * @return The value returned by the last callback, or a default constructed value if no callbacks are connected.
+ * @param[in] arg0 The first value to pass to callbacks
+ * @param[in] arg1 The second value to pass to callbacks
+ * @return The value returned by the last callback, or a default constructed value if no callbacks are connected
*/
Ret Emit( Arg0 arg0, Arg1 arg1 )
{
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
return mImpl.GetConnectionCount();
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( void (*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( void (*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, void (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, void (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, void (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, void (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first value to pass to callbacks.
- * @param[in] arg1 The second value to pass to callbacks.
- * @param[in] arg2 The third value to pass to callbacks.
+ * @param[in] arg0 The first value to pass to callbacks
+ * @param[in] arg1 The second value to pass to callbacks
+ * @param[in] arg2 The third value to pass to callbacks
*/
void Emit( Arg0 arg0, Arg1 arg1, Arg2 arg2 )
{
}
/**
- * @brief Query whether there are any connected slots.
+ * @brief Queries whether there are any connected slots.
*
* @SINCE_1_0.0
- * @return True if there are any slots connected to the signal.
+ * @return True if there are any slots connected to the signal
*/
bool Empty() const
{
}
/**
- * @brief Query the number of slots.
+ * @brief Queries the number of slots.
*
* @SINCE_1_0.0
- * @return The number of slots connected to this signal.
+ * @return The number of slots connected to this signal
*/
std::size_t GetConnectionCount() const
{
}
/**
- * @brief Connect a function.
+ * @brief Connects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to connect.
+ * @param[in] func The function to connect
*/
void Connect( Ret (*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
{
}
/**
- * @brief Disconnect a function.
+ * @brief Disconnects a function.
*
* @SINCE_1_0.0
- * @param[in] func The function to disconnect.
+ * @param[in] func The function to disconnect
*/
void Disconnect( Ret (*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
{
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to connect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( X* obj, Ret (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] obj An object which must implement the ConnectionTrackerInterface.
- * @param[in] func The member function to disconnect.
+ * @param[in] obj An object which must implement the ConnectionTrackerInterface
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( X* obj, Ret (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Connect a member function.
+ * @brief Connects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to connect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to connect
*/
template<class X>
void Connect( SlotDelegate<X>& delegate, Ret (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Disconnect a member function.
+ * @brief Disconnects a member function.
*
* @SINCE_1_0.0
- * @param[in] delegate A slot delegate.
- * @param[in] func The member function to disconnect.
+ * @param[in] delegate A slot delegate
+ * @param[in] func The member function to disconnect
*/
template<class X>
void Disconnect( SlotDelegate<X>& delegate, Ret (X::*func)( Arg0 arg0, Arg1 arg1, Arg2 arg2 ) )
}
/**
- * @brief Connect a function object.
+ * @brief Connects a function object.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] func The function object to copy.
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] func The function object to copy
*/
template<class X>
void Connect( ConnectionTrackerInterface* connectionTracker, const X& func )
}
/**
- * @brief Connect a function object using FunctorDelegate.
+ * @brief Connects a function object using FunctorDelegate.
*
* @SINCE_1_0.0
- * @param[in] connectionTracker A connection tracker which can be used to disconnect.
- * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken).
+ * @param[in] connectionTracker A connection tracker which can be used to disconnect
+ * @param[in] delegate A newly allocated FunctorDelegate (ownership is taken)
*/
void Connect( ConnectionTrackerInterface* connectionTracker, FunctorDelegate* delegate )
{
}
/**
- * @brief Emit the signal.
+ * @brief Emits the signal.
*
* @SINCE_1_0.0
- * @param[in] arg0 The first value to pass to callbacks.
- * @param[in] arg1 The second value to pass to callbacks.
- * @param[in] arg2 The third value to pass to callbacks.
- * @return The value returned by the last callback, or a default constructed value if no callbacks are connected.
+ * @param[in] arg0 The first value to pass to callbacks
+ * @param[in] arg1 The second value to pass to callbacks
+ * @param[in] arg2 The third value to pass to callbacks
+ * @return The value returned by the last callback, or a default constructed value if no callbacks are connected
*/
Ret Emit( Arg0 arg0, Arg1 arg1, Arg2 arg2 )
{
*/
/**
- * @brief Dispatcher to call a functor
+ * @brief Dispatcher to call a functor.
* @SINCE_1_0.0
*/
template< typename T >
struct FunctorDispatcher
{
/**
- * @brief Call a function object.
+ * @brief Calls a function object.
*
* @SINCE_1_0.0
- * @param[in] functorPtr The functor to call.
+ * @param[in] functorPtr The functor to call
*/
static void Dispatch( void* functorPtr )
{
};
/**
- * @brief Dispatcher to delete a functor object
+ * @brief Dispatcher to delete a functor object.
* @SINCE_1_0.0
*/
template< typename T >
struct FunctorDestroyer
{
/**
- * @brief Dispatcher to delete an object
+ * @brief Dispatcher to delete an object.
* @SINCE_1_0.0
* @param[in] functorPtr A functor object to delete
*/
};
/**
- * @brief Used to connect a void() functor to a signal via BaseObject::SignalConnect()
+ * @brief Used to connect a void() functor to a signal via BaseObject::SignalConnect().
* @SINCE_1_0.0
*/
class DALI_IMPORT_API FunctorDelegate
~FunctorDelegate();
/**
- * @brief Function to call the function or member function dispatcher
+ * @brief Function to call the function or member function dispatcher.
* @SINCE_1_0.0
*/
void Execute();
typedef void(*Destructor)( void* objectPtr );
/**
- * @brief Not defined
+ * @brief Not defined.
* @SINCE_1_0.0
*/
FunctorDelegate( const FunctorDelegate& rhs );
/**
- * @brief Not defined
+ * @brief Not defined.
* @SINCE_1_0.0
*/
const FunctorDelegate& operator=( const FunctorDelegate& rhs );
*
* @SINCE_1_0.0
* @param[in] functorPtr A newly allocated functor object (takes ownership)
- * @param dispatcher Used to call the actual function.
- * @param destructor Used to delete the owned functor object.
+ * @param dispatcher Used to call the actual function
+ * @param destructor Used to delete the owned functor object
*/
FunctorDelegate( void* functorPtr, Dispatcher dispatcher, Destructor destructor );
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] slotObserver The slot observer.
- * @param[in] callback A callback object (not owned).
+ * @param[in] slotObserver The slot observer
+ * @param[in] callback A callback object (not owned)
*/
SlotConnection(SlotObserver* slotObserver, CallbackBase* callback);
~SlotConnection();
/**
- * @brief Retrieve the callback.
+ * @brief Retrieves the callback.
*
* @SINCE_1_0.0
- * @return A pointer to the callback.
+ * @return A pointer to the callback
*/
CallbackBase* GetCallback();
/**
- * @brief Retrieve the slot observer.
+ * @brief Retrieves the slot observer.
*
* @SINCE_1_0.0
- * @return A pointer to the slot observer.
+ * @return A pointer to the slot observer
*/
SlotObserver* GetSlotObserver();
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] callback The callback which should be a C function.
+ * @param[in] callback The callback which should be a C function
*/
SignalConnection( CallbackBase* callback );
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] signalObserver The signal observer.
- * @param[in] callback Ownership of this callback object is taken.
+ * @param[in] signalObserver The signal observer
+ * @param[in] callback Ownership of this callback object is taken
*/
SignalConnection( SignalObserver* signalObserver, CallbackBase* callback );
~SignalConnection();
/**
- * @brief Disconnect the signal from the slot.
+ * @brief Disconnects the signal from the slot.
*
* @SINCE_1_0.0
- * @param[in] slotObserver The signal disconnecting from the slot.
+ * @param[in] slotObserver The signal disconnecting from the slot
*/
void Disconnect( SlotObserver* slotObserver );
/**
- * @brief Retrieve the callback.
+ * @brief Retrieves the callback.
*
* @SINCE_1_0.0
- * @return A pointer to the callback.
+ * @return A pointer to the callback
*/
CallbackBase* GetCallback();
* @brief This method is called when the signal is disconnecting.
*
* @SINCE_1_0.0
- * @param[in] slotObserver The signal that has disconnected.
- * @param[in] callback The callback attached to the signal disconnected.
+ * @param[in] slotObserver The signal that has disconnected
+ * @param[in] callback The callback attached to the signal disconnected
*/
virtual void SignalDisconnected( SlotObserver* slotObserver, CallbackBase* callback ) = 0;
};
* @brief This method is called when the slot is disconnecting.
*
* @SINCE_1_0.0
- * @param[in] callback The callback attached to the signal disconnected.
+ * @param[in] callback The callback attached to the signal disconnected
*/
virtual void SlotDisconnected( CallbackBase* callback ) = 0;
};
* @brief Constructor.
*
* @SINCE_1_0.0
- * @param[in] slot The object with a callback.
+ * @param[in] slot The object with a callback
*/
SlotDelegate( Slot* slot )
: mSlot( slot )
}
/**
- * @brief Disconnect all signals from this object.
+ * @brief Disconnects all signals from this object.
*
* @SINCE_1_0.0
*/
}
/**
- * @brief Retrieve the slot object.
+ * @brief Retrieves the slot object.
*
* @SINCE_1_0.0
- * @return The object with a callback.
+ * @return The object with a callback
*/
Slot* GetSlot()
{
}
/**
- * @brief Retrieve the connection tracker component.
+ * @brief Retrieves the connection tracker component.
*
* @SINCE_1_0.0
- * @return The connection tracker component.
+ * @return The connection tracker component
*/
ConnectionTracker* GetConnectionTracker()
{
/**
- * @brief Interface to encapsulate information required for relayout
+ * @brief Interface to encapsulate information required for relayout.
* @SINCE_1_0.0
*/
class RelayoutContainer
public:
/**
- * @brief Default constructor
+ * @brief Default constructor.
*
* @SINCE_1_0.0
*/
RelayoutContainer() {}
/**
- * @brief Virtual destructor
+ * @brief Virtual destructor.
* @SINCE_1_0.0
*/
virtual ~RelayoutContainer() {}
/**
- * @brief Add relayout information to the container if it does'nt already exist
+ * @brief Adds relayout information to the container if it doesn't already exist.
*
* @SINCE_1_0.0
* @param actor The actor to relayout
projects / platform / core / uifw / dali-core.git / commitdiff