LibreOffice Module slideshow (master) 1
Public Member Functions | List of all members
slideshow::internal::AnimatableShape Class Referenceabstract

Represents an animatable shape. More...

#include <animatableshape.hxx>

Inheritance diagram for slideshow::internal::AnimatableShape:
[legend]
Collaboration diagram for slideshow::internal::AnimatableShape:
[legend]

Public Member Functions

virtual void enterAnimationMode ()=0
 Notify the Shape that an animation starts now. More...
 
virtual void leaveAnimationMode ()=0
 Notify the Shape that it is no longer animated. More...
 
- Public Member Functions inherited from slideshow::internal::Shape
 Shape ()
 
virtual ~Shape ()
 
 Shape (const Shape &)=delete
 
Shapeoperator= (const Shape &)=delete
 
virtual css::uno::Reference< css::drawing::XShape > getXShape () const =0
 Get the associated XShape of this shape. More...
 
virtual void addViewLayer (const ViewLayerSharedPtr &rNewLayer, bool bRedrawLayer)=0
 Add a new view layer. More...
 
virtual bool removeViewLayer (const ViewLayerSharedPtr &rNewLayer)=0
 Withdraw the shape from a view layer. More...
 
virtual void clearAllViewLayers ()=0
 Withdraw all view layers at once. More...
 
virtual bool update () const =0
 Update the shape. More...
 
virtual bool render () const =0
 Render the shape. More...
 
virtual bool isContentChanged () const =0
 Query whether shape content changed. More...
 
virtual ::basegfx::B2DRectangle getBounds () const =0
 Get the current shape position and size. More...
 
virtual ::basegfx::B2DRectangle getDomBounds () const =0
 Get the DOM position and size of the shape. More...
 
virtual ::basegfx::B2DRectangle getUpdateArea () const =0
 Get the current shape update area. More...
 
virtual bool isVisible () const =0
 Query whether the shape is visible at all. More...
 
virtual double getPriority () const =0
 Get the shape priority. More...
 
virtual bool isBackgroundDetached () const =0
 Query whether the Shape is currently detached from the background. More...
 
virtual bool isForeground () const
 Check whether the shape belongs to the foreground. More...
 
virtual void setIsForeground (const bool bIsForeground)
 Set the flag that holds whether the shape is in the foreground or not. More...
 

Detailed Description

Represents an animatable shape.

This interface adds animation handling methods to a shape. It allows transparent switching between sprite-based viewing and static painting, depending on whether animations are currently running.

Definition at line 37 of file animatableshape.hxx.

Member Function Documentation

◆ enterAnimationMode()

virtual void slideshow::internal::AnimatableShape::enterAnimationMode ( )
pure virtual

Notify the Shape that an animation starts now.

This method enters animation mode on all registered views.

Attention: \n This method is supposed to be called only
from the LayerManager, since it might involve shifting shapes between different layers (and removing this shape from the background layer in the first place)

Implemented in slideshow::internal::DrawShape.

◆ leaveAnimationMode()

virtual void slideshow::internal::AnimatableShape::leaveAnimationMode ( )
pure virtual

Notify the Shape that it is no longer animated.

This methods requests the Shape to end animation mode on all registered views, if called more or equal the times enterAnimationMode() was called. That is, the Shape only leaves animation mode, if all requested enterAnimationMode() call sites have issued their matching leaveAnimationMode().

Attention: \n This method is supposed to be called only
from the LayerManager, since it might involve shifting shapes between different layers (and adding this shape to the background layer again)

Implemented in slideshow::internal::DrawShape.


The documentation for this class was generated from the following file: