X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali%2Fpublic-api%2Factors%2Fcamera-actor.h;h=401a0e12d127b4249c17e3f7ba6841c627fa0eb8;hb=8bccadc96b3773fb10c562a5ccdf1b071b2efe8e;hp=c9cb3ce6e9d0e4487e6edb34a1e114c49040d1db;hpb=1f7c14406d57565142ea361461dd9edfa16619f3;p=platform%2Fcore%2Fuifw%2Fdali-core.git diff --git a/dali/public-api/actors/camera-actor.h b/dali/public-api/actors/camera-actor.h index c9cb3ce..401a0e1 100644 --- a/dali/public-api/actors/camera-actor.h +++ b/dali/public-api/actors/camera-actor.h @@ -2,7 +2,7 @@ #define __DALI_CAMERA_ACTOR_H__ /* - * Copyright (c) 2015 Samsung Electronics Co., Ltd. + * Copyright (c) 2018 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. @@ -33,13 +33,13 @@ class CameraActor; } /** - * @brief Camera enumerations. + * @brief Enumeration for camera. * @SINCE_1_0.0 */ namespace Camera { /** - * @brief Type determines how camera operates. + * @brief Enumeration for type determination of how camera operates. * @SINCE_1_0.0 */ enum Type @@ -49,7 +49,7 @@ enum Type }; /** - * @brief Projection modes. + * @brief Enumeration for projection modes. * @SINCE_1_0.0 */ enum ProjectionMode @@ -65,7 +65,7 @@ enum ProjectionMode * * Allows the developer to use actor semantics to control a camera. * - * DALi has a concept of a camera to display its virtual 3D world to a 2D screen. + * DALi has a concept of a camera to display its virtual 3D world to a 2D screen. * There are 2 ways of using the camera in DALi: * * - For 2D applications, you do not need to care about the camera at all. The default camera is already best suited for 2D applications @@ -75,23 +75,23 @@ enum ProjectionMode * - For 3D applications, you can change the view by manipulating the camera. You can translate or rotate the camera in this case. * Note that the top-left corner of the screen and unit 1 no longer are (0,0,0) and 1 pixel after manipulating the camera. * - * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default + * There are two types of camera actor, FREE_LOOK and LOOK_AT_TARGET. By default, * the camera actor will be FREE_LOOK. * * - A FREE_LOOK camera uses actor's orientation to control where the camera is looking. * If no additional rotations are specified, the camera looks in the negative Z direction. * - * - For LOOK_AT_TARGET the actor's orientation is ignored, instead the camera looks at TARGET_POSITION + * - For LOOK_AT_TARGET, the actor's orientation is ignored, instead the camera looks at TARGET_POSITION * in world coordinates. * * @SINCE_1_0.0 */ -class DALI_IMPORT_API CameraActor : public Actor +class DALI_CORE_API CameraActor : public Actor { public: /** - * @brief An enumeration of properties belonging to the CameraActor class. + * @brief Enumeration for the instance of properties belonging to the CameraActor class. * * Properties additional to Actor. * @SINCE_1_0.0 @@ -99,7 +99,7 @@ public: struct Property { /** - * @brief An enumeration of properties belonging to the CameraActor class. + * @brief Enumeration for the instance of properties belonging to the CameraActor class. * * Properties additional to Actor. * @SINCE_1_0.0 @@ -124,39 +124,39 @@ public: }; /** - * @brief Create an uninitialized CameraActor handle. + * @brief Creates an uninitialized CameraActor handle. * - * Initialise it using CameraActor::New(). + * Initialize it using CameraActor::New(). * Calling member functions with an uninitialized CameraActor handle is not allowed. * @SINCE_1_0.0 */ CameraActor(); /** - * @brief Create a CameraActor object. + * @brief Creates a CameraActor object. * * Sets the default camera perspective projection for the stage's size. @see SetPerspectiveProjection(). * @SINCE_1_0.0 - * @return The newly created camera actor. + * @return The newly created camera actor */ static CameraActor New(); /** - * @brief Create a CameraActor object. + * @brief Creates a CameraActor object. * * Sets the default camera perspective projection for the given canvas size. @see SetPerspectiveProjection(). * * @SINCE_1_0.0 - * @param[in] size The canvas size. - * @return The newly created camera actor. + * @param[in] size The canvas size + * @return The newly created camera actor */ static CameraActor New( const Size& size ); /** - * @brief Downcast a handle to CameraActor handle. + * @brief Downcasts a handle to CameraActor handle. * - * If handle points to a CameraActor the downcast produces valid - * handle. If not the returned handle is left uninitialized. + * If handle points to a CameraActor, the downcast produces valid handle. + * If not, the returned handle is left uninitialized. * @SINCE_1_0.0 * @param[in] handle to An object * @return Handle to a CameraActor or an uninitialized handle @@ -164,32 +164,32 @@ public: static CameraActor DownCast( BaseHandle handle ); /** - * @brief Destructor + * @brief Destructor. * - * This is non-virtual since derived Handle types must not contain data or virtual methods. + * This is non-virtual, since derived Handle types must not contain data or virtual methods. * @SINCE_1_0.0 */ ~CameraActor(); /** - * @brief Copy constructor + * @brief Copy constructor. * * @SINCE_1_0.0 - * @param [in] copy The actor to copy. + * @param[in] copy The actor to copy */ CameraActor(const CameraActor& copy); /** - * @brief Assignment operator + * @brief Assignment operator. * * @SINCE_1_0.0 - * @param [in] rhs The actor to copy. + * @param[in] rhs The actor to copy * @return A reference to this */ CameraActor& operator=(const CameraActor& rhs); /** - * @brief Set the camera type. + * @brief Sets the camera type. * The default type is Dali::Camera::FREE_LOOK * @SINCE_1_0.0 * @param[in] type The camera type @@ -197,7 +197,7 @@ public: void SetType( Dali::Camera::Type type ); /** - * @brief Get the type of the camera. + * @brief Gets the type of the camera. * * @SINCE_1_0.0 * @return The type of camera @@ -205,7 +205,7 @@ public: Dali::Camera::Type GetType() const; /** - * @brief Set the projection mode. + * @brief Sets the projection mode. * * @SINCE_1_0.0 * @param[in] mode One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION @@ -213,7 +213,7 @@ public: void SetProjectionMode( Dali::Camera::ProjectionMode mode ); /** - * @brief Get the projection mode. + * @brief Gets the projection mode. * * @SINCE_1_0.0 * @return One of PERSPECTIVE_PROJECTION or ORTHOGRAPHIC_PROJECTION @@ -221,7 +221,7 @@ public: Dali::Camera::ProjectionMode GetProjectionMode() const; /** - * @brief Set the field of view. + * @brief Sets the field of view. * * @SINCE_1_0.0 * @param[in] fieldOfView The field of view in radians @@ -229,7 +229,7 @@ public: void SetFieldOfView( float fieldOfView ); /** - * @brief Get the field of view in Radians. + * @brief Gets the field of view in Radians. * * The default field of view is 45 degrees. * @SINCE_1_0.0 @@ -238,7 +238,7 @@ public: float GetFieldOfView( ); /** - * @brief Set the aspect ratio. + * @brief Sets the aspect ratio. * * @SINCE_1_0.0 * @param[in] aspectRatio The aspect ratio @@ -246,7 +246,7 @@ public: void SetAspectRatio( float aspectRatio ); /** - * @brief Get the aspect ratio of the camera. + * @brief Gets the aspect ratio of the camera. * * The default aspect ratio is 4.0f/3.0f. * @SINCE_1_0.0 @@ -263,7 +263,7 @@ public: void SetNearClippingPlane( float nearClippingPlane ); /** - * @brief Get the near clipping plane distance. + * @brief Gets the near clipping plane distance. * * The default near clipping plane is 800.0f, to match the default screen height. * Reduce this value to see objects closer to the camera. @@ -281,7 +281,7 @@ public: void SetFarClippingPlane( float farClippingPlane ); /** - * @brief Get the far clipping plane distance. + * @brief Gets the far clipping plane distance. * * The default value is the default near clipping plane + (0xFFFF>>4). * @SINCE_1_0.0 @@ -290,7 +290,7 @@ public: float GetFarClippingPlane( ); /** - * @brief Set the target position of the camera. + * @brief Sets the target position of the camera. * * @SINCE_1_0.0 * @param[in] targetPosition The position of the target to look at @@ -299,7 +299,7 @@ public: void SetTargetPosition( const Vector3& targetPosition ); /** - * @brief Get Camera Target position. + * @brief Gets the Camera Target position. * * The default target position is Vector3::ZERO. * @SINCE_1_0.0 @@ -309,7 +309,7 @@ public: Vector3 GetTargetPosition() const; /** - * @brief Request for an inversion on the Y axis on the projection calculation. + * @brief Requests for an inversion on the Y axis on the projection calculation. * * The default value is not inverted. * @SINCE_1_0.0 @@ -318,17 +318,17 @@ public: void SetInvertYAxis(bool invertYAxis); /** - * @brief Get whether the Y axis is inverted. + * @brief Gets whether the Y axis is inverted. * * @SINCE_1_0.0 - * @return True if the Y axis is inverted, false otherwise + * @return @c True if the Y axis is inverted, @c false otherwise */ bool GetInvertYAxis(); /** * @brief Sets the default camera perspective projection for the given canvas size. * - * Sets the near and far clipping planes, the field of view, the aspect ratio + * Sets the near and far clipping planes, the field of view, the aspect ratio, * and the Z position of the actor based on the canvas size so that 1 unit in * XY (z=0) plane is 1 pixel on screen. * @@ -336,7 +336,7 @@ public: * projection for the stage's size. * * @SINCE_1_0.0 - * @param[in] size The canvas size. + * @param[in] size The canvas size * @pre If size is non ZERO, \e width and \e height must be greater than zero. * */ @@ -379,7 +379,7 @@ public: // Not intended for use by Application developers * @brief This constructor is used by CameraActor::New() methods. * * @SINCE_1_0.0 - * @param [in] actor A pointer to a newly allocated Dali resource + * @param[in] actor A pointer to a newly allocated Dali resource */ explicit DALI_INTERNAL CameraActor(Internal::CameraActor* actor); /// @endcond