visualizationprocessor.h 3.35 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
8
9
//      Chair for Computer Aided Medical Procedures
//      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
// 
// 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.
// 
// ================================================================================================

schultezub's avatar
schultezub committed
30
31
32
33
34
#ifndef VISUALIZATIONPROCESSOR_H__
#define VISUALIZATIONPROCESSOR_H__

#include "tgt/vector.h"
#include "core/pipeline/abstractprocessor.h"
35
#include "core/properties/numericproperty.h"
schultezub's avatar
schultezub committed
36

schultezub's avatar
schultezub committed
37
namespace campvis {
schultezub's avatar
schultezub committed
38
39

    /**
40
41
42
43
44
45
     * Specialization of AbstractProcessor for visualization purposes.
     * VisualizationProcessors are required to be called by a VisualizationPipeline which ensure
     * to provide a valid OpenGL context when calling the processor's process() method. Hence, a
     * VisualizationProcessor is allowed/capable of performing OpenGl operations.
     * For determining the canvas/viewport size, a VisualizationProcessor gets a reference to the
     * parent pipeline's render target size property during instantiation.
schultezub's avatar
schultezub committed
46
     * 
47
     * \sa VisualizationPipeline
schultezub's avatar
schultezub committed
48
49
50
51
52
53
     */
    class VisualizationProcessor : public AbstractProcessor {
    public:

        /**
         * Creates a VisualizationProcessor.
54
55
56
         * \note    The render target size property of this VisualizationProcessor will automatically 
         *          be assigned as shared property of the given \a renderTargetSize property.
         * \param   renderTargetSize    Reference to the parent pipeline's render target size property.
schultezub's avatar
schultezub committed
57
         */
58
        VisualizationProcessor(IVec2Property& renderTargetSize);
schultezub's avatar
schultezub committed
59
60
61
62
63
64
65
66

        /**
         * Virtual Destructor
         **/
        virtual ~VisualizationProcessor();


    protected:
67
        IVec2Property _renderTargetSize;        ///< Viewport size of target canvas
schultezub's avatar
schultezub committed
68
69
70
71
72
    };

}

#endif // VISUALIZATIONPROCESSOR_H__