/* -*- 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 <drawinglayer/primitive3d/groupprimitive3d.hxx>

#include <drawinglayer/attribute/fillgraphicattribute.hxx>

#include <basegfx/vector/b2dvector.hxx>

#include <drawinglayer/attribute/fillgradientattribute.hxx>

namespace drawinglayer::primitive3d

    {

        /** TexturePrimitive3D class

            This 3D grouping primitive is used to define a texture for

            3d geometry by embedding it. It is used as base class for

            extended texture definitions

         */

        class TexturePrimitive3D : public GroupPrimitive3D

        {

        private:

            /// texture geometry definition

            basegfx::B2DVector                          maTextureSize;

            /// flag if texture shall be modulated with white interpolated color

            bool                                        mbModulate : 1;

            /// flag if texture shall be filtered

            bool                                        mbFilter : 1;

        public:

            /// constructor

            TexturePrimitive3D(

                const Primitive3DContainer& rChildren,

                const basegfx::B2DVector& rTextureSize,

                bool bModulate,

                bool bFilter);

            /// data read access

            const basegfx::B2DVector& getTextureSize() const { return maTextureSize; }

            bool getModulate() const { return mbModulate; }

            bool getFilter() const { return mbFilter; }

            /// compare operator

            virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;

        };

} // end of namespace drawinglayer::primitive3d

namespace drawinglayer::primitive3d

    {

        /** UnifiedTransparenceTexturePrimitive3D class

            This 3D primitive expands TexturePrimitive3D to a unified

            transparence texture definition. All 3D primitives

            embedded here will be shown with the given transparency.

         */

        class UnifiedTransparenceTexturePrimitive3D final : public TexturePrimitive3D

        {

        private:

            /// transparency definition

            double                                      mfTransparence;

        public:

            /// constructor

            UnifiedTransparenceTexturePrimitive3D(

                double fTransparence,

                const Primitive3DContainer& rChildren);

            /// data read access

            double getTransparence() const { return mfTransparence; }

            /// compare operator

            virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;

            /// own getB3DRange implementation to include transparent geometries to BoundRect calculations

            virtual basegfx::B3DRange getB3DRange(const geometry::ViewInformation3D& rViewInformation) const override;

            /// local decomposition.

            virtual Primitive3DContainer get3DDecomposition(const geometry::ViewInformation3D& rViewInformation) const override;

            /// provide unique ID

            DeclPrimitive3DIDBlock()

        };

} // end of namespace drawinglayer::primitive3d

namespace drawinglayer::primitive3d

    {

        /** GradientTexturePrimitive3D class

            This 3D primitive expands TexturePrimitive3D to a gradient texture

            definition. All 3D primitives embedded here will be shown with the

            defined gradient.

         */

        class GradientTexturePrimitive3D : public TexturePrimitive3D

        {

        private:

            /// the gradient definition

            attribute::FillGradientAttribute        maGradient;

        public:

            /// constructor

            GradientTexturePrimitive3D(

                attribute::FillGradientAttribute aGradient,

                const Primitive3DContainer& rChildren,

                const basegfx::B2DVector& rTextureSize,

                bool bModulate,

                bool bFilter);

            /// data read access

            const attribute::FillGradientAttribute& getGradient() const { return maGradient; }

            /// compare operator

            virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;

            /// provide unique ID

            DeclPrimitive3DIDBlock()

        };

} // end of namespace drawinglayer::primitive3d

namespace drawinglayer::primitive3d

    {

        /** BitmapTexturePrimitive3D class

            This 3D primitive expands TexturePrimitive3D to a bitmap texture

            definition. All 3D primitives embedded here will be shown with the

            defined bitmap (maybe tiled if defined).

         */

        class BitmapTexturePrimitive3D final : public TexturePrimitive3D

        {

        private:

            /// bitmap fill attribute

            attribute::FillGraphicAttribute     maFillGraphicAttribute;

        public:

            /// constructor

            BitmapTexturePrimitive3D(

                const attribute::FillGraphicAttribute& rFillGraphicAttribute,

                const Primitive3DContainer& rChildren,

                const basegfx::B2DVector& rTextureSize,

                bool bModulate,

                bool bFilter);

            /// data read access

            const attribute::FillGraphicAttribute& getFillGraphicAttribute() const { return maFillGraphicAttribute; }

            /// compare operator

            virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;

            /// provide unique ID

            DeclPrimitive3DIDBlock()

        };

} // end of namespace drawinglayer::primitive3d

namespace drawinglayer::primitive3d

    {

        /** TransparenceTexturePrimitive3D class

            This 3D primitive expands TexturePrimitive3D to a transparence texture

            definition. For transparence definition, a gradient is used. The values in

            that gradient will be interpreted as luminance Transparence-Values. All 3D

            primitives embedded here will be shown with the defined transparence.

         */

        class TransparenceTexturePrimitive3D final : public GradientTexturePrimitive3D

        {

        public:

            /// constructor

            TransparenceTexturePrimitive3D(

                const attribute::FillGradientAttribute& rGradient,

                const Primitive3DContainer& rChildren,

                const basegfx::B2DVector& rTextureSize);

            /// compare operator

            virtual bool operator==(const BasePrimitive3D& rPrimitive) const override;

            /// provide unique ID

            DeclPrimitive3DIDBlock()

        };

} // end of namespace drawinglayer::primitive3d

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