NurbsOptions.h

Go to the documentation of this file.

#pragma once

#include <Topo/Shape.h>

namespace Topo
{
class LX_TOPO_EXPORT NurbsOptions
{
protected:
    NurbsOptions() = default;
    virtual ~NurbsOptions() = default;
    virtual void init() = 0;
};

// SB - Acis options about skinning are a little bit "confused". There are different methods to skin wires, but not all methods accept all parameters,
// that's why I'm trying to make different classes, each one that fits only a particular method, with only the parameters that are taken into account.
class LX_TOPO_EXPORT SkinningOptions : public NurbsOptions
{
public:
    SkinningOptions(void) : NurbsOptions() {}
    virtual ~SkinningOptions(void) override = default;

    void setWiresU(const std::vector<pConstShape>& in) { setWires(_uWires, in); }
    void setWiresU(const std::vector<pConstWire>& in) { _uWires = in; }
    std::vector<pConstWire> getWiresU() const { return _uWires; }

    enum class ClosedMode
    {
        OPEN = 0,
        CLOSED = 1,
        LOOP = 2,
        SOLID = 3
    };
    void setClosedMode(const ClosedMode& mode) { _closedMode = mode; };
    ClosedMode getClosedMode() const { return _closedMode == ClosedMode::SOLID ? ClosedMode::OPEN : _closedMode; }

    void setSolid(const bool& solid) { _closedMode = solid ? ClosedMode::SOLID : ClosedMode::OPEN; }
    bool getSolid() const { return _closedMode == ClosedMode::SOLID; }

    void setUniformUV(const bool& uniform) { _arc_length = _arc_length_u = _merge_wirecoedges = uniform; }
    bool getArcLen() const { return _arc_length; }
    bool getArcLenU() const { return _arc_length_u; }
    bool getMerge() const { return _merge_wirecoedges; }

    // These values are intentionally "readonly", since it is not clear when it would be useful to alter them.
    bool getAllowUV() const { return _allow_same_uv; }
    bool getSelfIntersect() const { return _self_int_test; }
    bool getSimplify() const { return _simplify; }

protected:
    bool _allow_same_uv = true;  // SB 2011.12.16 - Very special case!
                                 // http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Surface_Checks#allow_same_uv_.28false.29
    bool _arc_length = true;     // SB 2013.05.07 - http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Surface_Parameterization
    bool _arc_length_u = true;
    bool _merge_wirecoedges = true;
    bool _self_int_test = false;  // SB 2012.06.05 - When FALSE allow creation of self-intersecting surfaces:
                                  // http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Surface_Checks#self_int_test_.281.29. No exception
                                  // is thrown, NURBS is created (probably rubbish) and "selfIntersect" property can be detected later.
    bool _simplify =
        false;  // SB 2012.06.14 - Leave to FALSE or ACIS will try to build a simpler surface (if possible). For example, if set to TRUE and the
                // surface is exactly a cylinder, ACIS will not make a NURBS but a cylinder and the "api_accurate_bs3_approximation" won't work! See
                // http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Simplification
    ClosedMode _closedMode = ClosedMode::OPEN;

    std::vector<pConstWire> _uWires = {};

    virtual void init() override = 0;

    // template <typename T> void setWires(std::vector<pConstWire> &u_or_vWires, T &in)
    //{
    //  u_or_vWires.clear();

    //  for (auto element_or_geometry : in)
    //  {
    //      if (auto wire = Topo::ShapeTool::isSingleWire(element_or_geometry->getShape())) // If an App::Element is passed, then its transformation is
    //taken into account. If an Core::DocObject is passed, it has to be transformed before (geometry does not carry transformation info)
    //          u_or_vWires.push_back(wire);
    //      if (auto face = Topo::ShapeTool::isSingleFace(element_or_geometry->getShape())) // If an App::Element is passed, then its transformation is
    //taken into account. If an Core::DocObject is passed, it has to be transformed before (geometry does not carry transformation info)            if (auto wire
    //= Topo::FaceTool::getOuterBoundary(face))                 u_or_vWires.push_back(wire);
    //  }
    //}

    void setWires(std::vector<pConstWire>& u_or_vWires, const std::vector<pConstShape>& in);
};

class LX_TOPO_EXPORT BasicSkinningOptions : public SkinningOptions
{
public:
    BasicSkinningOptions(void) : SkinningOptions() {}
    virtual ~BasicSkinningOptions(void) override = default;

protected:
    void init() override {}
};

class LX_TOPO_EXPORT DraftSkinningOptions : public SkinningOptions
{
public:
    DraftSkinningOptions(void) : SkinningOptions() {}
    virtual ~DraftSkinningOptions(void) override = default;

    enum class GapMode
    {
        EXTENDED = 0,
        ROUNDED = 1,
        CHAMFERED = 2
    };  // SB - Pls match values in "skin_opts.hxx" => skin_gap_type
    void setGapMode(GapMode mode) { _gapMode = mode; };
    GapMode getGapMode() const { return _gapMode; }

    double startAngle = 0.;
    double startMagnitude = 0.;
    double endAngle = 0.;
    double endMagnitude = 0.;

protected:
    GapMode _gapMode = GapMode::EXTENDED;

