create/src/Mod/Fem/Gui/ViewProviderFemMesh.h

/***************************************************************************
 *   Copyright (c) 2013 Jürgen Riegel <FreeCAD@juergen-riegel.net>         *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef FEM_VIEWPROVIDERFEMMESH_H
#define FEM_VIEWPROVIDERFEMMESH_H

#include <Gui/ViewProviderBuilder.h>
#include <Gui/ViewProviderGeometryObject.h>
#include <Gui/ViewProviderFeaturePython.h>
#include <Gui/ViewProviderSuppressibleExtension.h>
#include <Mod/Fem/FemGlobal.h>

class SoCoordinate3;
class SoDrawStyle;
class SoIndexedFaceSet;
class SoIndexedLineSet;
class SoShapeHints;
class SoMaterialBinding;

namespace FemGui
{

class ViewProviderFEMMeshBuilder: public Gui::ViewProviderBuilder
{
public:
    ViewProviderFEMMeshBuilder() = default;
    ~ViewProviderFEMMeshBuilder() override = default;
    void buildNodes(const App::Property*, std::vector<SoNode*>&) const override;
    void createMesh(const App::Property*,
                    SoCoordinate3*,
                    SoIndexedFaceSet*,
                    SoIndexedLineSet*,
                    std::vector<unsigned long>&,
                    std::vector<unsigned long>&,
                    bool& edgeOnly,
                    bool ShowInner,
                    int MaxFacesShowInner) const;
};

class FemGuiExport ViewProviderFemMesh: public Gui::ViewProviderGeometryObject
{
    PROPERTY_HEADER_WITH_OVERRIDE(FemGui::ViewProviderFemMesh);

public:
    /// constructor.
    ViewProviderFemMesh();

    /// destructor.
    ~ViewProviderFemMesh() override;

    // Display properties
    App::PropertyColor PointColor;
    App::PropertyFloatConstraint PointSize;
    App::PropertyFloatConstraint LineWidth;
    App::PropertyBool BackfaceCulling;
    App::PropertyBool ShowInner;
    App::PropertyInteger MaxFacesShowInner;
    App::PropertyEnumeration ColorMode;
    App::PropertyColorList NodeColorArray;
    App::PropertyColorList ElementColorArray;

    void attach(App::DocumentObject* pcObject) override;
    void setDisplayMode(const char* ModeName) override;
    std::vector<std::string> getDisplayModes() const override;
    void updateData(const App::Property*) override;

    /** @name Selection handling
     * This group of methods do the selection handling.
     * Here you can define how the selection for your ViewProvider
     * works.
     */
    //@{
    /// indicates if the ViewProvider use the new Selection model
    bool useNewSelectionModel() const override
    {
        return true;
    }
    /// return a hit element to the selection path or 0
    std::string getElement(const SoDetail*) const override;
    SoDetail* getDetail(const char*) const override;
    /// return the highlight lines for a given element or the whole shape
    std::vector<Base::Vector3d> getSelectionShape(const char* Element) const override;
    //@}

    // interface methods
    void setHighlightNodes(const std::set<long>&);
    std::set<long> getHighlightNodes() const;
    void resetHighlightNodes();

    /** @name Postprocessing
     * this interfaces apply post processing stuff to the View-
     * Provider. They can override the positioning and the color
     * color or certain elements.
     */
    //@{

    /// set the color for each node
    void setColorByNodeId(const std::map<std::vector<long>, Base::Color>& NodeColorMap);
    void setColorByNodeId(const std::vector<long>& NodeIds,
                          const std::vector<Base::Color>& NodeColors);

    /// reset the view of the node colors
    void resetColorByNodeId();
    /// set the displacement for each node
    void setDisplacementByNodeId(const std::map<long, Base::Vector3d>& NodeDispMap);
    void setDisplacementByNodeId(const std::vector<long>& NodeIds,
                                 const std::vector<Base::Vector3d>& NodeDisps);
    /// reset the view of the node displacement
    void resetDisplacementByNodeId();
    /// reaply the node displacement with a certain factor and do a redraw
    void applyDisplacementToNodes(double factor);
    /// set the color for each element
    void setColorByElementId(const std::map<std::vector<long>, Base::Color>& ElementColorMap);
    /// reset the view of the element colors
    void resetColorByElementId();
    void setMaterialByElement();
    //@}

    const std::vector<unsigned long>& getVisibleElementFaces() const
    {
        return vFaceElementIdx;
    }

    PyObject* getPyObject() override;

private:
    static App::PropertyFloatConstraint::Constraints floatRange;
    static const char* colorModeEnum[];
    Gui::ViewProviderSuppressibleExtension suppressibleExt;

protected:
    /// get called by the container whenever a property has been changed
    void onChanged(const App::Property* prop) override;

    void setColorByNodeIdHelper(const std::vector<Base::Color>&);
    void setDisplacementByNodeIdHelper(const std::vector<Base::Vector3d>& DispVector, long startId);
    void setColorByIdHelper(const std::map<std::vector<long>, Base::Color>& elemColorMap,
                            const std::vector<unsigned long>& vElementIdx,
                            int rShift,
                            App::PropertyColorList& prop);
    void setMaterialByColorArray(const App::PropertyColorList* prop,
                                 const std::vector<unsigned long>& vElementIdx) const;
    void setMaterialOverall() const;

    /// index of elements to their triangles
    std::vector<unsigned long> vFaceElementIdx;
    std::vector<unsigned long> vNodeElementIdx;
    std::vector<unsigned long> vHighlightedIdx;
    std::vector<Base::Vector3d> DisplacementVector;
    double DisplacementFactor;

    SoMaterial* pcPointMaterial;
    SoDrawStyle* pcPointStyle;

    SoDrawStyle* pcDrawStyle;
    SoShapeHints* pShapeHints;
    SoMaterialBinding* pcMatBinding;
    SoCoordinate3* pcCoords;
    SoCoordinate3* pcAnoCoords;
    SoIndexedFaceSet* pcFaces;
    SoIndexedLineSet* pcLines;

    bool onlyEdges;

private:
    class Private;
};

using ViewProviderFemMeshPython = Gui::ViewProviderFeaturePythonT<ViewProviderFemMesh>;


}  // namespace FemGui


#endif  // FEM_VIEWPROVIDERFEMMESH_H