1 #ifndef DALI_VECTOR_ANIMATION_RENDERER_H
2 #define DALI_VECTOR_ANIMATION_RENDERER_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/object/base-handle.h>
23 #include <dali/public-api/rendering/renderer.h>
26 #include <dali/public-api/dali-adaptor-common.h>
31 * @addtogroup dali_adaptor_framework
35 namespace Internal DALI_INTERNAL
39 class VectorAnimationRenderer;
44 * @brief Used for rendering a vector animation file
46 class DALI_ADAPTOR_API VectorAnimationRenderer : public BaseHandle
51 * @brief Creates an initialized handle to a new VectorAnimationRenderer.
53 * @param[in] url The url of the vector animation file
54 * @return A handle to a newly allocated VectorAnimationRenderer
56 static VectorAnimationRenderer New( const std::string& url );
59 * @brief Creates an empty handle.
60 * Use VectorAnimationRenderer::New() to create an initialized object.
62 VectorAnimationRenderer();
67 ~VectorAnimationRenderer();
70 * @brief This copy constructor is required for (smart) pointer semantics.
72 * @param[in] handle A reference to the copied handle
74 VectorAnimationRenderer( const VectorAnimationRenderer& handle );
77 * @brief This assignment operator is required for (smart) pointer semantics.
79 * @param[in] rhs A reference to the copied handle
80 * @return A reference to this
82 VectorAnimationRenderer& operator=( const VectorAnimationRenderer& rhs );
85 * @brief Sets the renderer used to display the result image.
87 * @param[in] renderer The renderer used to display the result image
89 void SetRenderer( Renderer renderer );
92 * @brief Sets the target image size.
94 * @param[in] width The target image width
95 * @param[in] height The target image height
97 void SetSize( uint32_t width, uint32_t height );
100 * @brief Renders the content to the target buffer synchronously.
102 * @param[in] frameNumber The frame number to be rendered
103 * @return True if the rendering success, false otherwise.
105 bool Render( uint32_t frameNumber );
108 * @brief Gets the total number of frames of the file
110 * @return The total number of frames
112 uint32_t GetTotalFrameNumber() const;
115 * @brief Gets the frame rate of the file.
117 * @return The frame rate of the file
119 float GetFrameRate() const;
122 * @brief Gets the default size of the file,.
124 * @return The default size of the file
126 void GetDefaultSize( uint32_t& width, uint32_t& height ) const;
130 public: // Not intended for application developers
134 * @brief The constructor.
135 * @note Not intended for application developers.
137 * @param[in] pointer A pointer to a newly allocated VectorAnimationRenderer
139 explicit DALI_INTERNAL VectorAnimationRenderer( Internal::Adaptor::VectorAnimationRenderer* internal );
149 #endif // DALI_VECTOR_ANIMATION_RENDERER_H