Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / actors / camera-actor.h

diff --git a/dali/public-api/actors/camera-actor.h b/dali/public-api/actors/camera-actor.h
index 432b157..74afa6e 100644 (file)
--- a/dali/public-api/actors/camera-actor.h
+++ b/dali/public-api/actors/camera-actor.h
@@ -32,6 +32,10 @@ namespace Internal DALI_INTERNAL
 class CameraActor;
 }
 
+/**
+ * @brief Camera enumerations.
+ * @since_tizen 2.4
+ */
 namespace Camera
 {
 /**
@@ -40,8 +44,8 @@ namespace Camera
  */
 enum Type
 {
-  FREE_LOOK,      ///< Camera orientation is taken from CameraActor
-  LOOK_AT_TARGET, ///< Camera is oriented to always look at a target
+  FREE_LOOK,      ///< Camera orientation is taken from CameraActor @since_tizen 2.4
+  LOOK_AT_TARGET, ///< Camera is oriented to always look at a target @since_tizen 2.4
 };
 
 /**
@@ -50,8 +54,8 @@ enum Type
  */
 enum ProjectionMode
 {
-  PERSPECTIVE_PROJECTION,    ///< Distance causes foreshortening; objects further from the camera appear smaller
-  ORTHOGRAPHIC_PROJECTION,    ///< Relative distance from the camera does not affect the size of objects
+  PERSPECTIVE_PROJECTION,    ///< Distance causes foreshortening; objects further from the camera appear smaller @since_tizen 2.4
+  ORTHOGRAPHIC_PROJECTION,    ///< Relative distance from the camera does not affect the size of objects @since_tizen 2.4
 };
 
 } // namespace Camera
@@ -78,6 +82,7 @@ public:
 
   /**
    * @brief An enumeration of properties belonging to the CameraActor class.
+   *
    * Properties additional to Actor.
    * @since_tizen 2.4
    */
@@ -85,28 +90,28 @@ public:
   {
     enum
     {
-      TYPE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< name "type",                  type std::string
-      PROJECTION_MODE,                                   ///< name "projection-mode",       type std::string
-      FIELD_OF_VIEW,                                     ///< name "field-of-view",         type float
-      ASPECT_RATIO,                                      ///< name "aspect-ratio",          type float
-      NEAR_PLANE_DISTANCE,                               ///< name "near-plane-distance",   type float
-      FAR_PLANE_DISTANCE,                                ///< name "far-plane-distance",    type float
-      LEFT_PLANE_DISTANCE,                               ///< name "left-plane-distance",   type float
-      RIGHT_PLANE_DISTANCE,                              ///< name "right-plane-distance",  type float
-      TOP_PLANE_DISTANCE,                                ///< name "top-plane-distance",    type float
-      BOTTOM_PLANE_DISTANCE,                             ///< name "bottom-plane-distance", type float
-      TARGET_POSITION,                                   ///< name "target-position",       type Vector3
-      PROJECTION_MATRIX,                                 ///< name "projection-matrix",     type Matrix
-      VIEW_MATRIX,                                       ///< name "view-matrix",           type Matrix
-      INVERT_Y_AXIS,                                     ///< name "invert-y-axis",         type bool
+      TYPE = DEFAULT_DERIVED_ACTOR_PROPERTY_START_INDEX, ///< type std::string @since_tizen 2.4
+      PROJECTION_MODE,                                   ///< type std::string @since_tizen 2.4
+      FIELD_OF_VIEW,                                     ///< type float @since_tizen 2.4
+      ASPECT_RATIO,                                      ///< type float @since_tizen 2.4
+      NEAR_PLANE_DISTANCE,                               ///< type float @since_tizen 2.4
+      FAR_PLANE_DISTANCE,                                ///< type float @since_tizen 2.4
+      LEFT_PLANE_DISTANCE,                               ///< type float @since_tizen 2.4
+      RIGHT_PLANE_DISTANCE,                              ///< type float @since_tizen 2.4
+      TOP_PLANE_DISTANCE,                                ///< type float @since_tizen 2.4
+      BOTTOM_PLANE_DISTANCE,                             ///< type float @since_tizen 2.4
+      TARGET_POSITION,                                   ///< type Vector3 @since_tizen 2.4
+      PROJECTION_MATRIX,                                 ///< type Matrix @since_tizen 2.4
+      VIEW_MATRIX,                                       ///< type Matrix @since_tizen 2.4
+      INVERT_Y_AXIS,                                     ///< type bool @since_tizen 2.4
     };
   };
 
   /**
    * @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_tizen 2.4
    */
   CameraActor();
@@ -116,7 +121,7 @@ public:
    *
    * Sets the default camera perspective projection for the stage's size. @see SetPerspectiveProjection().
    * @since_tizen 2.4
-   * @return the newly created camera actor.
+   * @return The newly created camera actor.
    */
   static CameraActor New();
 
@@ -127,18 +132,18 @@ public:
    *
    * @since_tizen 2.4
    * @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_tizen 2.4
    * @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 );
 
@@ -163,6 +168,7 @@ public:
    *
    * @since_tizen 2.4
    * @param [in] rhs The actor to copy.
+   * @return A reference to this
    */
   CameraActor& operator=(const CameraActor& rhs);
 
@@ -178,7 +184,7 @@ public:
    * @brief Get the type of the camera.
    *
    * @since_tizen 2.4
-   * @return the type of camera
+   * @return The type of camera
    */
   Dali::Camera::Type GetType() const;
 
@@ -228,7 +234,7 @@ public:
    *
    * The default aspect ratio is 4.0f/3.0f
    * @since_tizen 2.4
-   * @return the aspect ratio
+   * @return The aspect ratio
    */
   float GetAspectRatio( );
 
@@ -236,7 +242,7 @@ public:
    * @brief Sets the near clipping plane distance.
    *
    * @since_tizen 2.4
-   * @param[in] nearClippingPlane distance of the near clipping plane
+   * @param[in] nearClippingPlane Distance of the near clipping plane
    */
   void SetNearClippingPlane( float nearClippingPlane );
 
@@ -246,7 +252,7 @@ public:
    * 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_tizen 2.4
-   * @return the near clipping plane value
+   * @return The near clipping plane value
    */
   float GetNearClippingPlane( );
 
@@ -254,7 +260,7 @@ public:
    * @brief Sets the far clipping plane distance.
    *
    * @since_tizen 2.4
-   * @param[in] farClippingPlane distance of the far clipping plane
+   * @param[in] farClippingPlane Distance of the far clipping plane
    */
   void SetFarClippingPlane( float farClippingPlane );
 
@@ -263,7 +269,7 @@ public:
    *
    * The default value is the default near clipping plane + (0xFFFF>>4)
    * @since_tizen 2.4
-   * @return the far clipping plane value
+   * @return The far clipping plane value
    */
   float GetFarClippingPlane( );
 
@@ -353,7 +359,7 @@ public:
 
 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_tizen 2.4
    * @param [in] actor A pointer to a newly allocated Dali resource