/* -*- 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 <sal/types.h>
#include <memory>

namespace basegfx
{
    class B2DHomMatrix;
    class B2DPolyPolygon;
}


/* Definition of CanvasGraphic interface */

namespace cppcanvas
{
    // forward declaration, since tools::PolyPolygon also derives from CanvasGraphic
    typedef std::shared_ptr< class PolyPolygon > PolyPolygonSharedPtr;


    /** This interface defines basic properties of
        objects that can be painted on a Canvas
     */
    class CanvasGraphic
    {
    public:

        virtual ~CanvasGraphic() {}

        /** Set object transformation matrix
         */
        virtual void                             setTransformation( const ::basegfx::B2DHomMatrix& rMatrix ) = 0;

        /** Set object clipping polygon
         */
        virtual void                             setClip( const ::basegfx::B2DPolyPolygon& rClipPoly ) = 0;
        /** Clear object clipping polygon
         */
        virtual void                             setClip() = 0;

        /** Set object composite mode
         * @see css::rendering::CompositeOperation
         */
        virtual void                             setCompositeOp( sal_Int8 aOp ) = 0;

        /** Render to parent canvas

            This method renders the content to the parent canvas,
            i.e. the canvas this object was constructed for.

            @return whether the rendering finished successfully.
         */
        virtual bool draw() const = 0;

    };
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */