tfgeometry1d.h 5.17 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
// 
// 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
#ifndef TFGEOMETRY1D_H__
#define TFGEOMETRY1D_H__
32

33
#include "sigslot/sigslot.h"
34
35
36
37
38
39
40
#include "tgt/vector.h"
#include <vector>

namespace tgt {
    class Texture;
}

schultezub's avatar
schultezub committed
41
namespace campvis {
42
43
44

    /**
     * Defines a single shape for the GeometryTransferFunction class.
schultezub's avatar
schultezub committed
45
     * TFGeometry1D is defined by a sorted list of KeyPoints, each having a position and a color.
46
     */
schultezub's avatar
schultezub committed
47
    class TFGeometry1D {
48
49
    public:
        struct KeyPoint {
50
            explicit KeyPoint(float position, const tgt::col4& color)
51
52
53
54
55
56
57
58
59
                : _position(position)
                , _color(color)
            {};

            float _position;
            tgt::col4 _color;
        };

        /**
schultezub's avatar
schultezub committed
60
         * Creates a new TFGeometry1D
61
62
         * \param   Bounds  Bounds of the position of the geometry in texture coordinates.
         */
63
        explicit TFGeometry1D(const std::vector<KeyPoint>& keyPoints);
64
65
66
67

        /**
         * Virtual destructor
         */
schultezub's avatar
schultezub committed
68
        virtual ~TFGeometry1D();
69

70
71
72
73
74
75
        /**
         * Clones this transfer function geometry.
         * \return  A clone of this transfer function geometry, caller takes ownership of the pointer.
         */
        TFGeometry1D* clone() const;

76
77
78
79
80
        /**
         * Returns the vector of KeyPoints.
         * \return 
         */
        std::vector<KeyPoint>& getKeyPoints();
81
        
82
        /**
83
84
85
86
         * Renders this transfer function geometry to the current active OpenGL context for usage in editor.
         * \note    Must be called from an active and valid OpenGL context.
         * \todo    Check, whether this method really belongs here (core) or better fits into
         *          an other class in the application (GUI) module.
87
         */
88
        void renderIntoEditor() const;
89

90
91
92
        /**
         * Renders this transfer function geometry to the current active OpenGL context.
         * \note    Must be called from an active and valid OpenGL context.
93
94
         * \todo    Check, whether this method really belongs here (core) or better fits into
         *          an other class in the application (GUI) module.
95
96
97
         */
        void render() const;

98
99
100
        /// Signal to be emitted when this TF geometry has changed.
        sigslot::signal0<> s_changed;

101
102
103
104
105
106
        /**
         * Creates a simple quad geometry for the given interval.
         * A quad geometry consists of two KeyPoints.
         * \param   interval    Interval the geometry resides in
         * \param   leftColor   Color for left KeyPoint
         * \param   rightColor  Color for right KeyPoint
schultezub's avatar
schultezub committed
107
         * \return  A TFGeometry1D modelling a quad with two KeyPoints.
108
         */
schultezub's avatar
schultezub committed
109
        static TFGeometry1D* createQuad(const tgt::vec2& interval, const tgt::col4& leftColor, const tgt::vec4& rightColor);
110
111
112
113
114
115
116
117
118
119
120
121
122
    protected:

        std::vector<KeyPoint> _keyPoints;       ///< vector of KeyPoints, KeyPoints are sorted by x-coordinate of the position
    };

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

    /**
     * Less operator for sorting KeyPoints by their position.
     * \param   left    Left KeyPoint to compare
     * \param   right   RightKeyPoint to compare
     * \return  left._position < right._position
     */
schultezub's avatar
schultezub committed
123
    bool operator< (const TFGeometry1D::KeyPoint& left, const TFGeometry1D::KeyPoint& right);
124
125
126

}

schultezub's avatar
schultezub committed
127
#endif // TFGEOMETRY1D_H__