tfgeometry1d.h 5.4 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
    class FaceGeometry;
43
44
45

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

            float _position;
            tgt::col4 _color;
        };

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

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

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

77
78
79
80
81
        /**
         * Returns the vector of KeyPoints.
         * \return 
         */
        std::vector<KeyPoint>& getKeyPoints();
82
        
83
        /**
84
85
86
87
         * 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.
88
         */
89
        void renderIntoEditor() const;
90

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

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

102
103
104
105
106
107
        /**
         * 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
108
         * \return  A TFGeometry1D modelling a quad with two KeyPoints.
109
         */
schultezub's avatar
schultezub committed
110
        static TFGeometry1D* createQuad(const tgt::vec2& interval, const tgt::col4& leftColor, const tgt::vec4& rightColor);
111
112
113
    protected:

        std::vector<KeyPoint> _keyPoints;       ///< vector of KeyPoints, KeyPoints are sorted by x-coordinate of the position
114
115
        FaceGeometry* _tfRenderFace;            ///< FaceGeometry used to render TF into the TF texture
        FaceGeometry* _tfEditorFace;            ///< FaceGeometry used to render TF into editor window
116
117
118
119
120
121
122
123
124
125
    };

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

    /**
     * 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
126
    bool operator< (const TFGeometry1D::KeyPoint& left, const TFGeometry1D::KeyPoint& right);
127
128
129

}

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