invalidationlevel.h 4.2 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
#ifndef INVALIDATIONLEVEL_H__
#define INVALIDATIONLEVEL_H__

schultezub's avatar
schultezub committed
33
namespace campvis {
schultezub's avatar
schultezub committed
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

    /**
     * Wrapper class for enum-int-based invalidation levels
     * Invalidation Level will internally be stored in an integer, the named levels define the bit mask.
     * All Accessor methods correctly apply the bitmasks.
     */
    struct InvalidationLevel {
    public:
        /**
         * Available invalidation levels
         */
        enum NamedLevels {
            VALID               = 0,
            INVALID_RESULT      = 1 << 0,
            INVALID_SHADER      = 1 << 1,
49
            INVALID_FILE        = 1 << 2,
schultezub's avatar
schultezub committed
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
        };

        /**
         * Creates a new invalidation level.
         * \param defaultLevel  Initial invalidation level
         */
        InvalidationLevel(int defaultLevel = VALID) {
            _level = static_cast<int>(defaultLevel);
        }

        /**
         * Returns the invalidation level
         * \return _level
         */
        int getLevel() const {
            return _level;
        }

        /**
         * Returns wheter the invalidation level is valid.
         * \return _level == VALID
         */
        bool isValid() const {
            return _level == static_cast<int>(VALID);
        }

        bool isInvalidResult() const {
schultezub's avatar
schultezub committed
77
            return (_level & static_cast<int>(INVALID_RESULT)) != 0;
schultezub's avatar
schultezub committed
78
79
80
        }

        bool isInvalidShader() const {
schultezub's avatar
schultezub committed
81
            return (_level & static_cast<int>(INVALID_SHADER)) != 0;
schultezub's avatar
schultezub committed
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
        }


        void setValid() {
            _level = static_cast<int>(VALID);
        }

        /**
         * Update the invalidation level by \a level.
         * If \a level is VALID, the invalidation level will be set to VALID.
         * If \a level is one of the INVALID_X state, the corresponding flag will be set.
         * \param level     Invalidation level to apply.
         */
        void setLevel(int level) {
            if (level == static_cast<int>(VALID)) {
                _level = level;
            }
            else {
                _level |= static_cast<int>(level);
            }        
        }

        void setLevel(NamedLevels nl) {
            setLevel(static_cast<int>(nl));
        }

        void setLevel(InvalidationLevel il) {
            setLevel(il._level);
        }

    private:
        int _level;
    };

}

#endif // INVALIDATIONLEVEL_H__