Cell.h

Go to the documentation of this file.

/*****************************************************************************
 * $CAMITK_LICENCE_BEGIN$
 *
 * CamiTK - Computer Assisted Medical Intervention ToolKit
 * (c) 2001-2024 Univ. Grenoble Alpes, CNRS, Grenoble INP - UGA, TIMC, 38000 Grenoble, France
 *
 * Visit http://camitk.imag.fr for more information
 *
 * This file is part of CamiTK.
 *
 * CamiTK is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * CamiTK 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 version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with CamiTK.  If not, see <http://www.gnu.org/licenses/>.
 *
 * $CAMITK_LICENCE_END$
 ****************************************************************************/
 
#ifndef CELL_H
#define CELL_H
 
#include "Structure.h"
#include "StructuralComponent.h"
 
//pmlschema forward declarations
namespace physicalModel {
class Cell;
}
 
class CellProperties;
class Cell : public Structure, public StructuralComponent {
public:
    Cell(PhysicalModel* myPM, const StructureProperties::GeometricType t);
 
    Cell(PhysicalModel* myPM, physicalModel::Cell xmlCell, StructuralComponent* sc);
 
    Cell(PhysicalModel* myPM, const StructureProperties::GeometricType t, const unsigned int ind);
 
    ~Cell() override;
 
// as Cell inherits both Structure and StructuralComponent, it is correct to override
// the xmlPrint in StructuralComponent while reimplementing xmlPrint from Structure
#if defined(__has_warning)
#  pragma GCC diagnostic push
#  if __has_warning("-Woverloaded-virtual")
#     pragma GCC diagnostic ignored "-Woverloaded-virtual"
#  endif
#endif
    void xmlPrint(std::ostream&, const StructuralComponent*) override;
#if defined(__has_warning)
#  pragma GCC diagnostic pop
#endif
 
 
    bool isInstanceOf(const char*) const override;
 
    void deleteAllStructures() override;
 
    CellProperties* getProperties();
 
    StructuralComponent::ComposedBy composedBy() override;
 
    bool makePrintData(const StructuralComponent*);
 
    bool setIndex(const unsigned int) override;
 
    double* normal();
 
    StructuralComponent* getQuadFaces();
 
    StructuralComponent* getTriangleFaces();
 
    double surface();
 
    double volume();
 
    double signedVolumeTriangle(double p1[3], double p2[3], double p3[3]);
 
    const StructuralComponent* getParentSC() {
        return this->parentSC;
    }
 
    void addStructuralComponent(StructuralComponent*) override;
 
private:
    StructuralComponent* parentSC;
 
};
 
// ------- INLINE -----------
inline bool Cell::isInstanceOf(const char* className) const {
    return (std::string(className) == std::string("Cell"));
}
 
inline Cell::ComposedBy Cell::composedBy() {
    return StructuralComponent::ATOMS;
}
 
inline void Cell::addStructuralComponent(StructuralComponent* sc) {
    Structure::addStructuralComponent(sc);
    if (!parentSC) {
        parentSC = sc;
    }
}
 
#endif //CELL_H