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/camera-actor.h>
24 #include <dali/public-api/render-tasks/render-task.h>
25 #include <dali-toolkit/public-api/controls/image-view/image-view.h>
26 #include <dali/public-api/signals/connection-tracker.h>
38 typedef IntrusivePtr<Clipper> ClipperPtr;
41 * @brief A helper class for clipping actors using a FrameBufferImage.
43 class Clipper : public RefObject, public ConnectionTracker
48 * @brief Create a clipper.
50 * @param[in] size The size of the clipping region.
52 static ClipperPtr New( const Vector2& size );
55 * @brief Children added to this actor will be clipped with the specified region.
57 * @note This is done by rendering to a FrameBufferImage which must then be displayed; see also GetImageActor().
58 * @return The root actor.
60 Actor GetRootActor() const;
63 * @brief This actor will display the resulting FrameBufferImage.
65 * @return The image actor.
67 Actor GetImageActor() const;
70 * @brief Refresh the contents of the FrameBufferImage.
72 * @param[in] size The size of the clipping region.
74 void Refresh( const Vector2& size );
76 private: // Implementation
79 * @brief Second-phase init
81 * @param[in] size The size of the clipping region.
83 void Initialize( const Vector2& size );
86 * The renderer is not created until the clipper actor is set on stage, only by then the blend function could be set.
88 * @param[in] actor The actor connected to stage.
90 void OnStageConnect( Dali::Actor actor );
93 * Construct a new Clipper.
98 * A reference counted object may only be deleted by calling Unreference()
104 // Undefined copy constructor and assignment operators
105 Clipper(const Clipper&);
106 Clipper& operator=(const Clipper& rhs);
110 Layer mOffscreenRootActor;
111 CameraActor mOffscreenCameraActor;
112 ImageView mImageActor;
113 RenderTask mRenderTask;
114 Vector2 mCurrentOffscreenSize;
119 } // namespace Toolkit
123 #endif // __DALI_TOOLKIT_INTERNAL_TEXT_CLIPPER_H__