metaproperty.h 2.72 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
// For a full list of authors and contributors, please refer to the file "AUTHORS.txt".
// 
13
14
15
16
// 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
17
// 
18
19
20
21
// 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.
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// 
// ================================================================================================

#ifndef METAPROPERTY_H__
#define METAPROPERTY_H__


#include "core/properties/abstractproperty.h"
#include "core/properties/propertycollection.h"

namespace campvis {
    /**
     * Property wrapping around a bunch of other properties.
     * Useful either for grouping properties or for wrapping around entire property collections.
36
37
38
39
40
     * 
     * \note    ATTENTION: Even though MetaProperty derives from HasPropertyCollection, it does 
     *                     neither take ownership of its wrapped properties, nor does is (de)initialize
     *                     or (un)lock them. This has to be done by the owners of the wrapped 
     *                     properties.
41
     */
42
    class CAMPVIS_CORE_API MetaProperty : public AbstractProperty, public HasPropertyCollection {
43
44
45
46
47
48
    public:
        /**
         * Creates a new MetaProperty
         * \param name      Property name (unchangable!)
         * \param title     Property title (e.g. used for GUI)
         */
49
        MetaProperty(const std::string& name, const std::string& title);
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

        /**
         * Virtual Destructor
         **/
        virtual ~MetaProperty();


        /// \see HasPropertyCollection::onPropertyChanged
        virtual void onPropertyChanged(const AbstractProperty* prop);

        /**
         * Adds all properties in \a pc to this meta property.
         * \param   pc  PropertyCollection to add
         */
        void addPropertyCollection(HasPropertyCollection& pc);

    protected:

        static const std::string loggerCat_;
    };

}

#endif // METAPROPERTY_H__