{
FIXED, ///< Size is fixed as set by SetSize @SINCE_1_0.0
USE_NATURAL_SIZE, ///< Size is to use the actor's natural size @SINCE_1_0.0
- FILL_TO_PARENT, ///< Size is to fill up to the actor's parent's bounds. Aspect ratio not maintained. @SINCE_1_0.0
+ FILL_TO_PARENT, ///< Size is to fill up to the actor's parent's bounds. Aspect ratio is not maintained. @SINCE_1_0.0
SIZE_RELATIVE_TO_PARENT, ///< The actors size will be ( ParentSize * SizeRelativeToParentFactor ). @SINCE_1_0.0
SIZE_FIXED_OFFSET_FROM_PARENT, ///< The actors size will be ( ParentSize + SizeRelativeToParentFactor ). @SINCE_1_0.0
FIT_TO_CHILDREN, ///< Size will adjust to wrap around all children @SINCE_1_0.0
}
/**
- * @brief Different types of alignment.
+ * @brief Horizontal alignment types.
* @SINCE_1_0.0
*/
namespace HorizontalAlignment
};
}
+/**
+ * @brief Vertical alignment types.
+ * @SINCE_1_0.0
+ */
namespace VerticalAlignment
{
enum Type
* {
* // Only hit-test the actor and its children if it is sensitive and visible
* IF ( ACTOR-IS-SENSITIVE &&
- * ACTOR-IS-VISIBLE )
+ * ACTOR-IS-VISIBLE &&
+ * ACTOR-IS-ON-STAGE )
* {
* // Depth-first traversal within current layer, visiting parent first
*
- * // Check whether current actor should be hit-tested
+ * // Check whether current actor should be hit-tested.
* IF ( ( TOUCH-SIGNAL-NOT-EMPTY || HOVER-SIGNAL-NOT-EMPTY ) &&
* ACTOR-HAS-NON-ZERO-SIZE &&
* ACTOR-WORLD-COLOR-IS-NOT-TRANSPARENT )
* {
* IF ( ACTOR-IS-OVERLAY || ( DISTANCE-TO-ACTOR < DISTANCE-TO-LAST-HIT-ACTOR ) )
* {
- * // The current actor is the closest actor that was underneath the touch
+ * // The current actor is the closest actor that was underneath the touch.
* LAST-HIT-ACTOR = CURRENT-ACTOR
* }
* }
* }
*
- * // Keep checking children, in case we hit something closer
+ * // Keep checking children, in case we hit something closer.
* FOR-EACH CHILD (in order)
* {
* IF ( CHILD-IS-NOT-A-LAYER )
* // Continue traversal for this child's sub-tree
* HIT-TEST-WITHIN-LAYER ( CHILD )
* }
- * // else we skip hit-testing the child's sub-tree altogether
+ * // else we skip hit-testing the child's sub-tree altogether.
* }
* }
* }
*
* IF ( NOT-CONSUMED )
* {
- * // If event is not consumed then deliver it to the parent unless we reach the root actor
+ * // If event is not consumed then deliver it to the parent unless we reach the root actor.
* IF ( ACTOR-PARENT )
* {
* EMIT-HOVER-SIGNAL( ACTOR-PARENT )
* touch signals are also emitted from the touch-down actor with an "Interrupted" state.
* - If the consumed actor on hover-start is not the same as the consumed actor on hover-finished, then
* hover signals are also emitted from the hover-started actor with an "Interrupted" state.
+ *
* <h3>Key Events:</h3>
*
* Key events are received by an actor once set to grab key events, only one actor can be set as focused.
{
enum
{
- PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin", type Vector3 @SINCE_1_0.0
- PARENT_ORIGIN_X, ///< name "parentOriginX", type float @SINCE_1_0.0
- PARENT_ORIGIN_Y, ///< name "parentOriginY", type float @SINCE_1_0.0
- PARENT_ORIGIN_Z, ///< name "parentOriginZ", type float @SINCE_1_0.0
- ANCHOR_POINT, ///< name "anchorPoint", type Vector3 @SINCE_1_0.0
- ANCHOR_POINT_X, ///< name "anchorPointX", type float @SINCE_1_0.0
- ANCHOR_POINT_Y, ///< name "anchorPointY", type float @SINCE_1_0.0
- ANCHOR_POINT_Z, ///< name "anchorPointZ", type float @SINCE_1_0.0
- SIZE, ///< name "size", type Vector3 @SINCE_1_0.0
- SIZE_WIDTH, ///< name "sizeWidth", type float @SINCE_1_0.0
- SIZE_HEIGHT, ///< name "sizeHeight", type float @SINCE_1_0.0
- SIZE_DEPTH, ///< name "sizeDepth", type float @SINCE_1_0.0
- POSITION, ///< name "position", type Vector3 @SINCE_1_0.0
- POSITION_X, ///< name "positionX", type float @SINCE_1_0.0
- POSITION_Y, ///< name "positionY", type float @SINCE_1_0.0
- POSITION_Z, ///< name "positionZ", type float @SINCE_1_0.0
- WORLD_POSITION, ///< name "worldPosition", type Vector3 (read-only) @SINCE_1_0.0
- WORLD_POSITION_X, ///< name "worldPositionX", type float (read-only) @SINCE_1_0.0
- WORLD_POSITION_Y, ///< name "worldPositionY", type float (read-only) @SINCE_1_0.0
- WORLD_POSITION_Z, ///< name "worldPositionZ", type float (read-only) @SINCE_1_0.0
- ORIENTATION, ///< name "orientation", type Quaternion @SINCE_1_0.0
- WORLD_ORIENTATION, ///< name "worldOrientation", type Quaternion (read-only) @SINCE_1_0.0
- SCALE, ///< name "scale", type Vector3 @SINCE_1_0.0
- SCALE_X, ///< name "scaleX", type float @SINCE_1_0.0
- SCALE_Y, ///< name "scaleY", type float @SINCE_1_0.0
- SCALE_Z, ///< name "scaleZ", type float @SINCE_1_0.0
- WORLD_SCALE, ///< name "worldScale", type Vector3 (read-only) @SINCE_1_0.0
- VISIBLE, ///< name "visible", type bool @SINCE_1_0.0
- COLOR, ///< name "color", type Vector4 @SINCE_1_0.0
- COLOR_RED, ///< name "colorRed", type float @SINCE_1_0.0
- COLOR_GREEN, ///< name "colorGreen", type float @SINCE_1_0.0
- COLOR_BLUE, ///< name "colorBlue", type float @SINCE_1_0.0
- COLOR_ALPHA, ///< name "colorAlpha", type float @SINCE_1_0.0
- WORLD_COLOR, ///< name "worldColor", type Vector4 (read-only) @SINCE_1_0.0
- WORLD_MATRIX, ///< name "worldMatrix", type Matrix (read-only) @SINCE_1_0.0
+ PARENT_ORIGIN = DEFAULT_ACTOR_PROPERTY_START_INDEX, ///< name "parentOrigin", type Vector3 (constraint-input) @SINCE_1_0.0
+ PARENT_ORIGIN_X, ///< name "parentOriginX", type float (constraint-input) @SINCE_1_0.0
+ PARENT_ORIGIN_Y, ///< name "parentOriginY", type float (constraint-input) @SINCE_1_0.0
+ PARENT_ORIGIN_Z, ///< name "parentOriginZ", type float (constraint-input) @SINCE_1_0.0
+ ANCHOR_POINT, ///< name "anchorPoint", type Vector3 (constraint-input) @SINCE_1_0.0
+ ANCHOR_POINT_X, ///< name "anchorPointX", type float (constraint-input) @SINCE_1_0.0
+ ANCHOR_POINT_Y, ///< name "anchorPointY", type float (constraint-input) @SINCE_1_0.0
+ ANCHOR_POINT_Z, ///< name "anchorPointZ", type float (constraint-input) @SINCE_1_0.0
+ SIZE, ///< name "size", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
+ SIZE_WIDTH, ///< name "sizeWidth", type float (animatable / constraint-input) @SINCE_1_0.0
+ SIZE_HEIGHT, ///< name "sizeHeight", type float (animatable / constraint-input) @SINCE_1_0.0
+ SIZE_DEPTH, ///< name "sizeDepth", type float (animatable / constraint-input) @SINCE_1_0.0
+ POSITION, ///< name "position", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
+ POSITION_X, ///< name "positionX", type float (animatable / constraint-input) @SINCE_1_0.0
+ POSITION_Y, ///< name "positionY", type float (animatable / constraint-input) @SINCE_1_0.0
+ POSITION_Z, ///< name "positionZ", type float (animatable / constraint-input) @SINCE_1_0.0
+ WORLD_POSITION, ///< name "worldPosition", type Vector3 (read-only / constraint-input) @SINCE_1_0.0
+ WORLD_POSITION_X, ///< name "worldPositionX", type float (read-only / constraint-input) @SINCE_1_0.0
+ WORLD_POSITION_Y, ///< name "worldPositionY", type float (read-only / constraint-input) @SINCE_1_0.0
+ WORLD_POSITION_Z, ///< name "worldPositionZ", type float (read-only / constraint-input) @SINCE_1_0.0
+ ORIENTATION, ///< name "orientation", type Quaternion (animatable / constraint-input) @SINCE_1_0.0
+ WORLD_ORIENTATION, ///< name "worldOrientation", type Quaternion (read-only / constraint-input) @SINCE_1_0.0
+ SCALE, ///< name "scale", type Vector3 (animatable / constraint-input) @SINCE_1_0.0
+ SCALE_X, ///< name "scaleX", type float (animatable / constraint-input) @SINCE_1_0.0
+ SCALE_Y, ///< name "scaleY", type float (animatable / constraint-input) @SINCE_1_0.0
+ SCALE_Z, ///< name "scaleZ", type float (animatable / constraint-input) @SINCE_1_0.0
+ WORLD_SCALE, ///< name "worldScale", type Vector3 (read-only / constraint-input) @SINCE_1_0.0
+ VISIBLE, ///< name "visible", type bool (animatable / constraint-input) @SINCE_1_0.0
+ COLOR, ///< name "color", type Vector4 (animatable / constraint-input) @SINCE_1_0.0
+ COLOR_RED, ///< name "colorRed", type float (animatable / constraint-input) @SINCE_1_0.0
+ COLOR_GREEN, ///< name "colorGreen", type float (animatable / constraint-input) @SINCE_1_0.0
+ COLOR_BLUE, ///< name "colorBlue", type float (animatable / constraint-input) @SINCE_1_0.0
+ COLOR_ALPHA, ///< name "colorAlpha", type float (animatable / constraint-input) @SINCE_1_0.0
+ WORLD_COLOR, ///< name "worldColor", type Vector4 (read-only / constraint-input) @SINCE_1_0.0
+ WORLD_MATRIX, ///< name "worldMatrix", type Matrix (read-only / constraint-input) @SINCE_1_0.0
NAME, ///< name "name", type std::string @SINCE_1_0.0
SENSITIVE, ///< name "sensitive", type bool @SINCE_1_0.0
LEAVE_REQUIRED, ///< name "leaveRequired", type bool @SINCE_1_0.0
/**
* @brief Create an uninitialized Actor; this can be initialized with Actor::New().
*
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * Calling member functions with an uninitialized Actor handle is not allowed.
* @SINCE_1_0.0
*/
Actor();
static Actor New();
/**
- * @brief Downcast an Object handle to Actor handle.
+ * @brief Downcast 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.
*
* @SINCE_1_0.0
* @param [in] rhs The actor to copy.
+ * @return A reference to this
*/
Actor& operator=(const Actor& rhs);
/**
* @brief Adds a child Actor to this Actor.
*
- * 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,
- * scale etc as it now inherits them from this actor
* @SINCE_1_0.0
* @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
+ * @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,
+ * scale etc as it now inherits them from this actor.
*/
void Add(Actor child);
/**
* @brief Search through this actor's hierarchy for an actor with the given name.
*
- * The actor itself is also considered in the search
+ * 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.
/**
* @brief Search through this actor's hierarchy for an actor with the given unique ID.
*
- * The actor itself is also considered in the search
+ * 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.
* @brief Retrieve the actor's size.
*
* @SINCE_1_0.0
- * @return The actor's current 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
+ * @note This return is the value that was set using SetSize or the target size of an animation.
*/
Vector3 GetTargetSize() const;
* @brief Returns the actors position inheritance mode.
*
* @SINCE_1_0.0
- * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
+ * @return Return the position inheritance mode.
* @pre The Actor has been initialized.
*/
PositionInheritanceMode GetPositionInheritanceMode() const;
void SetInheritOrientation(bool inherit);
/**
- * @brief Returns whether the actor inherit's it's parent's orientation.
+ * @brief Returns whether the actor inherits its parent's orientation.
*
* @SINCE_1_0.0
- * @return true if the actor inherit's it's parent orientation, false if it uses world orientation.
+ * @return True if the actor inherits its parent orientation, false if it uses world orientation.
* @pre The Actor has been initialized.
*/
bool IsOrientationInherited() const;
* @brief Apply a relative scale to an actor.
*
* @SINCE_1_0.0
- * @param[in] relativeScale The scale to combine with the actors 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);
void SetInheritScale( bool inherit );
/**
- * @brief Returns whether the actor inherit's it's parent's scale.
+ * @brief Returns whether the actor inherits its parent's scale.
*
* @SINCE_1_0.0
- * @return true if the actor inherit's it's parent scale, false if it uses world scale.
+ * @return True if the actor inherits its parent scale, false if it uses world scale.
* @pre The Actor has been initialized.
*/
bool IsScaleInherited() const;
* @brief Set how the actor and its children should be drawn.
*
* Not all actors are renderable, but DrawMode can be inherited from any actor.
- * By default a renderable actor will be drawn as a 3D object. It will be depth-tested against
+ * If an object is in a 3D layer, it will be depth-tested against
* other objects in the world i.e. it may be obscured if other objects are in front.
*
* If DrawMode::OVERLAY_2D is used, the actor and its children will be drawn as a 2D overlay.
* Overlay actors are drawn in a separate pass, after all non-overlay actors within the Layer.
- * For overlay actors, the drawing order is with respect to depthIndex property of Renderers,
+ * For overlay actors, the drawing order is with respect to tree levels of Actors,
* and depth-testing will not be used.
*
* If DrawMode::STENCIL is used, the actor and its children will be used to stencil-test other actors
* @brief Query how the actor and its children will be drawn.
*
* @SINCE_1_0.0
- * @return True if the Actor is an overlay.
+ * @return Return the draw mode type.
*/
DrawMode::Type GetDrawMode() const;
* @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
* hittable if all of its parents have sensitivity set to true.
- * @see @see SignalTouch() and SignalHover().
+ * @see @see TouchedSignal() and HoveredSignal().
*/
void SetSensitive(bool sensitive);
* @brief Query 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 True, if emission of touch or hover event signals is enabled, 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
* @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 SignalTouch or SignalHover to actually receive this event.
+ * @note Need to connect to the TouchedSignal() or HoveredSignal() to actually receive this event.
*
*/
void SetLeaveRequired(bool required);
* the boundary of the actor.
*
* @SINCE_1_0.0
- * @return true if a Leave event is required, false otherwise.
+ * @return True if a Leave event is required, false otherwise.
* @pre The Actor has been initialized.
*/
bool GetLeaveRequired() const;
* @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 True if the actor is focusable by keyboard navigation, 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 Set the resize policy to be used for the given dimension(s).
*
* @SINCE_1_0.0
* @param[in] policy The resize policy to use
void SetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension );
/**
- * @brief Return the resize policy used for a single dimension
+ * @brief Return 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
+ * @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;
void SetSizeScalePolicy( SizeScalePolicy::Type policy );
/**
- * @brief Return the size set policy in use
+ * @brief Return the size scale policy in use.
*
* @SINCE_1_0.0
- * @return Return the size set 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,
- * depending on ResizePolicy (See SetResizePolicy).
+ * depending on ResizePolicy ( See SetResizePolicy() ).
*
* @SINCE_1_0.0
* @param [in] factor A Vector3 representing the relative factor to be applied to each axis.
Vector3 GetSizeModeFactor() const;
/**
- * @brief Calculate the height of the actor given a width
+ * @brief Calculate 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 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 Calculate 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 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 Return the value of negotiated dimension for the given dimension.
*
* @SINCE_1_0.0
* @param dimension The dimension to retrieve
- * @return Return the value of the negotiated dimension
+ * @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 Set 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 Return the value of the padding.
*
* @SINCE_1_0.0
* @param paddingOut The returned padding data
void GetPadding( Padding& paddingOut ) const;
/**
- * @brief Set the minimum size an actor can be assigned in size negotiation
+ * @brief Set 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 Return 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 Set 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 Return 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 Get 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
*
* When an actor is connected, it will be directly or indirectly parented to the root Actor.
* @SINCE_1_0.0
- * @return The signal
+ * @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
* will received this callback.
- *
* For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
*
+ * @code
+ *
* A (parent)
* / \
* B C
* / \ \
* D E F
*
+ * @endcode
*/
OnStageSignalType& OnStageSignal();
* If an actor is disconnected it either has no parent, or is parented to a disconnected actor.
*
* @SINCE_1_0.0
- * @return The signal
+ * @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.
*
+ * @code
+ *
* A (parent)
* / \
* B C
* / \ \
* D E F
*
+ * @endcode
+ *
*/
OffStageSignalType& OffStageSignal();
public: // Not intended for application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by Actor::New() methods.
*
* @SINCE_1_0.0
* @param [in] actor A pointer to a newly allocated Dali resource
* @brief Helper for discarding an actor handle.
*
* If the handle is empty, this method does nothing. Otherwise
- * actor.Unparent() will be called, followed by actor.Reset().
+ * 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.
*/
/**
* @brief Blending mode.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
enum Type
{
* @brief Blending Factor.
*
* @SINCE_1_0.0
- * @see Dali::RenderableActor::SetBlendFunc() and Dali::RenderableActor::GetBlendFunc()
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
enum Type
{
- ZERO = 0,
- ONE = 1,
- SRC_COLOR = 0x0300,
- ONE_MINUS_SRC_COLOR = 0x0301,
- SRC_ALPHA = 0x0302,
- ONE_MINUS_SRC_ALPHA = 0x0303,
- DST_ALPHA = 0x0304,
- ONE_MINUS_DST_ALPHA = 0x0305,
- DST_COLOR = 0x0306,
- ONE_MINUS_DST_COLOR = 0x0307,
- SRC_ALPHA_SATURATE = 0x0308,
- CONSTANT_COLOR = 0x8001,
- ONE_MINUS_CONSTANT_COLOR = 0x8002,
- CONSTANT_ALPHA = 0x8003,
- ONE_MINUS_CONSTANT_ALPHA = 0x8004
+ ZERO = 0, ///< ZERO @SINCE_1_0.0
+ ONE = 1, ///< ONE @SINCE_1_0.0
+ SRC_COLOR = 0x0300, ///< SRC_COLOR @SINCE_1_0.0
+ ONE_MINUS_SRC_COLOR = 0x0301, ///< ONE_MINUS_SRC_COLOR @SINCE_1_0.0
+ SRC_ALPHA = 0x0302, ///< SRC_ALPHA @SINCE_1_0.0
+ ONE_MINUS_SRC_ALPHA = 0x0303, ///< ONE_MINUS_SRC_ALPHA @SINCE_1_0.0
+ DST_ALPHA = 0x0304, ///< DST_ALPHA @SINCE_1_0.0
+ ONE_MINUS_DST_ALPHA = 0x0305, ///< ONE_MINUS_DST_ALPHA @SINCE_1_0.0
+ DST_COLOR = 0x0306, ///< DST_COLOR @SINCE_1_0.0
+ ONE_MINUS_DST_COLOR = 0x0307, ///< ONE_MINUS_DST_COLOR @SINCE_1_0.0
+ SRC_ALPHA_SATURATE = 0x0308, ///< SRC_ALPHA_SATURATE @SINCE_1_0.0
+ CONSTANT_COLOR = 0x8001, ///< CONSTANT_COLOR @SINCE_1_0.0
+ ONE_MINUS_CONSTANT_COLOR = 0x8002, ///< ONE_MINUS_CONSTANT_COLOR @SINCE_1_0.0
+ CONSTANT_ALPHA = 0x8003, ///< CONSTANT_ALPHA @SINCE_1_0.0
+ ONE_MINUS_CONSTANT_ALPHA = 0x8004 ///< ONE_MINUS_CONSTANT_ALPHA @SINCE_1_0.0
};
} // namespace BlendingFactor
* @brief Blending Equation.
*
* @SINCE_1_0.0
- * @see Dali::RenderableActor::SetBlendEquation() and Dali::RenderableActor::GetBlendEquation()
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
enum Type
{
- ADD = 0x8006,
- SUBTRACT = 0x800A,
- REVERSE_SUBTRACT = 0x800B
+ ADD = 0x8006, ///< The source and destination colors are added to each other. @SINCE_1_0.0
+ SUBTRACT = 0x800A, ///< Subtracts the destination from the source. @SINCE_1_0.0
+ REVERSE_SUBTRACT = 0x800B ///< Subtracts the source from the destination. @SINCE_1_0.0
};
} // namespace BlendingEquation
class CameraActor;
}
+/**
+ * @brief Camera enumerations.
+ * @since_tizen 2.4
+ */
namespace Camera
{
/**
/**
* @brief An enumeration of properties belonging to the CameraActor class.
+ *
* Properties additional to Actor.
* @SINCE_1_0.0
*/
/**
* @brief Create an uninitialized CameraActor handle.
*
- * Initialise it using CameraActor::New(). Calling member functions
- * with an uninitialized Dali::Object is not allowed.
+ * Initialise it using CameraActor::New().
+ * Calling member functions with an uninitialized CameraActor handle is not allowed.
* @SINCE_1_0.0
*/
CameraActor();
*
* 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();
*
* @SINCE_1_0.0
* @param[in] size The canvas size.
- * @return the newly created camera actor.
+ * @return The newly created camera actor.
*/
static CameraActor New( const Size& size );
/**
- * @brief Downcast an Object handle to CameraActor.
+ * @brief Downcast a handle to CameraActor handle.
*
* 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
+ * @return Handle to a CameraActor or an uninitialized handle
*/
static CameraActor DownCast( BaseHandle handle );
*
* @SINCE_1_0.0
* @param [in] rhs The actor to copy.
+ * @return A reference to this
*/
CameraActor& operator=(const CameraActor& rhs);
* @brief Get the type of the camera.
*
* @SINCE_1_0.0
- * @return the type of camera
+ * @return The type of camera
*/
Dali::Camera::Type GetType() const;
/**
* @brief Get the field of view in Radians.
*
- * The default field of view is 45 degrees
+ * The default field of view is 45 degrees.
* @SINCE_1_0.0
* @return The field of view in radians
*/
/**
* @brief Get the aspect ratio of the camera.
*
- * The default aspect ratio is 4.0f/3.0f
+ * The default aspect ratio is 4.0f/3.0f.
* @SINCE_1_0.0
- * @return the aspect ratio
+ * @return The aspect ratio
*/
float GetAspectRatio( );
* @brief Sets the near clipping plane distance.
*
* @SINCE_1_0.0
- * @param[in] nearClippingPlane distance of the near clipping plane
+ * @param[in] nearClippingPlane Distance of the near clipping plane
*/
void SetNearClippingPlane( float nearClippingPlane );
/**
* @brief Get 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
+ * The default near clipping plane is 800.0f, to match the default screen height.
+ * Reduce this value to see objects closer to the camera.
* @SINCE_1_0.0
- * @return the near clipping plane value
+ * @return The near clipping plane value
*/
float GetNearClippingPlane( );
* @brief Sets the far clipping plane distance.
*
* @SINCE_1_0.0
- * @param[in] farClippingPlane distance of the far clipping plane
+ * @param[in] farClippingPlane Distance of the far clipping plane
*/
void SetFarClippingPlane( float farClippingPlane );
/**
* @brief Get the far clipping plane distance.
*
- * The default value is the default near clipping plane + (0xFFFF>>4)
+ * The default value is the default near clipping plane + (0xFFFF>>4).
* @SINCE_1_0.0
- * @return the far clipping plane value
+ * @return The far clipping plane value
*/
float GetFarClippingPlane( );
*
* @SINCE_1_0.0
* @param[in] targetPosition The position of the target to look at
- * @pre Camera type is LOOK_AT_TARGET
+ * @pre Camera type is LOOK_AT_TARGET.
*/
void SetTargetPosition( const Vector3& targetPosition );
/**
* @brief Get Camera Target position.
*
- * The target position is Vector3::ZERO
+ * The default target position is Vector3::ZERO.
* @SINCE_1_0.0
* @return The target position of the camera
- * @pre Camera type is LOOK_AT_TARGET
+ * @pre Camera type is LOOK_AT_TARGET.
*/
Vector3 GetTargetPosition() const;
public: // Not intended for use by Application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by CameraActor::New() methods.
*
* @SINCE_1_0.0
* @param [in] actor A pointer to a newly allocated Dali resource
* @brief CustomActorImpl is an abstract base class for custom control implementations.
*
* This provides a series of pure virtual methods, which are called when actor-specific events occur.
- * An CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::New(CustomActorImplPtr).
+ * And CustomActorImpl is typically owned by a single CustomActor instance; see also CustomActor::CustomActor( CustomActorImpl &implementation ).
* @SINCE_1_0.0
*/
class DALI_IMPORT_API CustomActorImpl : public Dali::RefObject
class Extension; ///< Forward declare future extension interface
/**
- * @brief Virtual destructor.
+ * @brief Virtual destructor
* @SINCE_1_0.0
*/
virtual ~CustomActorImpl();
*
* When an actor is connected, it will be directly or indirectly parented to the root Actor.
* @SINCE_1_0.0
- * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
+ * @param[in] depth The depth in the hierarchy for the actor
*
- * @note When the parent of a set of actors is connected to the stage, then all of the children
+ * @note The root Actor is provided automatically by Dali::Stage, and is always considered to be connected.
+ * When the parent of a set of actors is connected to the stage, then all of the children
* will received this callback.
- *
* For the following actor tree, the callback order will be A, B, D, E, C, and finally F.
*
+ * @code
+ *
* A (parent)
* / \
* B C
* / \ \
* D E F
*
- * @param[in] depth The depth in the hierarchy for the actor
+ * @endcode
+ * @param[in] depth The depth in the hierarchy for the actor
*/
virtual void OnStageConnection( int depth ) = 0;
/**
- * @brief Called after the actor has been disconnected from the stage.
+ * @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.
*
* @SINCE_1_0.0
* @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.
*
+ * @code
+ *
* A (parent)
* / \
* B C
* / \ \
* D E F
+ *
+ * @endcode
*/
virtual void OnStageDisconnection() = 0;
* @brief Called after a child has been added to the owning actor.
*
* @SINCE_1_0.0
- * @param[in] child The child which has been added.
+ * @param[in] child The child which has been added
*/
virtual void OnChildAdd(Actor& child) = 0;
* @brief Called after a child has been removed from the owning actor.
*
* @SINCE_1_0.0
- * @param[in] child The child being removed.
+ * @param[in] child The child being removed
*/
virtual void OnChildRemove(Actor& child) = 0;
* @brief Called when the owning actor property is set.
*
* @SINCE_1_0.0
- * @param[in] index The Property index that was set.
- * @param[in] propertyValue The value to set.
+ * @param[in] index The Property index that was set
+ * @param[in] propertyValue The value to set
*/
virtual void OnPropertySet( Property::Index index, Property::Value propertyValue );
* @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 Actor::GetSize().
+ * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetSize.
*/
virtual void OnSizeSet(const Vector3& targetSize) = 0;
*
* @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 Actor::GetSize().
+ * @param[in] targetSize The target size. Note that this target size may not match the size returned via @ref Actor::GetSize.
*/
virtual void OnSizeAnimation(Animation& animation, const Vector3& targetSize) = 0;
* @brief Called after a touch-event is received by the owning actor.
*
* @SINCE_1_0.0
- * @param[in] event The touch event.
+ * @param[in] event The touch event
* @return True if the event should be consumed.
- * @note This must be enabled during construction; see CustomActorImpl::CustomActorImpl(bool)
+ * @note CustomActorImpl::REQUIRES_TOUCH_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
*/
virtual bool OnTouchEvent(const TouchEvent& event) = 0;
* @brief Called after a hover-event is received by the owning actor.
*
* @SINCE_1_0.0
- * @param[in] event The hover event.
+ * @param[in] event The hover event
* @return True if the event should be consumed.
- * @note This must be enabled during construction; see CustomActorImpl::SetRequiresHoverEvents(bool)
+ * @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 wheel-event is received by the owning actor.
*
* @SINCE_1_0.0
- * @param[in] event The wheel event.
+ * @param[in] event The wheel event
* @return True if the event should be consumed.
- * @note This must be enabled during construction; see CustomActorImpl::SetRequiresWheelEvents(bool)
+ * @note CustomActorImpl::REQUIRES_WHEEL_EVENTS must be enabled during construction. See CustomActorImpl::CustomActorImpl( ActorFlags flags ).
*/
virtual bool OnWheelEvent(const WheelEvent& event) = 0;
* actors differently after certain operations like add or remove
* actors, resize or after changing specific properties.
*
- * Note! As this function is called from inside the size negotiation algorithm, you cannot
- * call RequestRelayout (the call would just be ignored)
- *
* @SINCE_1_0.0
* @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.
+ * @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;
virtual void OnSetResizePolicy( ResizePolicy::Type policy, Dimension::Type dimension ) = 0;
/**
- * @brief Return the natural size of the actor
+ * @brief Return 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 Calculate 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
+ * @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 width to use.
- * @return the height based on the width.
+ * @param 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 height to use.
- * @return the width based on the width.
+ * @param 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 Determine if this actor is dependent on it's children for relayout.
*
* @SINCE_1_0.0
* @param 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;
virtual void OnLayoutNegotiated( float size, Dimension::Type dimension ) = 0;
/**
- * @brief Retrieve the extension for this control
+ * @brief Retrieve the extension for this control.
*
* @SINCE_1_0.0
* @return The extension if available, NULL otherwise
// 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 Request 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
void RelayoutRequest();
/**
- * @brief provides the Actor implementation of GetHeightForWidth
+ * @brief Provides the Actor implementation of GetHeightForWidth.
* @SINCE_1_0.0
- * @param width to use.
- * @return the height based on the width.
+ * @param width Width to use.
+ * @return The height based on the width.
*/
float GetHeightForWidthBase( float width );
/**
- * @brief provides the Actor implementation of GetWidthForHeight
+ * @brief Provides the Actor implementation of GetWidthForHeight.
* @SINCE_1_0.0
- * @param height to use.
- * @return the width based on the height.
+ * @param 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 Calculate 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
+ * @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.
*/
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 Determine if this actor is dependent on it's children for relayout from the base class.
*
* @SINCE_1_0.0
* @param 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 Called when ownership of the CustomActorImpl is passed to a CustomActor.
+ * @brief Initialize a CustomActor.
* @SINCE_1_0.0
- * @param[in] owner The owning object.
+ * @param[in] owner The owning object
* @pre The CustomActorImpl is not already owned.
+ * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
void Initialize(Internal::CustomActor& owner);
* Owner is the Dali::Internal::CustomActor that owns the implementation of the custom actor
* inside core. Creation of a handle to Dali public API Actor requires this pointer.
* @SINCE_1_0.0
- * @return a pointer to the Actor implementation that owns this custom actor implementation
+ * @return A pointer to the Actor implementation that owns this custom actor implementation
*/
Internal::CustomActor* GetOwner() const;
/**
- * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
+ * @brief Returns whether the OnTouchEvent() callback is required.
* @SINCE_1_0.0
* @return True if the OnTouchEvent() callback is required.
+ * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool RequiresTouchEvents() const;
/**
- * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
+ * @brief Returns whether the OnHoverEvent() callback is required.
* @SINCE_1_0.0
* @return True if the OnHoverEvent() callback is required.
+ * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool RequiresHoverEvents() const;
/**
- * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
+ * @brief Returns whether the OnWheelEvent() callback is required.
* @SINCE_1_0.0
* @return True if the OnWheelEvent() callback is required.
+ * @note Called when ownership of the CustomActorImpl is passed to a CustomActor.
*/
bool RequiresWheelEvents() const;
/**
- * @brief Called when ownership of the CustomActorImpl is passed to a CustomActor.
+ * @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;
* @brief Create an uninitialized CustomActor handle.
*
* Only derived versions can be instantiated.
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * Calling member functions with an uninitialized CustomActor handle is not allowed.
* @SINCE_1_0.0
*/
CustomActor();
/**
- * @brief Downcast an Object handle to CustomActor.
+ * @brief Downcast a handle to CustomActor handle.
*
* If 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 to An object
- * @return handle to a CustomActor or an uninitialized handle
+ * @param[in] handle Handle to an object
+ * @return Handle to a CustomActor or an uninitialized handle
*/
static CustomActor DownCast( BaseHandle handle );
* @brief Retrieve the custom actor implementation.
*
* @SINCE_1_0.0
- * @return The implementation.
+ * @return The implementation
*/
CustomActorImpl& GetImplementation();
* @brief Retrieve the custom actor implementation.
*
* @SINCE_1_0.0
- * @return The implementation.
+ * @return The implementation
*/
const CustomActorImpl& GetImplementation() const;
* @brief Create an initialised CustomActor.
*
* @SINCE_1_0.0
- * @param[in] implementation The implementation for this custom actor.
- * @return A handle to a newly allocated Dali resource.
+ * @param[in] implementation The implementation for this custom actor
+ * @return A handle to a newly allocated Dali resource
*/
CustomActor(CustomActorImpl& implementation);
* @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
*
* @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);
*
* If an ImageActor is created without setting size, then the actor takes the size of the image -
* this is the natural size.
- * Setting a size on the ImageActor, e.g through the SetSize api or through an animation will
+ * Setting a size on the ImageActor, e.g through the @ref Actor::SetSize api or through an animation will
* stop the natural size being used.
*
- * If a pixel area is set on an ImageActor with natural size, the actor size will change
- * to match the pixel area. If a pixel area is set on an ImageActor that has had it's size set,
- * then the size doesn't change, and the partial image will be stretched to fill the set size.
- *
- * Clearing the pixel area on an Image actor with natural size will cause the actor to show the
- * whole image again, and will change size back to that of the image.
- *
- * Clearing the pixel area on an Image actor with a set size will cause the actor to show the
- * whole image again, but will not change the image size.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release. We do recommend not to use it. Use of ImageActor should be avoided unless shader effects need to be applied.
+ * For general purpose, use Toolkit::ImageView which has much better performance.
+ * @see Toolkit::ImageView
*/
class DALI_IMPORT_API ImageActor : public Actor
{
public:
/**
- * @DEPRECATED_1_1.11
- * @brief An enumeration of properties belonging to the ImageActor class.
- * Properties additional to RenderableActor.
+ * @brief An enumeration of properties belonging to the ImageActor class
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
struct Property
{
enum
{
/**
- * @DEPRECATED_1_1.11
* @brief name "pixelArea", type Rect<int>
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
PIXEL_AREA = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX,
/**
* @DEPRECATED_1_1.11
* @brief name "style", type std::string
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
STYLE,
/**
* @DEPRECATED_1_1.11
* @brief name "border", type Vector4
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
BORDER,
/**
- * @DEPRECATED_1_1.11
* @brief name "image", type Map {"filename":"", "loadPolicy":...}
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
IMAGE,
};
* is scaled uniformly as the quad is resized.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
enum Style
{
* @DEPRECATED_1_1.11
* @brief As a simple quad.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
STYLE_QUAD,
/**
* @DEPRECATED_1_1.11
* @brief As a nine-patch.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
STYLE_NINE_PATCH,
/**
* @DEPRECATED_1_1.11
* @brief As a nine-patch without center section being rendered.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
STYLE_NINE_PATCH_NO_CENTER
};
/**
- * @DEPRECATED_1_1.11
* @brief Pixel area is relative to the top-left (0,0) of the image.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
typedef Rect<int> PixelArea;
static const BlendingMode::Type DEFAULT_BLENDING_MODE; ///< default value is BlendingMode::AUTO
/**
- * @DEPRECATED_1_1.11
* @brief Create an uninitialized ImageActor handle.
*
- * This can be initialized with ImageActor::New(...)
- * Calling member functions with an uninitialized Dali::Object is not allowed.
+ * This can be initialized with ImageActor::New(...).
+ * Calling member functions with an uninitialized ImageActor handle is not allowed.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
ImageActor();
/**
- * @DEPRECATED_1_1.11
* @brief Create an empty image actor object.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @return A handle to a newly allocated actor.
*/
static ImageActor New();
/**
- * @DEPRECATED_1_1.11
* @brief Create a image actor object.
*
* The actor will take the image's natural size unless a custom size
* is chosen, e.g. via Actor:SetSize().
- * If the handle is empty, ImageActor will display nothing
+ * If the handle is empty, ImageActor will display nothing.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[in] image The image to display.
* @return A handle to a newly allocated actor.
* @pre ImageActor must be initialized.
static ImageActor New(Image image);
/**
- * @DEPRECATED_1_1.11
* @brief Create a image actor object.
*
* The actor will take the image's natural size unless a custom size
- * is chosen, e.g. via Actor:SetSize()
- * If the handle is empty, ImageActor will display nothing
+ * is chosen, e.g. via Actor:SetSize().
+ * If the handle is empty, ImageActor will display nothing.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param [in] image The image to display.
* @param [in] pixelArea The area of the image to display.
* This in pixels, relative to the top-left (0,0) of the image.
static ImageActor New(Image image, PixelArea pixelArea);
/**
- * @DEPRECATED_1_1.11
- * @brief Downcast an Object handle to ImageActor.
+ * @brief Downcast a handle to ImageActor handle.
*
*
* If handle points to a ImageActor 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 ImageActor or an uninitialized handle
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param[in] handle Handle to an object
+ * @return Handle to a ImageActor or an uninitialized handle
*/
static ImageActor DownCast( BaseHandle handle );
/**
- * @DEPRECATED_1_1.11
* @brief Destructor
*
* This is non-virtual since derived Handle types must not contain data or virtual methods.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
~ImageActor();
/**
- * @DEPRECATED_1_1.11
* @brief Copy constructor
*
* @SINCE_1_0.0
- * @param [in] copy The actor to copy.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] copy The actor to copy
*/
ImageActor(const ImageActor& copy);
/**
- * @DEPRECATED_1_1.11
* @brief Assignment operator
*
* @SINCE_1_0.0
- * @param [in] rhs The actor to copy.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] rhs The actor to copy
+ * @return A reference to this
*/
ImageActor& operator=(const ImageActor& rhs);
/**
- * @DEPRECATED_1_1.11
* @brief Set the image rendered by the actor.
*
- * Set the image rendered by the actor.
* If actor was already displaying a different image, the old image is dropped and actor may
* temporarily display nothing. Setting an empty image (handle) causes the current image to be
* dropped and actor displays nothing.
* The actor will take the image's natural size unless a custom size
- * is chosen, e.g. via Actor:SetSize()
+ * is chosen, e.g. via Actor::SetSize().
*
* @SINCE_1_0.0
- * @param [in] image The image to display.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] image The image to display
* @pre ImageActor must be initialized.
*/
void SetImage(Image image);
/**
- * @DEPRECATED_1_1.11
* @brief Retrieve the image rendered by the actor.
*
- * If no image is assigned, an empty handle is returned
+ * If no image is assigned, an empty handle is returned.
* @SINCE_1_0.0
- * @return The image.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @return The image
*/
Image GetImage();
/**
- * @DEPRECATED_1_1.11
* @brief Set a region of the image to display, in pixels.
*
* When the image is loaded the actor's size will be reset to the pixelArea,
- * unless a custom size was chosen, e.g. via Actor:SetSize().
- * Note! PixelArea should be inside the image data size. It gets clamped by GL
+ * unless a custom size was chosen, e.g. via Actor::SetSize().
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param [in] pixelArea The area of the image to display.
* This in pixels, relative to the top-left (0,0) of the image.
- * @pre image must be initialized.
+ * @pre Image must be initialized.
+ * @note PixelArea should be inside the image data size. It gets clamped by GL.
*/
void SetPixelArea(const PixelArea& pixelArea);
/**
- * @DEPRECATED_1_1.11
* @brief Retrieve the region of the image to display, in pixels.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @return The pixel area, or a default-constructed area if none was set.
- * @pre image must be initialized.
+ * @pre Image must be initialized.
*/
PixelArea GetPixelArea() const;
* @brief Set how the image is rendered; the default is STYLE_QUAD.
*
* @SINCE_1_0.0
- * @param [in] style The new style.
- *
- * @pre image must be initialized.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] style The new style
+ * @pre Image must be initialized.
* @note The style specified is set (so GetStyle will return what's set) but ignored internally.
*/
void SetStyle(Style style);
* @brief Query how the image is rendered.
*
* @SINCE_1_0.0
- * @return The rendering style.
- *
- * @pre image must be initialized.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @return The rendering style
+ * @pre Image must be initialized.
* @note This just returns the style set by SetStyle. In reality, only STYLE_QUAD is supported.
*/
Style GetStyle() const;
/**
* @DEPRECATED_1_1.11. Use ImageView instead.
*
- * @brief Set the border used with STYLE_NINE_PATCH.
+ * @brief Set the border used with ImageActor::STYLE_NINE_PATCH.
*
* The values are in pixels from the left, top, right, and bottom of the image respectively.
- * i.e. SetNinePatchBorder( Vector4(1,2,3,4) ) sets the left-border to 1, top-border to 2, right-border to 3, and bottom-border to 4 pixels.
+ * i.e. ImageActor::SetNinePatchBorder( Vector4(1,2,3,4) ) sets the left-border to 1, top-border to 2, right-border to 3, and bottom-border to 4 pixels.
* @SINCE_1_0.0
- * @param [in] border The new nine-patch border.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] border The new nine-patch border
*/
void SetNinePatchBorder(const Vector4& border);
/**
* @DEPRECATED_1_1.11. Use ImageView instead.
*
- * @brief Retrieve the border used with STYLE_NINE_PATCH.
+ * @brief Retrieve the border used with ImageActor::STYLE_NINE_PATCH.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @return The nine-patch border.
*/
Vector4 GetNinePatchBorder() const;
/**
- * @DEPRECATED_1_1.11
* @brief Allows modification of an actors position in the depth sort algorithm.
*
* The offset can be altered for each coplanar actor hence allowing an order of painting.
* @SINCE_1_0.0
- * @param [in] depthOffset the offset to be given to the actor. Positive values pushing it further back.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] depthOffset The offset to be given to the actor. Positive values pushing it up front.
* @pre The Actor has been initialized.
+ * @see Layer::Behavior
*/
void SetSortModifier(float depthOffset);
/**
- * @DEPRECATED_1_1.11
* @brief Retrieves the offset used to modify an actors position in the depth sort algorithm.
*
* The offset can be altered for each coplanar actor hence allowing an order of painting.
* @SINCE_1_0.0
- * @return the offset that has been given to the actor. Positive values pushing it further back.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @return The offset that has been given to the actor. Positive values pushing it further back.
* @pre The Actor has been initialized.
+ * @see Layer::Behavior
*/
float GetSortModifier() const;
/**
- * @DEPRECATED_1_1.11
* @brief Sets the blending mode.
*
* Possible values are: BlendingMode::OFF, BlendingMode::AUTO and BlendingMode::ON. Default is BlendingMode::AUTO.
* </ul>
*
* @SINCE_1_0.0
- * @param[in] mode The blending mode.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param[in] mode The blending mode
*/
void SetBlendMode( BlendingMode::Type mode );
/**
- * @DEPRECATED_1_1.11
* @brief Retrieves the blending mode.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @return The blending mode, one of BlendingMode::OFF, BlendingMode::AUTO or BlendingMode::ON.
*/
BlendingMode::Type GetBlendMode() const;
/**
- * @DEPRECATED_1_1.11
* @brief Specify the pixel arithmetic used when the actor is blended.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[in] srcFactorRgba Specifies how the red, green, blue, and alpha source blending factors are computed.
* The options are BlendingFactor::ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
* SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
void SetBlendFunc( BlendingFactor::Type srcFactorRgba, BlendingFactor::Type destFactorRgba );
/**
- * @DEPRECATED_1_1.11
* @brief Specify the pixel arithmetic used when the actor is blended.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[in] srcFactorRgb Specifies how the red, green, and blue source blending factors are computed.
* The options are BlendingFactor::ZERO, ONE, SRC_COLOR, ONE_MINUS_SRC_COLOR, DST_COLOR, ONE_MINUS_DST_COLOR,
* SRC_ALPHA, ONE_MINUS_SRC_ALPHA, DST_ALPHA, ONE_MINUS_DST_ALPHA, CONSTANT_COLOR, ONE_MINUS_CONSTANT_COLOR,
BlendingFactor::Type srcFactorAlpha, BlendingFactor::Type destFactorAlpha );
/**
- * @DEPRECATED_1_1.11
* @brief Query the pixel arithmetic used when the actor is blended.
*
* @SINCE_1_0.0
- * @param[out] srcFactorRgb Specifies how the red, green, blue, and alpha source blending factors are computed.
- * @param[out] destFactorRgb Specifies how the red, green, blue, and alpha destination blending factors are computed.
- * @param[out] srcFactorAlpha Specifies how the red, green, blue, and alpha source blending factors are computed.
- * @param[out] destFactorAlpha Specifies how the red, green, blue, and alpha destination blending factors are computed.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param[out] srcFactorRgb Specifies how the red, green and blue source blending factors are computed.
+ * @param[out] destFactorRgb Specifies how the red, green and blue destination blending factors are computed.
+ * @param[out] srcFactorAlpha Specifies how the alpha source blending factor is computed.
+ * @param[out] destFactorAlpha Specifies how the alpha destination blending factor is computed.
*/
void GetBlendFunc( BlendingFactor::Type& srcFactorRgb, BlendingFactor::Type& destFactorRgb,
BlendingFactor::Type& srcFactorAlpha, BlendingFactor::Type& destFactorAlpha ) const;
/**
- * @DEPRECATED_1_1.11
* @brief Specify the equation used when the actor is blended.
*
- * The options are BlendingEquation::ADD, SUBTRACT, or REVERSE_SUBTRACT.
+ * The options are BlendingEquation::ADD, BlendingEquation::SUBTRACT, or BlendingEquation::REVERSE_SUBTRACT.
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[in] equationRgba The equation used for combining red, green, blue, and alpha components.
*/
void SetBlendEquation( BlendingEquation::Type equationRgba );
/**
- * @DEPRECATED_1_1.11
* @brief Specify the equation used when the actor is blended.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[in] equationRgb The equation used for combining red, green, and blue components.
* @param[in] equationAlpha The equation used for combining the alpha component.
- * The options are BlendingEquation::ADD, SUBTRACT, or REVERSE_SUBTRACT.
+ * The options are BlendingEquation::ADD, BlendingEquation::SUBTRACT, or BlendingEquation::REVERSE_SUBTRACT.
*/
void SetBlendEquation( BlendingEquation::Type equationRgb, BlendingEquation::Type equationAlpha );
/**
- * @DEPRECATED_1_1.11
* @brief Query the equation used when the actor is blended.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[out] equationRgb The equation used for combining red, green, and blue components.
* @param[out] equationAlpha The equation used for combining the alpha component.
*/
void GetBlendEquation( BlendingEquation::Type& equationRgb, BlendingEquation::Type& equationAlpha ) const;
/**
- * @DEPRECATED_1_1.11
* @brief Specify the color used when the actor is blended; the default is Vector4::ZERO.
*
* @SINCE_1_0.0
- * @param[in] color The blend color.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param[in] color The blend color
*/
void SetBlendColor( const Vector4& color );
/**
- * @DEPRECATED_1_1.11
* @brief Query the color used when the actor is blended.
*
* @SINCE_1_0.0
- * @return The blend color.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @return The blend color
*/
const Vector4& GetBlendColor() const;
/**
- * @DEPRECATED_1_1.11
* @brief Sets the filtering mode.
*
* Possible values are: FilterMode::NEAREST and FilterMode::LINEAR. Default is FilterMode::LINEAR.
* </ul>
*
* @SINCE_1_0.0
- * @param[in] minFilter The minification filtering mode.
- * @param[in] magFilter The magnification filtering mode.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param[in] minFilter The minification filtering mode
+ * @param[in] magFilter The magnification filtering mode
*/
void SetFilterMode( FilterMode::Type minFilter, FilterMode::Type magFilter );
/**
- * @DEPRECATED_1_1.11
* @brief Retrieves the filtering mode.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @param[out] minFilter The return minification value
* @param[out] magFilter The return magnification value
*/
void GetFilterMode( FilterMode::Type& minFilter, FilterMode::Type& magFilter) const;
/**
- * @DEPRECATED_1_1.11
- * @brief Sets the shader effect for the RenderableActor.
+ * @brief Sets the shader effect for the ImageActor.
*
* Shader effects provide special effects like ripple and bend.
- * Setting a shader effect removes any shader effect previously set by SetShaderEffect.
+ * Setting a shader effect removes any shader effect previously set by @ref ImageActor::SetShaderEffect.
* @SINCE_1_0.0
- * @param [in] effect The shader effect.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] effect The shader effect
* @pre The actor has been initialized.
- * @pre effect has been initialized.
+ * @pre Effect has been initialized.
*/
void SetShaderEffect( ShaderEffect effect );
/**
- * @DEPRECATED_1_1.11
- * @brief Retrieve the custom shader effect for the RenderableActor.
+ * @brief Retrieve the custom shader effect for the ImageActor.
+ *
* If default shader is used an empty handle is returned.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @return The shader effect
* @pre The Actor has been initialized.
*/
ShaderEffect GetShaderEffect() const;
/**
- * @DEPRECATED_1_1.11
* @brief Removes the current shader effect.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
* @pre The Actor has been initialized.
*/
void RemoveShaderEffect();
/**
- * @DEPRECATED_1_1.11
* @brief Sets the shader effect for all ImageActors in a tree of Actors.
*
* @SINCE_1_0.0
- * @param [in] actor root of a tree of actors.
- * @param [in] effect The shader effect.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] actor Root of a tree of actors
+ * @param [in] effect The shader effect
* @see ImageActor::SetShaderEffect
*
*/
-DALI_IMPORT_API void SetShaderEffectRecursively( Actor actor, ShaderEffect effect );
+DALI_IMPORT_API void SetShaderEffectRecursively( Dali::Actor actor, Dali::ShaderEffect effect );
/**
- * @DEPRECATED_1_1.11
* @brief Removes the shader effect from all ImageActors in a tree of Actors.
*
* @SINCE_1_0.0
- * @param [in] actor root of a tree of actors.
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
+ * @param [in] actor Root of a tree of actors
* @see ImageActor::RemoveShaderEffect
*
*/
-DALI_IMPORT_API void RemoveShaderEffectRecursively( Actor actor );
+DALI_IMPORT_API void RemoveShaderEffectRecursively( Dali::Actor actor );
/**
* @}
}
/**
- * @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()
* @brief Layers provide a mechanism for overlaying groups of actors on top of each other.
*
* When added to the stage, a layer can be ordered relative to other layers. The bottom
- * layer is at depth zero. The stage provides a default layer for it's children.
+ * layer is at depth zero. The stage provides a default layer for it's children (see Stage::GetRootLayer()).
*
* Layered actors inherit position etc. as normal, but are drawn in an order determined
- * by the layers. The depth buffer is cleared before each layer is rendered unless depth
+ * by the layers. In case of LAYER_3D, the depth buffer is cleared before each layer is rendered unless depth
* test is disabled or there's no need for it based on the layers contents;
* actors in lower layers cannot obscure actors in higher layers.
*
+ * A layer has either LAYER_2D or LAYER_3D mode. LAYER_2D has better performance,
+ * the depth test is disabled, and a child actor hides its parent actor.
+ * LAYER_3D uses the depth test, thus a close actor hides a farther one.
+ * LAYER_2D is the default mode and recommended for general cases.
+ * See Layer::Behavior and SetBehavior() for more information.
+ *
+ * Layer is a type of Actor, thus can have parent or children actors.
+ * A layer influences rendering of its all descendant actors,
+ * until another layer appears in the actor tree and manages its own subtree.
+ *
* If depth test is disabled, there is no performance overhead from clearing the depth buffer.
*
* Actions
/**
* @brief An enumeration of properties belonging to the Layer class.
+ *
* Properties additional to Actor.
+ *
* @SINCE_1_0.0
*/
struct Property
enum Behavior
{
/**
- * @brief Layer doesn't make use of the depth test.
+ * @brief Layer doesn't make use of the depth test (default mode).
*
* This mode is expected to have better performance than the 3D mode.
- * When using this mode any ordering would be with respect to depthIndex property of Renderers.
+ * When using this mode any ordering would be with respect to tree level of each Actor.
+ *
+ * For the following actor tree of the Layer1 object, D and E hide B, B and C hides A,
+ * and F hides C, regardless of their Z positions.
+ * Rendering order between siblings, such as D & E or B & C, is not determined.
+ * If you have two overlapped actors, just make them parent-child, not siblings.
+ *
+ * @code
+ *
+ * Layer1 (parent)
+ * |
+ * A
+ * / \
+ * B C
+ * / \ \
+ * D E F
+ *
+ * @endcode
+ *
* @SINCE_1_0.0
*/
LAYER_2D,
/**
* @brief Layer will use depth test.
*
- * When using this mode depth depth test will be used. Opaque renderers are drawn first
- * and write to the depth buffer. Then transparent renderers are drawn with depth test
- * enabled but depth write switched off.
+ * 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.
+ * Then transparent renderers are drawn with depth test enabled but depth write switched off.
* Transparent renderers are drawn based on their distance from the camera (painter's algorithm).
* A renderers DEPTH_INDEX property is used to offset the distance to the camera when ordering transparent renderers.
* This is useful if you want to define the draw order of two or more transparent renderers that are
* equal distance from the camera.
+ * Unlike LAYER_2D, parent-child relationship does not affect rendering order at all.
*
* @SINCE_1_0.0
+ * @remarks This is an experimental feature. Using 2D UI components of DALi Toolkit
+ * in LAYER_3D mode has not been enoughly tested yet
+ * because they are orginally designed for 2D use cases.
+ * Simple controls such as Toolkit::Control or Toolkit::ImageView might not have any problem with LAYER_3D,
+ * but more complex one like Toolkit::PushButton, you might get unexpected rendered order in LAYER_3D.
+ * Although we'll support 2D controls in LAYER_3D soon, we recommend to use 2D controls with LAYER_2D only at this moment.
+ * Of course, controls rendered in 3D space, such as SpiralLayout of Toolkit::ItemView
+ * (see Toolkit::DefaultItemLayout::New), should be used with LAYER_3D.
*/
LAYER_3D,
};
- /*
- * TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
- * For 2D layers, this value will be multiplied to the actor depth in the tree and added to the depth index
- * to obtain the value which will be used for ordering
+ /**
+ * @brief TREE_DEPTH_MULTIPLIER is used by the rendering sorting algorithm to decide which actors to render first.
+ * @SINCE_1_0.0
*/
enum TreeDepthMultiplier
{
TREE_DEPTH_MULTIPLIER = 10000,
};
/**
- * @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.
*
- * This can be initialised with Layer::New(...)
+ * This can be initialised with Layer::New(...).
* @SINCE_1_0.0
*/
Layer();
static Layer New();
/**
- * @brief Downcast an Object handle to Layer.
+ * @brief Downcast a handle to Layer handle.
*
* 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 to An object
- * @return handle to a Layer or an uninitialized handle
+ * @param[in] handle Handle to An object
+ * @return Handle to a Layer or an uninitialized handle
*/
static Layer DownCast( BaseHandle handle );
* @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
*
* @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
*
- * 0 is bottom most layer, higher number is on top
+ * 0 is 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
+ * @return The current depth of the layer
+ * @pre Layer is on the stage.
* If layer is not added to the stage, returns 0.
*/
unsigned int GetDepth() const;
* @brief Increment the depth of the layer.
*
* @SINCE_1_0.0
- * @pre layer is on the stage
+ * @pre Layer is on the stage.
*/
void Raise();
* @brief Decrement the depth of the layer.
*
* @SINCE_1_0.0
- * @pre layer is on the stage
+ * @pre Layer is on the stage.
*/
void Lower();
/**
* @brief Ensures the layers depth is greater than the target layer.
*
- * If the layer already is above target layer its depth is not changed
- * If the layer was below target, its new depth will be immediately above target
- * Note! All layers between this layer and target get new depth values
+ * 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
- * @pre layer is on the stage
- * @pre target layer is on the stage
+ * @param target Layer to get above of
+ * @pre Layer is on the stage.
+ * @pre Target layer is on the stage.
+ * @note All layers between this layer and target get new depth values.
*/
void RaiseAbove( Layer target );
/**
* @brief Ensures the layers depth is less than the target layer.
*
- * If the layer already is below the layer its depth is not changed
- * If the layer was above target, its new depth will be immediately below target
- * Note! All layers between this layer and target get new depth values
+ * 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
- * @pre layer is on the stage
- * @pre target layer is on the stage
+ * @param target Layer to get below of
+ * @pre Layer is on the stage.
+ * @pre Target layer is on the stage.
+ * @note All layers between this layer and target get new depth values.
*/
void LowerBelow( Layer target );
/**
* @brief Raises the layer to the top.
* @SINCE_1_0.0
- * @pre layer is on the stage
+ * @pre Layer is on the stage.
*/
void RaiseToTop();
/**
* @brief Lowers the layer to the bottom.
* @SINCE_1_0.0
- * @pre layer is on the stage
+ * @pre layer is on the stage.
*/
void LowerToBottom();
/**
* @brief Moves the layer directly above the given layer.
*
- * After the call this layers depth will be immediately above target
- * Note! All layers between this layer and target get new depth values
+ * 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
- * @pre target layer is on the stage
+ * @param target Layer to get on top of
+ * @pre Layer is on the stage.
+ * @pre Target layer is on the stage.
+ * @note All layers between this layer and target get new depth values.
*/
void MoveAbove( Layer target );
/**
* @brief Moves the layer directly below the given layer.
*
- * After the call this layers depth will be immediately below target
- * Note! All layers between this layer and target get new depth values
+ * 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
- * @pre target layer is on the stage
+ * @param target Layer to get below of
+ * @pre Layer is on the stage.
+ * @pre Target layer is on the stage.
+ * @note All layers between this layer and target get new depth values.
*/
void MoveBelow( Layer target );
/**
- * @brief Set the behavior of the layer
+ * @brief Set 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 Get the behavior of the layer.
*
* @SINCE_1_0.0
* @return The behavior of the layer
* 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) which means everything is clipped.
* You can only do rectangular clipping using this API in window coordinates.
- * For other kinds of clipping, @see Dali::Actor::SetDrawMode().
+ * For other kinds of clipping, see Dali::Actor::SetDrawMode().
* @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 Whether to disable the depth test.
*
- * By default a layer enables depth test if there is more than one opaque actor or if there is one opaque actor and one, or more, transparent actors.
+ * By default a layer enables depth test if there is more than one opaque actor or if there is one opaque actor and one, or more, transparent actors in LAYER_3D mode.
* 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;
*
* @SINCE_1_0.0
* @param[in] function The sort function pointer
- * @note If the sort function returns a low number, the actor the data applies to will be
+ * @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
* @brief Retrieves whether the layer consumes touch (including gestures).
*
* @SINCE_1_0.0
- * @return true if consuming touch, false otherwise.
+ * @return True if consuming touch, false otherwise.
*/
bool IsTouchConsumed() const;
* @brief Retrieves whether the layer consumes hover.
*
* @SINCE_1_0.0
- * @return true if consuming hover, false otherwise.
+ * @return True if consuming hover, false otherwise.
*/
bool IsHoverConsumed() const;
public: // Not intended for application developers
/**
- * @brief This constructor is used by Dali New() methods.
+ * @brief This constructor is used by Layer::New() methods.
*
* @SINCE_1_0.0
* @param [in] Layer A pointer to a newly allocated Dali resource
/**
* @brief Texture filtering mode.
* @SINCE_1_0.0
- * @see Dali::RenderableActor::SetFilterMode() and Dali::RenderableActor::GetFilterMode()
+ * @remarks This is an experimental feature and might not be supported in the next release.
+ * We do recommend not to use it.
*/
enum Type
{
projects / platform / core / uifw / dali-core.git / commitdiff