X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fdevel-api%2Fvisuals%2Fvisual-properties-devel.h;h=fd837654467d42b9a09d494ee67a1634e3e12c40;hp=b70d2542119fb6614b5d5a0cd694ea0ad8326085;hb=b31764bc76595c1ccd58cf4366dcde2cc78e72cf;hpb=6058e0e734f5b316fd8f8f622e87bfaeb6ca96b4 diff --git a/dali-toolkit/devel-api/visuals/visual-properties-devel.h b/dali-toolkit/devel-api/visuals/visual-properties-devel.h index b70d254..fd83765 100644 --- a/dali-toolkit/devel-api/visuals/visual-properties-devel.h +++ b/dali-toolkit/devel-api/visuals/visual-properties-devel.h @@ -2,7 +2,7 @@ #define DALI_TOOLKIT_DEVEL_API_VISUALS_VISUAL_PROPERTIES_DEVEL_H /* - * Copyright (c) 2016 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. @@ -35,110 +35,100 @@ namespace DevelVisual */ enum Type { - BORDER = Dali::Toolkit::Visual::BORDER, - COLOR = Dali::Toolkit::Visual::COLOR, - GRADIENT = Dali::Toolkit::Visual::GRADIENT, - IMAGE = Dali::Toolkit::Visual::IMAGE, - MESH = Dali::Toolkit::Visual::MESH, - PRIMITIVE = Dali::Toolkit::Visual::PRIMITIVE, - WIREFRAME = Dali::Toolkit::Visual::WIREFRAME, - - TEXT = WIREFRAME + 1, ///< Renders text. + BORDER = Dali::Toolkit::Visual::BORDER, + COLOR = Dali::Toolkit::Visual::COLOR, + GRADIENT = Dali::Toolkit::Visual::GRADIENT, + IMAGE = Dali::Toolkit::Visual::IMAGE, + MESH = Dali::Toolkit::Visual::MESH, + PRIMITIVE = Dali::Toolkit::Visual::PRIMITIVE, + WIREFRAME = Dali::Toolkit::Visual::WIREFRAME, + TEXT = Dali::Toolkit::Visual::TEXT, + N_PATCH = Dali::Toolkit::Visual::N_PATCH, + SVG = Dali::Toolkit::Visual::SVG, + ANIMATED_IMAGE = Dali::Toolkit::Visual::ANIMATED_IMAGE, + + ANIMATED_GRADIENT = ANIMATED_IMAGE + 1, ///< Renders an animated gradient. + ANIMATED_VECTOR_IMAGE = ANIMATED_IMAGE + 2, ///< Renders an animated vector image. + ARC = ANIMATED_IMAGE + 3, ///< Renders an arc. }; +/** + * @brief Visual Properties + */ namespace Property { - enum Type { - TYPE = Dali::Toolkit::Visual::Property::TYPE, - SHADER = Dali::Toolkit::Visual::Property::SHADER, + TYPE = Dali::Toolkit::Visual::Property::TYPE, + SHADER = Dali::Toolkit::Visual::Property::SHADER, + TRANSFORM = Dali::Toolkit::Visual::Property::TRANSFORM, + PREMULTIPLIED_ALPHA = Dali::Toolkit::Visual::Property::PREMULTIPLIED_ALPHA, + MIX_COLOR = Dali::Toolkit::Visual::Property::MIX_COLOR, + OPACITY = Dali::Toolkit::Visual::Property::OPACITY, /** - * @brief The transform used by the visual. - * @details Name "transform", type Property::Map. - * - * @note Optional. - * @see DevelVisual::Transform::Property + * @brief The fitting mode of the visual + * @details Name "fittingMode", type FittingMode (Property::INTEGER) or Property::STRING. + * @see DevelVisual::FittingMode + * @note The default is defined by the type of visual (if it's suitable to be stretched or not). */ - TRANSFORM = SHADER + 1, + VISUAL_FITTING_MODE = OPACITY + 1, /** - * @brief Enables/disables premultiplied alpha. - * The premultiplied alpha is false by default unless this behaviour is modified - * by the derived Visual type. - * - * @details Name "premultipliedAlpha", type Property::Boolean. - * + * @brief The radius for the rounded corners of the visual + * @details Name "cornerRadius", type Property::FLOAT. * @note Optional. */ - PREMULTIPLIED_ALPHA = SHADER + 2, + CORNER_RADIUS = OPACITY + 2, +}; - /** - * @brief Mix color is a blend color for any visual. - * @details Name "mixColor", type Property::VECTOR3 or Property::VECTOR4 - * - * @note Optional - */ - MIX_COLOR = SHADER + 3, +} // namespace Property - /** - * @brief Opacity is the alpha component of the mixColor, above. - * @details Name "opacity", type Property::FLOAT - * - * @note Optional - */ - OPACITY = SHADER + 4 -}; -} //namespace Property +/** + * @brief The values of this enum determine how the visual should be fit to the view + */ +enum FittingMode +{ + FIT_KEEP_ASPECT_RATIO, ///< The visual should be scaled to fit, preserving aspect ratio + FILL, ///< The visual should be stretched to fill, not preserving aspect ratio +}; +/** + * @brief Devel Visual Transform for the offset or size. + */ namespace Transform { +/** + * @brief Visual Transform Property. + */ namespace Property { +/** + * @brief Enumeration for the type of Transform Property. + */ enum Type { - /** - * @brief Offset of the visual. It can be either relative (percentage of the parent) - * or absolute (in world units). - * @details Name "offset", type Property::VECTOR2 - */ - OFFSET, - - /** - * @brief Size of the visual. It can be either relative (percentage of the parent) - * or absolute (in world units). - * @details Name "size", type Property::VECTOR2 - */ - SIZE, - - /** - * @brief The origin of the visual within its control area. - * @details Name "origin", type Align::Type (Property::INTEGER) or Property::STRING. - * @see Toolkit::Align - */ - ORIGIN, + SIZE_POLICY = Dali::Toolkit::Visual::Transform::Property::SIZE_POLICY, /** - * @brief The anchor-point of the visual - * @details Name "anchorPoint", type Align::Type (Property::INTEGER) or Property::STRING. - * @see Toolkit::Align - */ - ANCHOR_POINT, - - /** - * @brief Indicates which components of the offset and size are relative - * (percentage of the parent) or absolute (in world units). - * 0 indicates the component is relative, and 1 absolute. - * @details Name "offsetSizeMode", type Property::VECTOR4 + * @brief Extra size value that will be added to the computed visual size. + * @details Name "extraSize", type Vector2. + * + * @note It is an absolute value. + * The property can be used when a user want to set a visual size as a combined value of `relative` and `absolute`. + * For example, when a user want to set a visual size to (ControlSize * 2 + 10), + * The transform map will be, + * transformMap.Add( Transform::Property::SIZE, Vector2( 2.0f, 2.0f ) ) + * .Add( Transform::Property::SIZE_POLICY, Vector2( Transform::Policy::Relative, Transform::Policy::Relative ) ) + * .Add( Transform::Property::EXTRA_SIZE, Vector2( 10.0f, 10.0f ) ); */ - OFFSET_SIZE_MODE + EXTRA_SIZE = SIZE_POLICY + 1, }; -} //namespace Property +} // namespace Property } // namespace Transform