WireTool.h

Go to the documentation of this file.

#pragma once

#pragma warning(push)
#pragma warning(disable : 4100)
#pragma warning(disable : 4005)

#include <Geom/Dir.h>
#include <Geom/Pln.h>
#include <Geom/Pnt.h>
#include <Geom/Precision.h>
#include <Topo/Shape.h>
#include <Topo/topo_defines.h>

#pragma warning(pop)

namespace Topo
{
class TOPO_EXPORT WireTool
{
public:
    //                                                       //
    // --------------------- BEGIN API --------------------- //
    //                                                       //
    // ATTENTION: DO NOT CHANGE ANY SIGNATURES IN THE API !  //
    //                                                       //

    static pWire projectWireOnPlane(const Geom::Pln& pln, pConstWire wire, double precision = Geom::Precision::linear_Resolution());
    static bool projectPointOnWire(const Geom::Pnt& p, pConstWire wire, Geom::Pnt& nearest);
    static bool projectPointOnWire(const Geom::Pnt& p, pConstWire wire, Geom::Pnt& nearest, Geom::Dir& refDirection);
    static bool isPlanar(pConstWire wire, Geom::Pln& plane);
    static bool isClosed(pConstWire wire);
    static bool close(pWire wire, double precision = Geom::Precision::linear_Resolution());
    static pWire closed(pConstWire wire, double precision = Geom::Precision::linear_Resolution());
    static bool addEdge(pWire wire, pEdge edge, double precision = Geom::Precision::linear_Resolution());
    static bool addEdge(pWire wire, const std::vector<pEdge>& edges, double precision = Geom::Precision::linear_Resolution());
    static bool addConstEdge(pWire wire, pConstEdge edge, double precision = Geom::Precision::linear_Resolution());
    static bool addConstEdge(pWire wire, const std::vector<pEdge>& edges, double precision = Geom::Precision::linear_Resolution());
    static pWire addedEdge(pConstWire wire, pConstEdge edge, double precision = Geom::Precision::linear_Resolution());
    static pWire addedEdge(pConstWire wire, const std::vector<pConstEdge>& edges, double precision = Geom::Precision::linear_Resolution());
    static pConstVertex getClosestVertexToPoint(const Geom::Pnt& p, pConstWire wire);
    static std::vector<pConstEdge> getClosestEdgesToPoint(const Geom::Pnt& p, pConstWire wire, double& distance, double tolerance = 1E-06);
    static std::vector<pConstEdge> getAdjacentEdgesToVertexOnWire(pConstVertex vertex, pConstWire wire);
    static void getAdjacentEdgesToPointOnWire(const Geom::Pnt& point, pConstWire wire, std::vector<pConstEdge>& adjacentEdges);
    static pWire makeWire(const std::vector<pEdge>& edges, double precision = Geom::Precision::linear_Resolution());
    static pWire makeWire(pEdge edges);
    static pWire makeWire(pConstVertex vertex);
    static std::vector<pWire> makeWires(const std::vector<pEdge>& edges, double precision = Geom::Precision::linear_Resolution());
    static pWire copy(pConstWire wire);
    static pWire makePolygon(const std::vector<Geom::Pnt>& points);
    static pWire makePolyline(const std::vector<Geom::Pnt>& points);
    static std::vector<pConstEdge> getEdges(pConstWire wire);
    static std::vector<pEdge> getEdgesCopy(pConstWire wire);
    static std::vector<pConstVertex> getVertices(pConstWire wire);
    static void getPoints(pConstWire wire, std::vector<Geom::Pnt>& pnts);
    static bool hasOnlyLines(pConstWire wire);
    static bool hasHelix(pConstWire wire);
    static bool fixReorder(pWire wire);
    static void writeDbgInfo(pConstWire wire);
    static Geom::Pnt getCentre(pConstWire wire);
    static bool filletWireAtVertex(pWire wire, const Geom::Pnt& p, double radius, double precision = Geom::Precision::linear_Resolution());
    static bool chamferWireAtVertex(pWire wire, const Geom::Pnt& p, double offset, double precision = Geom::Precision::linear_Resolution());
    static bool removeEdgesFromWire(pWire wire,
                                    std::vector<pConstEdge> edges,
                                    double precision = Geom::Precision::linear_Resolution(),
                                    bool stayInBndBox = false);
    static pWire transformed(pConstWire base, const Geom::Trsf& t);
    static bool isSelfIntersecting(pConstWire wire);
    static pWire createOffset(pConstWire wire, const Geom::Dir& refDirection, double offset);
    static pWire reversed(pConstWire wire);
    static pWire joined(pConstWire wire1, pConstWire wire2);

