canvascustomspritehelper.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include <basegfx/matrix/b2dhommatrix.hxx>
#include <basegfx/point/b2dpoint.hxx>
#include <basegfx/polygon/b2dpolypolygon.hxx>
#include <basegfx/range/b2drange.hxx>
#include <basegfx/vector/b2dvector.hxx>
#include <base/spritesurface.hxx>
#include <canvas/canvastoolsdllapi.h>
 
namespace com::sun::star::geometry { struct AffineMatrix2D; }
namespace com::sun::star::geometry { struct RealPoint2D; }
namespace com::sun::star::geometry { struct RealSize2D; }
namespace com::sun::star::rendering { class XBitmap; }
namespace com::sun::star::rendering { class XPolyPolygon2D; }
namespace com::sun::star::rendering { struct RenderState; }
namespace com::sun::star::rendering { struct ViewState; }
 
 
namespace canvas
{
    /* Definition of CanvasCustomSpriteHelper class */
 
    class CANVASTOOLS_DLLPUBLIC CanvasCustomSpriteHelper
    {
    public:
        CanvasCustomSpriteHelper();
        virtual ~CanvasCustomSpriteHelper() {}
 
        void init( const css::geometry::RealSize2D&                 rSpriteSize,
                   const SpriteSurface::Reference&                  rOwningSpriteCanvas );
 
        void disposing();
 
        // XCanvas
        void clearingContent( const Sprite::Reference& rSprite );
 
        void checkDrawBitmap( const Sprite::Reference&                                rSprite,
                              const css::uno::Reference< css::rendering::XBitmap >&   xBitmap,
                              const css::rendering::ViewState&                        viewState,
                              const css::rendering::RenderState&                      renderState );
 
        // XSprite
        void setAlpha( const Sprite::Reference& rSprite,
                       double                   alpha );
        void move( const Sprite::Reference&            rSprite,
                   const css::geometry::RealPoint2D&   aNewPos,
                   const css::rendering::ViewState&    viewState,
                   const css::rendering::RenderState&  renderState );
        void transform( const Sprite::Reference&               rSprite,
                       const css::geometry::AffineMatrix2D&    aTransformation );
        void clip( const Sprite::Reference&                                       rSprite,
                   const css::uno::Reference< css::rendering::XPolyPolygon2D >&   aClip );
        void setPriority( const Sprite::Reference&  rSprite,
                          double                    nPriority );
        void show( const Sprite::Reference& rSprite );
        void hide( const Sprite::Reference& rSprite );
 
        // Sprite
        bool isAreaUpdateOpaque( const ::basegfx::B2DRange& rUpdateArea ) const;
        const ::basegfx::B2DPoint& getPosPixel() const { return maPosition; }
        const ::basegfx::B2DVector& getSizePixel() const { return maSize; }
        ::basegfx::B2DRange  getUpdateArea() const;
        double               getPriority() const { return mfPriority; }
 
        // redraw must be implemented by derived - non sensible default implementation
        // void redraw( const Sprite::Reference& rSprite,
        //              const ::basegfx::B2DPoint& rPos ) const;
 
 
        // Helper methods for derived classes
 
 
        ::basegfx::B2DRange getUpdateArea( const ::basegfx::B2DRange& rUntransformedSpriteBounds ) const;
 
        bool isContentFullyOpaque() const { return mbIsContentFullyOpaque; }
 
        bool hasTransformChanged() const { return mbTransformDirty; }
 
        double getAlpha() const { return mfAlpha; }
 
        const css::uno::Reference<
            css::rendering::XPolyPolygon2D >& getClip() const { return mxClipPoly; }
 
        const ::basegfx::B2DHomMatrix& getTransformation() const { return maTransform; }
 
        bool isActive() const { return mbActive; }
 
    protected:
        void transformUpdated() const { mbTransformDirty=false; }
 
    private:
        CanvasCustomSpriteHelper( const CanvasCustomSpriteHelper& ) = delete;
        CanvasCustomSpriteHelper& operator=( const CanvasCustomSpriteHelper& ) = delete;
 
        virtual ::basegfx::B2DPolyPolygon polyPolygonFromXPolyPolygon2D(
            css::uno::Reference< css::rendering::XPolyPolygon2D >& xPoly ) const = 0;
 
        bool updateClipState( const Sprite::Reference& rSprite );
 
 
        SpriteSurface::Reference                            mpSpriteCanvas;
 
        ::basegfx::B2DRange                                 maCurrClipBounds;
 
        // sprite state
        ::basegfx::B2DPoint                                 maPosition;
        ::basegfx::B2DVector                                maSize;
        ::basegfx::B2DHomMatrix                             maTransform;
        css::uno::Reference< css::rendering::XPolyPolygon2D > mxClipPoly;
        double                                              mfPriority;
        double                                              mfAlpha;
        bool                                                mbActive; // true, if not hidden
 
        bool                                                mbIsCurrClipRectangle;
 
        mutable bool                                        mbIsContentFullyOpaque;
 
        mutable bool                                        mbTransformDirty;
    };
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */