1 #ifndef __DALI_TOOLKIT_INTERNAL_TEXT_CLIPPER_H__
2 #define __DALI_TOOLKIT_INTERNAL_TEXT_CLIPPER_H__
5 * Copyright (c) 2015 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/actors/layer.h>
23 #include <dali/public-api/actors/image-actor.h>
24 #include <dali/public-api/actors/camera-actor.h>
25 #include <dali/public-api/common/intrusive-ptr.h>
26 #include <dali/public-api/math/vector2.h>
27 #include <dali/public-api/object/ref-object.h>
28 #include <dali/public-api/render-tasks/render-task.h>
40 typedef IntrusivePtr<Clipper> ClipperPtr;
43 * @brief A helper class for clipping actors using a FrameBufferImage.
45 class Clipper : public RefObject
50 * @brief Create a clipper.
52 * @param[in] size The size of the clipping region.
54 static ClipperPtr New( const Vector2& size );
57 * @brief Children added to this actor will be clipped with the specified region.
59 * @note This is done by rendering to a FrameBufferImage which must then be displayed; see also GetImageActor().
60 * @return The root actor.
62 Actor GetRootActor() const;
65 * @brief This actor will display the resulting FrameBufferImage.
67 * @return The image actor.
69 ImageActor GetImageActor() const;
72 * @brief Refresh the contents of the FrameBufferImage.
74 * @param[in] size The size of the clipping region.
76 void Refresh( const Vector2& size );
78 private: // Implementation
81 * @brief Second-phase init
83 * @param[in] size The size of the clipping region.
85 void Initialize( const Vector2& size );
88 * Construct a new Clipper.
93 * A reference counted object may only be deleted by calling Unreference()
99 // Undefined copy constructor and assignment operators
100 Clipper(const Clipper&);
101 Clipper& operator=(const Clipper& rhs);
105 Layer mOffscreenRootActor;
106 CameraActor mOffscreenCameraActor;
107 ImageActor mImageActor;
108 RenderTask mRenderTask;
109 Vector2 mCurrentOffscreenSize;
114 } // namespace Toolkit
118 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_CLIPPER_H__