    //                                                       //
    // ---------------------- END API ---------------------- //
    //                                                       //

#ifndef LXAPI  // INTERFACES BELOW ARE -NOT- PART OF THE LEXOCAD API

    static void __setDefaultWireTool__(Topo::WireTool* tool) { _defaultTool = tool; }
    static pWire reverseWirePointsConnection(pConstWire wire, double precision = Geom::Precision::linear_Resolution());
    static pWire
    combineWireWithWire(pConstWire hWire, pConstWire vWire, const uint& x, const uint& y, const uint& z, const double& start, const double& end);

protected:
    virtual pWire _projectWireOnPlane(const Geom::Pln& pln, pConstWire wire, double precision);
    virtual bool _projectPointOnWire(const Geom::Pnt& p, pConstWire wire, Geom::Pnt& nearest);
    virtual bool _projectPointOnWire(const Geom::Pnt& p, pConstWire wire, Geom::Pnt& nearest, Geom::Dir& refDirection);
    virtual bool _isPlanar(pConstWire wire, Geom::Pln& plane);
    virtual bool _isClosed(pConstWire wire);
    virtual pWire _closed(pConstWire wire, double precision);
    virtual pWire _addedEdge(pConstWire wire, pConstEdge edge, double precision);
    virtual pWire _addedEdge(pConstWire wire, const std::vector<pConstEdge>& edges, double precision);
    virtual pConstVertex _getClosestVertexToPoint(const Geom::Pnt& p, pConstWire wire);
    virtual std::vector<pConstEdge> _getClosestEdgesToPoint(const Geom::Pnt& p, pConstWire wire, double& distance, double precision = 1E-06);
    virtual std::vector<pConstEdge> _getAdjacentEdgesToVertexOnWire(pConstVertex vertex, pConstWire wire);
    virtual void _getAdjacentEdgesToPointOnWire(const Geom::Pnt& point, pConstWire wire, std::vector<pConstEdge>& adjacentEdges);
    virtual pWire _makeWire(const std::vector<pEdge>& edges, double precision);
    virtual pWire _makeWire(pConstVertex vertex);
    virtual std::vector<pWire> _makeWires(const std::vector<pEdge>& edges, double precision);
    virtual pWire _copy(pConstWire wire);
    virtual pWire _makePolygon(const std::vector<Geom::Pnt>& points);
    virtual pWire _makePolyline(const std::vector<Geom::Pnt>& points);
    virtual std::vector<pConstEdge> _getEdges(pConstWire wire);
    virtual std::vector<pConstVertex> _getVertices(pConstWire wire);
    virtual void _getPoints(pConstWire wire, std::vector<Geom::Pnt>& pnts);
    virtual pWire _reverseWirePointsConnection(pConstWire wire, double precision);
    virtual pWire _createOffset(pConstWire wire, const Geom::Dir& refDirection, double offset);
    virtual bool _fixReorder(pWire wire);
    virtual void _writeDbgInfo(pConstWire wire);
    virtual Geom::Pnt _getCentre(pConstWire wire);
    virtual bool _filletWireAtVertex(pWire wire, const Geom::Pnt& p, double radius, double precision);
    virtual bool _chamferWireAtVertex(pWire wire, const Geom::Pnt& p, double offset, double precision);
    virtual bool _removeEdgesFromWire(pWire wire, std::vector<pConstEdge> edges, double precision, bool stayInBndBox = false);
    virtual bool _isSelfIntersecting(pConstWire wire);
    virtual pWire _reversed(pConstWire wire);
    virtual pWire _joined(pConstWire wire1, pConstWire wire2);
    virtual pWire
    _combineWireWithWire(pConstWire hWire, pConstWire vWire, const uint& x, const uint& y, const uint& z, const double& start, const double& end);
    static Topo::WireTool* _defaultTool;
#endif
};

}  // namespace Topo