X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fvisuals%2Fvisual-properties.h;h=6f19efcc95e7d5ce07cb07449bae7f8532a59e44;hp=54a4350ed2e8167737cb73c7e601a16f5ca7e66f;hb=16912baf519a33ab99788619118df99c854076de;hpb=3e3ba0c9a854a2a392b74baab03ae171833d3ac0 diff --git a/dali-toolkit/public-api/visuals/visual-properties.h b/dali-toolkit/public-api/visuals/visual-properties.h index 54a4350..6f19efc 100644 --- a/dali-toolkit/public-api/visuals/visual-properties.h +++ b/dali-toolkit/public-api/visuals/visual-properties.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_VISUAL_PROPERTIES_H /* - * Copyright (c) 2017 Samsung Electronics Co., Ltd. + * Copyright (c) 2020 Samsung Electronics Co., Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,57 +23,53 @@ namespace Dali { - namespace Toolkit { - /** * @addtogroup dali_toolkit_visuals * @{ */ /** - * @brief All the visual types + * @brief All the visual types. * @SINCE_1_1.45 */ namespace Visual { - /** * @brief All the visual types. * @SINCE_1_1.45 */ enum Type { - BORDER, ///< Renders a solid color as an internal border to the control's quad. @SINCE_1_1.45 - COLOR, ///< Renders a solid color to the control's quad. @SINCE_1_1.45 - GRADIENT, ///< Renders a smooth transition of colors to the control's quad. @SINCE_1_1.45 - IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45 - MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45 - PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45 - WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2 - TEXT, ///< Renders text @SINCE_1_2.60 - N_PATCH, ///< Renders an n-patch image. @SINCE_1_2.60 - SVG, ///< Renders an SVG image. @SINCE_1_2.60 - ANIMATED_IMAGE, ///< Renders a animated image. @SINCE_1_2.60 + BORDER, ///< Renders a solid color as an internal border to the control's quad. @SINCE_1_1.45 + COLOR, ///< Renders a solid color to the control's quad. @SINCE_1_1.45 + GRADIENT, ///< Renders a smooth transition of colors to the control's quad. @SINCE_1_1.45 + IMAGE, ///< Renders an image into the control's quad. @SINCE_1_1.45 + MESH, ///< Renders a mesh using an "obj" file, optionally with textures provided by an "mtl" file. @SINCE_1_1.45 + PRIMITIVE, ///< Renders a simple 3D shape, such as a cube or sphere. @SINCE_1_1.45 + WIREFRAME, ///< Renders a simple wire-frame outlining a quad. @SINCE_1_2_2 + TEXT, ///< Renders text @SINCE_1_2.60 + N_PATCH, ///< Renders an n-patch image. @SINCE_1_2.60 + SVG, ///< Renders an SVG image. @SINCE_1_2.60 + ANIMATED_IMAGE, ///< Renders a animated image. @SINCE_1_2.60 }; /** - * @brief Visual Property + * @brief Visual Property. * @SINCE_1_1.45 */ namespace Property { - /** - * @brief Visual Property + * @brief Enumeration for the instance of properties belonging to the Visual Property. * @SINCE_1_1.45 */ enum { /** * @brief The index for the visual type. - * @details Name "visualType", type [Type](@ref Dali::Toolkit::Visual::Type) (Property::INTEGER) or Property::STRING. + * @details Name "visualType", type [Type](Dali::Toolkit::Visual::Type) (Property::INTEGER) or Property::STRING. * @SINCE_1_1.45 * @note Mandatory. * @see Type @@ -111,15 +107,16 @@ enum /** * @brief Mix color is a blend color for any visual. - * @details Name "mixColor", type Property::VECTOR3 or Property::VECTOR4. + * @details Name "mixColor", type Property::VECTOR3 or Property::VECTOR4, animatable * @SINCE_1_2.60 * @note Optional + * @note To animate an opacity, OPACITY property should be used. */ MIX_COLOR, /** * @brief Opacity is the alpha component of the mixColor, above. - * @details Name "opacity", type Property::FLOAT. + * @details Name "opacity", type Property::FLOAT, animatable * @SINCE_1_2.60 * @note Optional */ @@ -128,33 +125,45 @@ enum } // namespace Property +/** + * @brief Visual Transform for the offset or size. + * @SINCE_1_2.60 + */ namespace Transform { - /** * @brief Policies used by the transform for the offset or size. * @SINCE_1_2.60 - * */ namespace Policy { - +/** + * @brief Enumeration for the type of Transform Policy. + * @SINCE_1_2.60 + */ enum Type { - RELATIVE = 0, ///< Relative to the control (percentage [0.0f to 1.0f] of the control). - ABSOLUTE = 1 ///< Absolute value in world units. + RELATIVE = 0, ///< Relative to the control (percentage [0.0f to 1.0f] of the control). @SINCE_1_2.60 + ABSOLUTE = 1 ///< Absolute value in world units. @SINCE_1_2.60 }; } // namespace Policy +/** + * @brief Visual Transform Property. + * @SINCE_1_2.60 + */ namespace Property { - +/** + * @brief Enumeration for the type of Transform Property. + * @SINCE_1_2.60 + */ enum Type { /** * @brief Offset of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units). - * @details Name "offset", type Property::VECTOR2. + * @details Name "offset", type Property::VECTOR2, animatable. * @SINCE_1_2.60 * * @see OFFSET_POLICY @@ -163,7 +172,7 @@ enum Type /** * @brief Size of the visual, which can be either relative (percentage [0.0f to 1.0f] of the parent) or absolute (in world units). - * @details Name "size", type Property::VECTOR2. + * @details Name "size", type Property::VECTOR2, animatable. * @see SIZE_POLICY */ SIZE, @@ -237,21 +246,19 @@ enum Type } // namespace Transform /** - * @brief Shader for Visuals + * @brief Shader for Visuals. * @SINCE_1_1.45 */ namespace Shader { - /** - * @brief Shader Property + * @brief Shader Property. * @SINCE_1_1.45 */ namespace Property { - /** - * @brief The type of Shader + * @brief The type of Shader. * @SINCE_1_1.45 */ enum @@ -310,6 +317,17 @@ enum } // namespace Shader +/** + * @brief Status of resource which is used for visual. + * @SINCE_1_3_5 + */ +enum class ResourceStatus +{ + PREPARING, /// Resource is prepared. @SINCE_1_3_5 + READY, /// Resource is ready. @SINCE_1_3_5 + FAILED /// Resource is fail to load @SINCE_1_3_5 +}; + } // namespace Visual /**