    void init() override {}
};

class LX_TOPO_EXPORT GuideSkinningOptions : public SkinningOptions
{
public:
    GuideSkinningOptions(void) : SkinningOptions() {}
    virtual ~GuideSkinningOptions(void) override = default;

    void setWiresV(const std::vector<pConstShape>& in) { setWires(_vWires, in); }
    void setWiresV(std::vector<pConstWire> in) { _vWires = in; }
    std::vector<pConstWire> getWiresV() const { return _vWires; }

    void setVirtualGuides(const bool& virtualGuides) { _virtualGuides = virtualGuides; }
    bool getVirtualGuides() const { return _virtualGuides; }

protected:
    bool _virtualGuides = false;  // SB 2012.05.07 - http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Guide-related

    std::vector<pConstWire> _vWires = {};

    void init() override {}
};

class LX_TOPO_EXPORT LinearSkinningOptions : public SkinningOptions
{
public:
    LinearSkinningOptions(void) : SkinningOptions() {}
    virtual ~LinearSkinningOptions(void) override = default;

protected:
    void init() override {}
};

class LX_TOPO_EXPORT PathSkinningOptions : public SkinningOptions
{
public:
    PathSkinningOptions(void) : SkinningOptions() {}
    virtual ~PathSkinningOptions(void) override = default;

    void setPath(pConstWire in) { _path = in; }
    pConstWire getPath() const { return _path; }

protected:
    pConstWire _path = nullptr;

    void init() override {}
};

class LX_TOPO_EXPORT PlanarSkinningOptions : public SkinningOptions
{
public:
    PlanarSkinningOptions(void) : SkinningOptions() {}
    virtual ~PlanarSkinningOptions(void) override = default;

    enum class NormalsMode
    {
        FIRST = 0,
        LAST = 1,
        ENDS = 2,
        ALL = 3
    };  // SB - Pls match values in "skin_opts.hxx" => skinning_normals
    void setNormalsMode(NormalsMode mode) { _normalsMode = mode; };
    NormalsMode getNormalsMode() const { return _normalsMode; }

protected:
    NormalsMode _normalsMode = NormalsMode::ALL;

    void init() override {}
};

class LX_TOPO_EXPORT SweepingOptions : public NurbsOptions
{
public:
    SweepingOptions() : NurbsOptions() {}
    ~SweepingOptions() override = default;

    void setShapeU(pConstShape in);
    void setShapeU(pConstFace in);
    void setShapeU(pConstWire in);
    pConstShape getShapeU() const { return _uShape; }

    void setToShape(pConstShape shape) { _toShape = shape; }
    pConstShape getToShape() const { return _toShape; }

    void setSolid(const bool& solid) { _solid = solid; }
    bool getSolid() const { return _solid; }

    void setSelfIntersect(const bool& allowSelfIntersect) { _selfIntTest = !allowSelfIntersect; }
    bool getSelfIntersect() const { return _selfIntTest; }

    // This value is intentionally "readonly", since it is not clear when it would be useful to alter them.
    bool getSimplify() const { return _simplify; }

protected:
    bool _selfIntTest = false;  // SB 2012.06.05 - When FALSE allow creation of self-intersecting surfaces:
                                // http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Surface_Checks#self_int_test_.281.29. No exception is
                                // thrown, NURBS is created (probably rubbish) and "selfIntersect" property can be detected later.
    bool _simplify =
        false;  // SB 2012.06.14 - Leave to FALSE or ACIS will try to build a simpler surface (if possible). For example, if set to TRUE and the
                // surface is exactly a cylinder, ACIS will not make a NURBS but a cylinder and the "api_accurate_bs3_approximation" won't work! See
                // http://doc.spatial.com/index.php/Skinning_and_Lofting_Options/Simplification
    bool _solid = false;

    pConstShape _uShape = nullptr;
    pConstShape _toShape = nullptr;

    void init() override = 0;
};

class LX_TOPO_EXPORT PathSweepingOptions : public SweepingOptions
{
public:
    PathSweepingOptions() : SweepingOptions() {}
    ~PathSweepingOptions() override = default;

    void setShapeV(pConstShape in);
    void setShapeV(pConstWire in);
    pConstShape getShapeV() const { return _vShape; }

    void setFinalTwistAngle(const double& angleInDeg) { _finalTwistAngle = angleInDeg; }
    double getFinalTwistAngle() const { return _finalTwistAngle; }

    void setRigid(const bool& rigid) { _rigid = rigid; }
    bool getRigid() const { return _rigid; }

    void setUseRail(const bool& rail, const Geom::Dir railDir = Geom::Dir(0., 0., 1.))
    {
        _rail = rail;
        _railDir = railDir;
    }
    bool getUseRail(Geom::Dir& railDir) const
    {
        railDir = _railDir;
        return _rail;
    }

protected:
    double _finalTwistAngle = 0.;
    bool _rigid = false;
    bool _rail = false;
    Geom::Dir _railDir = Geom::Dir(0., 0., 1.);

    pConstShape _vShape = nullptr;

    void init() override {}
};
}  // namespace Topo