#define DALI_TOOLKIT_PRIMITIVE_VISUAL_PROPERTIES_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.
namespace Dali
{
-
namespace Toolkit
{
-
/**
* @addtogroup dali_toolkit_visuals
* @{
*/
namespace PrimitiveVisual
{
-
/**
* @brief PrimitiveVisual Property.
* @SINCE_1_1.45
*/
namespace Property
{
-
/**
* @brief Enumeration for the instance of properties belonging to the PrimitiveVisual.
* @SINCE_1_1.45
/**
* @brief The number of slices as you go around the shape.
* @details Name "slices", type Property::INTEGER.
- * For spheres and conical frustrums, this determines how many divisions there are as you go around the object.
+ * For spheres and conical frustums, this determines how many divisions there are as you go around the object.
* @SINCE_1_1.45
* @note Optional. If not specified, the default is 128.
* @note Applies to:
* - Shape::SPHERE
- * - Shape::CONICAL_FRUSTRUM
+ * - Shape::CONICAL_FRUSTUM
* - Shape::CONE
* - Shape::CYLINDER
* @note The range is from 1 to 255.
STACKS,
/**
- * @brief The scale of the radius of the top circle of a conical frustrum.
+ * @brief The scale of the radius of the top circle of a conical frustum.
* @details Name "scaleTopRadius", type Property::FLOAT.
* @SINCE_1_1.45
* @note Optional. If not specified, the default is 1.0f.
* @note Applies to:
- * - Shape::CONICAL_FRUSTRUM
+ * - Shape::CONICAL_FRUSTUM
* @note Only values greater than or equal to 0.0f are accepted.
*/
SCALE_TOP_RADIUS,
/**
- * @brief The scale of the radius of the bottom circle of a conical frustrum.
+ * @brief The scale of the radius of the bottom circle of a conical frustum.
* @details Name "scaleBottomRadius", type Property::FLOAT.
* @SINCE_1_1.45
* @note Optional. If not specified, the default is 1.5f.
* @note Applies to:
- * - Shape::CONICAL_FRUSTRUM
+ * - Shape::CONICAL_FRUSTUM
* - Shape::CONE
* @note Only values greater than or equal to 0.0f are accepted.
*/
* @SINCE_1_1.45
* @note Optional. If not specified, the default is 3.0f.
* @note Applies to:
- * - Shape::CONICAL_FRUSTRUM
+ * - Shape::CONICAL_FRUSTUM
* - Shape::CONE
* - Shape::CYLINDER
* @note Only values greater than or equal to 0.0f are accepted.
*/
namespace Shape
{
-
/**
* @brief The primitive shape to render as a PrimitiveVisual.
* @SINCE_1_1.45
*/
enum Type
{
- SPHERE, ///< A perfectly round geometrical object in three-dimensional space. @SINCE_1_1.45
- CONICAL_FRUSTRUM, ///< The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_1.45
- CONE, ///< Equivalent to a conical frustrum with top radius of zero. @SINCE_1_1.45
- CYLINDER, ///< Equivalent to a conical frustrum with equal radii for the top and bottom circles. @SINCE_1_1.45
- CUBE, ///< Equivalent to a bevelled cube with a bevel percentage of zero. @SINCE_1_1.45
- OCTAHEDRON, ///< Equivalent to a bevelled cube with a bevel percentage of one. @SINCE_1_1.45
- BEVELLED_CUBE, ///< A cube/cuboid with all edges flattened to some degree. @SINCE_1_1.45
+ SPHERE, ///< A perfectly round geometrical object in three-dimensional space. @SINCE_1_1.45
+ CONICAL_FRUSTUM, ///< The area bound between two circles, i.e. a cone with the tip removed. @SINCE_1_3.15
+ CONE, ///< Equivalent to a conical frustum with top radius of zero. @SINCE_1_1.45
+ CYLINDER, ///< Equivalent to a conical frustum with equal radii for the top and bottom circles. @SINCE_1_1.45
+ CUBE, ///< Equivalent to a bevelled cube with a bevel percentage of zero. @SINCE_1_1.45
+ OCTAHEDRON, ///< Equivalent to a bevelled cube with a bevel percentage of one. @SINCE_1_1.45
+ BEVELLED_CUBE ///< A cube/cuboid with all edges flattened to some degree. @SINCE_1_1.45
};
-}
+} // namespace Shape
} // namespace PrimitiveVisual