lightsourceprovider.h 3.48 KB
Newer Older
1
2
3
4
// ================================================================================================
// 
// This file is part of the CAMPVis Software Framework.
// 
5
// If not explicitly stated otherwise: Copyright (C) 2012-2014, all rights reserved,
6
7
//      Christian Schulte zu Berge <christian.szb@in.tum.de>
//      Chair for Computer Aided Medical Procedures
8
9
//      Technische Universitaet Muenchen
//      Boltzmannstr. 3, 85748 Garching b. Muenchen, Germany
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
// 
// 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 LIGHTSOURCEPROVIDER_H__
#define LIGHTSOURCEPROVIDER_H__

#include <string>

#include "core/pipeline/abstractprocessor.h"
#include "core/properties/datanameproperty.h"
#include "core/properties/floatingpointproperty.h"

34
#include "modules/modulesapi.h"
35
#include "modules/processorfactory.h"
36

37
38
39
40
41
namespace campvis {
    /**
     * Creates LightSourceData and stores it in the DataContainer.
     * \see LightSourceData
     */
42
    class CAMPVIS_MODULES_API LightSourceProvider : public AbstractProcessor {
43
44
45
46
47
48
49
50
51
52
    public:
        /**
         * Constructs a new LightSourceProvider Processor.
         **/
        LightSourceProvider();

        /**
         * Destructor
         **/
        virtual ~LightSourceProvider();
53
54
55
56
57
        
        /** 
         * To be used in ProcessorFactory static methods
         */
        static const std::string getId() { return "LightSourceProvider"; };
58
        /// \see AbstractProcessor::getName()
59
        virtual const std::string getName() const { return getId(); };
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
        /// \see AbstractProcessor::getDescription()
        virtual const std::string getDescription() const { return "Creates LightSourceData and stores it in the DataContainer."; };
        /// \see AbstractProcessor::getAuthor()
        virtual const std::string getAuthor() const { return "Christian Schulte zu Berge <christian.szb@in.tum.de>"; };
        /// \see AbstractProcessor::getProcessorState()
        virtual ProcessorState getProcessorState() const { return AbstractProcessor::STABLE; };

        DataNameProperty p_lightId;         ///< Name/ID for the LightSource to create
        Vec3Property p_lightPosition;       ///< Light position
        Vec3Property p_ambientColor;        ///< Ambient light color
        Vec3Property p_diffuseColor;        ///< Diffuse light color
        Vec3Property p_specularColor;       ///< Specular light color
        FloatProperty p_shininess;          ///< Specular shininess
        Vec3Property p_attenuation;         ///< Attenuation factors

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

        static const std::string loggerCat_;
    };

82
    // Instantiate template to register the pipelines.
83
    template class SmartProcessorRegistrar<LightSourceProvider>;
84
85
86
}

#endif // LIGHTSOURCEPROVIDER_H__