laoraycaster.h 4.12 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
102
103
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
// If not explicitly stated otherwise: Copyright (C) 2012-2015, all rights reserved,
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
// 
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
// Licensed 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
// 
// Unless required by applicable law or agreed to in writing, software distributed under the 
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, 
// either express or implied. See the License for the specific language governing permissions 
// and limitations under the License.
// 
// ================================================================================================

#ifndef LAORAYCASTER_H__
#define LAORAYCASTER_H__

#include "core/pipeline/raycastingprocessor.h"
#include "core/properties/floatingpointproperty.h"
#include "core/properties/genericproperty.h"
#include "core/properties/transferfunctionproperty.h"

#include "modules/modulesapi.h"

#include <string>

namespace cgt {
    class Shader;
}

namespace campvis {
    /**
     * TODO
     */
    class CAMPVIS_MODULES_API LAORaycaster : public RaycastingProcessor {
    public:
        /**
         * Constructs a new SimpleRaycaster Processor
         **/
        explicit LAORaycaster(IVec2Property* viewportSizeProp);

        /**
         * Destructor
         **/
        virtual ~LAORaycaster();

        /** 
         * To be used in ProcessorFactory static methods
         */
        static const std::string getId() { return "LAORaycaster"; };
        /// \see AbstractProcessor::getName()
        virtual const std::string getName() const { return getId(); };
        /// \see AbstractProcessor::getDescription()
        virtual const std::string getDescription() const { return "Raycaster using Local Ambient Occlusion for gradient-free shading and emissive effects."; };
        /// \see AbstractProcessor::getAuthor()
        virtual const std::string getAuthor() const { return "Jakob Weiss <jakob.weiss@tum.de>"; };
        /// \see AbstractProcessor::getProcessorState()
        virtual ProcessorState getProcessorState() const { return AbstractProcessor::TESTING; };

        /// \see AbstractProcessor::init
        virtual void init();
        /// \see AbstractProcessor::deinit
        virtual void deinit();

        BoolProperty p_enableShading;               ///< Flag whether to enable shading
        IntProperty  p_aoRays;                      ///< Number of directional AO samples
        IntProperty  p_aoSamples;                   ///< Number of steps per directional sample
        FloatProperty p_aoSphereRadius;             ///< The AO Sphere radius in voxels
        FloatProperty p_aoEffectGamma;              ///< Gamma controls the strength of the AO effect
        FloatProperty p_aoOpacityScale;             ///< Scales opacity when sampling for AO rays

        TransferFunctionProperty p_aoEmissiveTransferFunction;
        FloatProperty p_aoEmissiveScale;            ///< Scales the emissive color to increase/decrease the emissive effect

        DataNameProperty p_lightId;                 ///< Name/ID for the LightSource to use

        DataNameProperty p_quadGeometry;

    protected:
        /// \see AbstractProcessor::updateProperties()
        virtual void updateProperties(DataContainer& dataContainer);

        /// \see RaycastingProcessor::processImpl()
        virtual void processImpl(DataContainer& data, ImageRepresentationGL::ScopedRepresentation& image);

        /// \see RaycastingProcessor::generateHeader()
        virtual std::string generateHeader() const;

        static const std::string loggerCat_;
    };
}

#endif // LAORAYCASTER_H__