(Scene3D) Change model's default behavior
[platform/core/uifw/dali-toolkit.git] / dali-scene3d / public-api / controls / model / model.h
index 104e054..45ceca1 100644 (file)
@@ -162,7 +162,7 @@ public:
    * @SINCE_2_1.43
    * @note Even if we set children sensitive as false, model itself's sensitive
    * is depend on it's property.
-   * @note If we don't call this API, default is false. (Allow to traversal model's children during hit-test)
+   * @note If we don't call this API, default is false. (Don't allow to traversal model's children during hit-test)
    *
    * @param[in] enable True to enable model's children can use events.
    */
@@ -177,6 +177,30 @@ public:
   bool GetChildrenSensitive() const;
 
   /**
+   * @brief Whether allow this model's children actor to be keyboard focusable.
+   *
+   * Usually, 3D Model might have a lot of actors. And most of them don't need to check focusable.
+   * To optimize traversal, we need to setup some flag that this model don't allow (or allow) to traversal
+   * children so that child can be keyboard focusable.
+   *
+   * @SINCE_2_2.2
+   * @note Even if we set children focusable as false, model itself's focusable
+   * is depend on it's property.
+   * @note If we don't call this API, default is false. (Don't allow to traversal model's children during focusable test)
+   *
+   * @param[in] enable True to enable model's children can be focusable.
+   */
+  void SetChildrenFocusable(bool enable);
+
+  /**
+   * @brief Gets whether this Model allow model's children actor to be keyboard focusable or not.
+   *
+   * @SINCE_2_2.2
+   * @return bool True if this Model allow model children are focusable.
+   */
+  bool GetChildrenFocusable() const;
+
+  /**
    * @brief Changes Image Based Light as the input textures.
    *
    * @SINCE_2_1.41