#include <viewlayer.hxx>
Definition at line 52 of file viewlayer.hxx.
◆ ~ViewLayer()
| virtual slideshow::internal::ViewLayer::~ViewLayer |
( |
| ) |
|
|
inlinevirtual |
◆ clear()
| virtual void slideshow::internal::ViewLayer::clear |
( |
| ) |
const |
|
pure virtual |
Clear the clipped view layer area.
This method clears the area inside the clip polygon, if none is set, the transformed unit rectangle of the view.
◆ clearAll()
| virtual void slideshow::internal::ViewLayer::clearAll |
( |
| ) |
const |
|
pure virtual |
Clear the complete view.
This method clears the full view area (not only the transformed unit rectangle, or within the clip). If this ViewLayer represents the background layer, the whole XSlideShowView is cleared. If this ViewLayer is implemented using sprites (i.e. one of the upper layers), the sprite is cleared to fully transparent.
◆ createSprite()
Create a sprite for this layer.
- Parameters
-
| rSpriteSizePixel | Sprite size in device pixel |
| nPriority | Sprite priority. This value determines the priority of this sprite, relative to all other sprites of this ViewLayer. The higher the priority, the closer to the foreground the sprite will be. |
- Returns
- the sprite, or NULL on failure (or if this canvas does not support sprites).
◆ getCanvas()
Get the associated canvas of this layer.
The canvas returned by this method must not change, as long as this object is alive.
◆ getSpriteTransformation()
Get the overall view transformation.
Same transformation as with getTransformation(), only that you can safely use this one to position sprites on screen (no ViewLayer offsets included whatsoever).
◆ getTransformation()
Get the overall view transformation.
This method should not simply return the underlying canvas' transformation, but rather provide a layer above that. This enables clients of the slideshow to set their own user space transformation at the canvas, whilst the slideshow adds their transformation on top of that. Concretely, this method returns the user transform (implicitly calculated from the setViewSize() method), combined with the view transformation.
◆ getTranslationOffset()
| virtual css::geometry::IntegerSize2D slideshow::internal::ViewLayer::getTranslationOffset |
( |
| ) |
const |
|
pure virtual |
◆ isOnView()
| virtual bool slideshow::internal::ViewLayer::isOnView |
( |
ViewSharedPtr const & |
rView | ) |
const |
|
pure virtual |
Query whether layer displays on given view.
- Returns
- true, if this layer displays on the given view.
◆ resize()
| virtual bool slideshow::internal::ViewLayer::resize |
( |
const basegfx::B2DRange & |
rArea | ) |
|
|
pure virtual |
Resize this view layer.
- Parameters
-
| rArea | New area to cover. The area is interpreted in the user coordinate system, i.e. relative to the size as given by setViewSize() on the corresponding View. |
- Returns
- true, if layer was actually resized (which invalidates its content)
◆ setClip()
Set clipping on this view layer.
- Parameters
-
| rClip | Clip poly-polygon to set. The polygon is interpreted in the user coordinate system, i.e. the view layer has the size as given by setViewSize() on its corresponding View. |
◆ setPriority()
| virtual void slideshow::internal::ViewLayer::setPriority |
( |
const basegfx::B1DRange & |
rRange | ) |
|
|
pure virtual |
Set the layer priority range.
This method influences the relative priority of this layer, i.e. the z position in relation to other layers on the parent view. The higher the priority range, the further in front the layer resides.
- Parameters
-
| rRange | Priority range, must be in the range [0,1] |
The documentation for this class was generated from the following file:
