StatusAttrib.hh 12.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
/*===========================================================================*\
 *                                                                           *
 *                            OpenVolumeMesh                                 *
 *        Copyright (C) 2011 by Computer Graphics Group, RWTH Aachen         *
 *                        www.openvolumemesh.org                             *
 *                                                                           *
 *---------------------------------------------------------------------------*
 *  This file is part of OpenVolumeMesh.                                     *
 *                                                                           *
 *  OpenVolumeMesh is free software: you can redistribute it and/or modify   *
 *  it under the terms of the GNU Lesser General Public License as           *
 *  published by the Free Software Foundation, either version 3 of           *
 *  the License, or (at your option) any later version with the              *
 *  following exceptions:                                                    *
 *                                                                           *
 *  If other files instantiate templates or use macros                       *
 *  or inline functions from this file, or you compile this file and         *
 *  link it with other files to produce an executable, this file does        *
 *  not by itself cause the resulting executable to be covered by the        *
 *  GNU Lesser General Public License. This exception does not however       *
 *  invalidate any other reasons why the executable file might be            *
 *  covered by the GNU Lesser General Public License.                        *
 *                                                                           *
 *  OpenVolumeMesh is distributed in the hope that it will be useful,        *
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of           *
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the            *
 *  GNU Lesser General Public License for more details.                      *
 *                                                                           *
 *  You should have received a copy of the GNU LesserGeneral Public          *
 *  License along with OpenVolumeMesh.  If not,                              *
 *  see <http://www.gnu.org/licenses/>.                                      *
 *                                                                           *
\*===========================================================================*/

/*===========================================================================*\
 *                                                                           *
 *   $Revision$                                                         *
 *   $Date$                    *
 *   $LastChangedBy$                                                *
 *                                                                           *
\*===========================================================================*/

#ifndef STATUSATTRIB_HH_
#define STATUSATTRIB_HH_

#include <cassert>

48
#include "../Core/OpenVolumeMeshProperty.hh"
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
#include "../Core/OpenVolumeMeshHandle.hh"
#include "OpenVolumeMeshStatus.hh"
#include "../Core/PropertyDefines.hh"

namespace OpenVolumeMesh {

// Forward declaration
class TopologyKernel;

class StatusAttrib {
public:
    explicit StatusAttrib(TopologyKernel& _kernel);
    ~StatusAttrib();

    const OpenVolumeMeshStatus& operator[](const VertexHandle& _h) const {
64
        return v_status_[_h];
65 66 67
    }

    OpenVolumeMeshStatus& operator[](const VertexHandle& _h) {
68
        return v_status_[_h];
69 70 71
    }

    const OpenVolumeMeshStatus& operator[](const EdgeHandle& _h) const {
72
        return e_status_[_h];
73 74 75
    }

    OpenVolumeMeshStatus& operator[](const EdgeHandle& _h) {
76
        return e_status_[_h];
77 78 79
    }

    const OpenVolumeMeshStatus& operator[](const HalfEdgeHandle& _h) const {
80
        return he_status_[_h];
81 82 83
    }

    OpenVolumeMeshStatus& operator[](const HalfEdgeHandle& _h) {
84
        return he_status_[_h];
85 86 87
    }

    const OpenVolumeMeshStatus& operator[](const FaceHandle& _h) const {
88
        return f_status_[_h];
89 90 91
    }

    OpenVolumeMeshStatus& operator[](const FaceHandle& _h) {
92
        return f_status_[_h];
93 94 95
    }

    const OpenVolumeMeshStatus& operator[](const HalfFaceHandle& _h) const {
96
        return hf_status_[_h];
97 98 99
    }

    OpenVolumeMeshStatus& operator[](const HalfFaceHandle& _h) {
100
        return hf_status_[_h];
101 102 103
    }

    const OpenVolumeMeshStatus& operator[](const CellHandle& _h) const {
104
        return c_status_[_h];
105 106 107
    }

    OpenVolumeMeshStatus& operator[](const CellHandle& _h) {
108
        return c_status_[_h];
109 110 111
    }

    const OpenVolumeMeshStatus& mesh_status() const {
112
        MeshHandle h(0);
113
        return m_status_[h];
114 115 116
    }

    OpenVolumeMeshStatus& mesh_status() {
117
        MeshHandle h(0);
118
        return m_status_[h];
119 120
    }

Mike Kremer's avatar
Mike Kremer committed
121 122 123 124 125 126 127 128 129 130 131 132 133
    typedef VertexPropertyT<OpenVolumeMeshStatus>::const_iterator   const_vstatus_iterator;
    typedef VertexPropertyT<OpenVolumeMeshStatus>::iterator         vstatus_iterator;
    typedef EdgePropertyT<OpenVolumeMeshStatus>::const_iterator     const_estatus_iterator;
    typedef EdgePropertyT<OpenVolumeMeshStatus>::iterator           estatus_iterator;
    typedef HalfEdgePropertyT<OpenVolumeMeshStatus>::const_iterator const_hestatus_iterator;
    typedef HalfEdgePropertyT<OpenVolumeMeshStatus>::iterator       hestatus_iterator;
    typedef FacePropertyT<OpenVolumeMeshStatus>::const_iterator     const_fstatus_iterator;
    typedef FacePropertyT<OpenVolumeMeshStatus>::iterator           fstatus_iterator;
    typedef HalfFacePropertyT<OpenVolumeMeshStatus>::const_iterator const_hfstatus_iterator;
    typedef HalfFacePropertyT<OpenVolumeMeshStatus>::iterator       hfstatus_iterator;
    typedef CellPropertyT<OpenVolumeMeshStatus>::const_iterator     const_cstatus_iterator;
    typedef CellPropertyT<OpenVolumeMeshStatus>::iterator           cstatus_iterator;

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    // Iterator access
    VertexPropertyT<OpenVolumeMeshStatus>::const_iterator vstatus_begin() const {
        return v_status_.begin();
    }
    VertexPropertyT<OpenVolumeMeshStatus>::iterator vstatus_begin() {
        return v_status_.begin();
    }
    VertexPropertyT<OpenVolumeMeshStatus>::const_iterator vstatus_end() const {
        return v_status_.end();
    }
    VertexPropertyT<OpenVolumeMeshStatus>::iterator vstatus_end() {
        return v_status_.end();
    }

    EdgePropertyT<OpenVolumeMeshStatus>::const_iterator estatus_begin() const {
        return e_status_.begin();
    }
    EdgePropertyT<OpenVolumeMeshStatus>::iterator estatus_begin() {
        return e_status_.begin();
    }
    EdgePropertyT<OpenVolumeMeshStatus>::const_iterator estatus_end() const {
        return e_status_.end();
    }
    EdgePropertyT<OpenVolumeMeshStatus>::iterator estatus_end() {
        return e_status_.end();
    }

    HalfEdgePropertyT<OpenVolumeMeshStatus>::const_iterator hestatus_begin() const {
        return he_status_.begin();
    }
    HalfEdgePropertyT<OpenVolumeMeshStatus>::iterator hestatus_begin() {
        return he_status_.begin();
    }
    HalfEdgePropertyT<OpenVolumeMeshStatus>::const_iterator hestatus_end() const {
        return he_status_.end();
    }
    HalfEdgePropertyT<OpenVolumeMeshStatus>::iterator hestatus_end() {
        return he_status_.end();
    }

    FacePropertyT<OpenVolumeMeshStatus>::const_iterator fstatus_begin() const {
        return f_status_.begin();
    }
    FacePropertyT<OpenVolumeMeshStatus>::iterator fstatus_begin() {
        return f_status_.begin();
    }
    FacePropertyT<OpenVolumeMeshStatus>::const_iterator fstatus_end() const {
        return f_status_.end();
    }
    FacePropertyT<OpenVolumeMeshStatus>::iterator fstatus_end() {
        return f_status_.end();
    }

    HalfFacePropertyT<OpenVolumeMeshStatus>::const_iterator hfstatus_begin() const {
        return hf_status_.begin();
    }
    HalfFacePropertyT<OpenVolumeMeshStatus>::iterator hfstatus_begin() {
        return hf_status_.begin();
    }
    HalfFacePropertyT<OpenVolumeMeshStatus>::const_iterator hfstatus_end() const {
        return hf_status_.end();
    }
    HalfFacePropertyT<OpenVolumeMeshStatus>::iterator hfstatus_end() {
        return hf_status_.end();
    }

    CellPropertyT<OpenVolumeMeshStatus>::const_iterator cstatus_begin() const {
        return c_status_.begin();
    }
    CellPropertyT<OpenVolumeMeshStatus>::iterator cstatus_begin() {
        return c_status_.begin();
    }
    CellPropertyT<OpenVolumeMeshStatus>::const_iterator cstatus_end() const {
        return c_status_.end();
    }
    CellPropertyT<OpenVolumeMeshStatus>::iterator cstatus_end() {
        return c_status_.end();
    }

213 214 215 216 217 218 219 220 221 222 223 224
    /**
     * \brief Delete all entities that have been marked as deleted
     *
     * This function deletes all entities that have been marked as deleted.
     * It proceeds bottom-up, starting with the vertices. All higher
     * dimensional entities that are incident to a deleted entity are
     * automatically marked deleted, too. Once this first pass is through,
     * one can additionally delete all resulting non-manifold configurations
     * in a second pass (triggered by the parameter of this function).
     * This step proceeds as follows: Delete all n-dimensional entities
     * (starting with n = 2), that are not incident to at least one
     * entity of dimension n + 1. Note that the second pass requires bottom-up
225
     * incidences to be available. Compute them by calling update_incidences().
226 227 228 229 230
     *
     * @param _preserveManifoldness Pass true if the mesh is required to stay three-manifold
     */
    void garbage_collection(bool _preserveManifoldness = false);

231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
    /**
     * \brief garbage collection with handle tracking
     *
     * This function deletes all entities that have been marked as deleted.
     * It proceeds bottom-up, starting with the vertices. All higher
     * dimensional entities that are incident to a deleted entity are
     * automatically marked deleted, too. Once this first pass is through,
     * one can additionally delete all resulting non-manifold configurations
     * in a second pass (triggered by the parameter of this function).
     * This step proceeds as follows: Delete all n-dimensional entities
     * (starting with n = 2), that are not incident to at least one
     * entity of dimension n + 1. Note that the second pass requires bottom-up
     * incidences to be available. Compute them by calling update_incidences().
     *
     * \note Garbage collection invalidates all handles. If you need to keep track of
     *       a set of handles, you can pass them to this function. The handles that the
     *       given pointers point to are updated in place.
     *
     * @param vh_to_update Pointers to vertex handles that should get updated
     * @param hh_to_update Pointers to halfedge handles that should get updated
     * @param hfh_to_update Pointers to halfface handles that should get updated
     * @param ch_to_update Pointers to cell handles that should get updated
     * @param _preserveManifoldness Pass true if the mesh is required to stay three-manifold
     */
    template<typename std_API_Container_VHandlePointer,
             typename std_API_Container_HHandlePointer,
             typename std_API_Container_HFHandlePointer,
             typename std_API_Container_CHandlePointer>
    void garbage_collection(
        std_API_Container_VHandlePointer& vh_to_update,
        std_API_Container_HHandlePointer& hh_to_update,
        std_API_Container_HFHandlePointer& hfh_to_update,
        std_API_Container_CHandlePointer& ch_to_update,
        bool _preserveManifoldness = false);

266 267
private:

268 269
    void mark_higher_dim_entities();

270 271 272 273 274 275 276 277 278 279 280 281 282
    TopologyKernel& kernel_;

    VertexPropertyT<OpenVolumeMeshStatus> v_status_;
    EdgePropertyT<OpenVolumeMeshStatus> e_status_;
    HalfEdgePropertyT<OpenVolumeMeshStatus> he_status_;
    FacePropertyT<OpenVolumeMeshStatus> f_status_;
    HalfFacePropertyT<OpenVolumeMeshStatus> hf_status_;
    CellPropertyT<OpenVolumeMeshStatus> c_status_;
    MeshPropertyT<OpenVolumeMeshStatus> m_status_;
};

} // Namespace OpenVolumeMesh

283
#if defined(INCLUDE_TEMPLATES) && !defined(STATUSATTRIBT_CC)
284
#include "StatusAttribT_impl.hh"
285 286
#endif

287
#endif /* STATUSATTRIB_HH_ */