2.12.2021, 9:00 - 11:00: Due to updates GitLab may be unavailable for some minutes between 09:00 and 11:00.

abstractprocessordecorator.h 5.8 KB
Newer Older
1
2
// ================================================================================================
// 
schultezub's avatar
schultezub committed
3
// This file is part of the CAMPVis Software Framework.
4
5
// 
// If not explicitly stated otherwise: Copyright (C) 2012, all rights reserved,
schultezub's avatar
schultezub committed
6
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
7
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universität München
//      Boltzmannstr. 3, 85748 Garching b. München, Germany
schultezub's avatar
schultezub committed
10
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
// 
// The licensing of this softare is not yet resolved. Until then, redistribution in source or
// binary forms outside the CAMP chair is not permitted, unless explicitly stated in legal form.
// However, the names of the original authors and the above copyright notice must retain in its
// original state in any case.
// 
// Legal disclaimer provided by the BSD license:
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// 
// ================================================================================================

#ifndef ABSTRACTPROCESSORDECORATOR_H__
#define ABSTRACTPROCESSORDECORATOR_H__

#include <vector>
#include <string>

namespace tgt {
    class Shader;
}

schultezub's avatar
schultezub committed
40
namespace campvis {
41
42
43
44
45
46
47
48
49
50
51
52
53
    class DataContainer;
    class HasPropertyCollection;

    /**
     * Abstract base class for processor decorators.
     * ProcessorDecorators are created and assigned to a processor during its construction. The
     * virtual methods are then calles at an appropriate time.
     */
    class AbstractProcessorDecorator {
    public:
        /**
         * Pure virtual Destructor
         */
schultezub's avatar
schultezub committed
54
        virtual ~AbstractProcessorDecorator() {};
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

        /**
         * Gets called by the processor during initialization to let the decorator
         * add its properties to the processor.
         * \param   propCollection  PropertyCollection defining where to add the properties (usually the owning processor).
         */
        virtual void addProperties(HasPropertyCollection* propCollection);

        /**
         * Gets called by the processor with an active OpenGL context having \a shader activated before the
         * actual rendering takes place.
         * Here is the place to setup additional shader arguments (i.e. uniforms) or bind additional textures.
         * \param   dataContainer   The current processor's DataContainer
         * \param   shader          Shader object used during rendering.
         */
        virtual void renderProlog(const DataContainer& dataContainer, tgt::Shader* shader);

        /**
         * Gets called by the processor after the actual rendering took place.
         * Here is the place to clean up and deinit created resources.
         * \param   shader          Shader object used during rendering.
         */
        virtual void renderEpilog(tgt::Shader* shader);

        /**
         * Returns an additional header that will be linked into the fragment shader.
         * Gets calles when building the shader. Overwrite this method to add a decorator-specific header to
         * your fragment shader.
         * \return  The default implementation returns an empty string.
         */
        virtual std::string generateHeader() const;

    };

// ================================================================================================

    /**
     * Pure virtual base class for processors using decorators.
     */
    class HasProcessorDecorators {
    public:
        /**
         * Virtual Destructor, deletes all Decorators
         */
        virtual ~HasProcessorDecorators();

    protected:
102
103
104
105
        /**
         * Adds \a decorator to the list of processor decorators.
         * \param   decorator   Processor decorator to add
         */
106
107
        void addDecorator(AbstractProcessorDecorator* decorator);

108
109
110
111
        /**
         * Decorates \a propCollection with the properties of all held decorators.
         * \param   propCollection  PropertyCollection to decorate (usually your processor)
         */
112
113
        void decoratePropertyCollection(HasPropertyCollection* propCollection) const;

114
115
116
117
118
119
        /**
         * Calls renderProlog() on each held decorator.
         * To be called before rendering to decorate \a shader.
         * \param   dataContainer   DataContainer to work on
         * \param   shader          Shader to decorate
         */
120
121
        void decorateRenderProlog(const DataContainer& dataContainer, tgt::Shader* shader) const;

122
123
124
125
126
        /**
         * Calls renderProlog() on each held decorator.
         * To be called after rendering to decorate \a shader.
         * \param   shader          Shader to decorate
         */
127
128
        void decorateRenderEpilog(tgt::Shader* shader) const;

129
130
131
        /**
         * Concatenates and returns the GLSL headers of all held decorators.
         */
132
133
        std::string getDecoratedHeader() const;

134

135
136
137
138
139
140
        std::vector<AbstractProcessorDecorator*> _decorators;   ///< List of all processor decorators
    };

}

#endif // ABSTRACTPROCESSORDECORATOR_H__