OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    GeomAdaptor_Curve Class Reference

    This class provides an interface between the services provided by any curve from the package Geom and those required of the curve by algorithms which use it. Creation of the loaded curve the curve is C1 by piece. More...

    #include <GeomAdaptor_Curve.hxx>

    Inheritance diagram for GeomAdaptor_Curve:

    Data Structures

    struct  OffsetData
     Internal structure for offset curve evaluation data. More...
    struct  BezierData
     Internal structure for Bezier curve cache data. More...
    struct  BSplineData
     Internal structure for BSpline curve cache data. More...

    Public Types

    using CurveDataVariant
     Variant type for curve-specific evaluation data. Elementary curve primitives (gp_Lin, gp_Circ, etc.) are stored directly to enable direct ElCLib dispatch without virtual calls.
    typedef void base_type
     Returns a type descriptor about this object.

    Public Member Functions

     GeomAdaptor_Curve ()
     GeomAdaptor_Curve (const occ::handle< Geom_Curve > &theCurve)
     GeomAdaptor_Curve (const occ::handle< Geom_Curve > &theCurve, const double theUFirst, const double theULast)
     Standard_ConstructionError is raised if theUFirst > theULast + Precision::PConfusion().
    occ::handle< Adaptor3d_Curve > ShallowCopy () const override
     Shallow copy of adaptor.
    void Reset ()
     Reset currently loaded curve (undone Load()).
    void Load (const occ::handle< Geom_Curve > &theCurve)
    void Load (const occ::handle< Geom_Curve > &theCurve, const double theUFirst, const double theULast)
     Standard_ConstructionError is raised if theUFirst > theULast + Precision::PConfusion().
    const occ::handle< Geom_Curve > & Curve () const
     Provides a curve inherited from Hcurve from Adaptor. This is inherited to provide easy to use constructors.
    double FirstParameter () const override
    double LastParameter () const override
    GeomAbs_Shape Continuity () const override
    int NbIntervals (const GeomAbs_Shape S) const override
     Returns the number of intervals for continuity . May be one if Continuity(me) >= .
    void Intervals (NCollection_Array1< double > &T, const GeomAbs_Shape S) const override
     Stores in <T> the parameters bounding the intervals of continuity .
    occ::handle< Adaptor3d_Curve > Trim (const double First, const double Last, const double Tol) const override
     Returns a curve equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. If <First> >= <Last>.
    bool IsClosed () const override
    bool IsPeriodic () const override
    double Period () const override
    double Resolution (const double R3d) const override
     returns the parametric resolution
    GeomAbs_CurveType GetType () const override
     Returns the type of the curve in the current interval: Line, Circle, Ellipse, Hyperbola, Parabola, BezierCurve, BSplineCurve, OtherCurve.
    gp_Lin Line () const override
    gp_Circ Circle () const override
    gp_Elips Ellipse () const override
    gp_Hypr Hyperbola () const override
    gp_Parab Parabola () const override
    int Degree () const override
     this should NEVER make a copy of the underlying curve to read the relevant information
    bool IsRational () const override
     this should NEVER make a copy of the underlying curve to read the relevant information
    int NbPoles () const override
     this should NEVER make a copy of the underlying curve to read the relevant information
    int NbKnots () const override
     this should NEVER make a copy of the underlying curve to read the relevant information
    occ::handle< Geom_BezierCurve > Bezier () const override
     this will NOT make a copy of the Bezier Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.
    occ::handle< Geom_BSplineCurve > BSpline () const override
     this will NOT make a copy of the BSpline Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.
    occ::handle< Geom_OffsetCurve > OffsetCurve () const override
    gp_Pnt EvalD0 (const double theU) const final
     Point evaluation. Raises an exception on failure.
    Geom_Curve::ResD1 EvalD1 (const double theU) const final
     D1 evaluation. Raises an exception on failure.
    Geom_Curve::ResD2 EvalD2 (const double theU) const final
     D2 evaluation. Raises an exception on failure.
    Geom_Curve::ResD3 EvalD3 (const double theU) const final
     D3 evaluation. Raises an exception on failure.
    gp_Vec EvalDN (const double theU, const int theN) const final
     DN evaluation. Raises an exception on failure.
    Public Member Functions inherited from Adaptor3d_Curve
    gp_Pnt Value (const double theU) const
     Computes the point of parameter U on the curve.
    void D0 (const double theU, gp_Pnt &theP) const
     Computes the point of parameter U on the curve.
    void D1 (const double theU, gp_Pnt &theP, gp_Vec &theV) const
     Computes the point of parameter U on the curve with its first derivative. Raised if the continuity of the current interval is not C1.
    void D2 (const double theU, gp_Pnt &theP, gp_Vec &theV1, gp_Vec &theV2) const
     Returns the point P of parameter U, the first and second derivatives V1 and V2. Raised if the continuity of the current interval is not C2.
    void D3 (const double theU, gp_Pnt &theP, gp_Vec &theV1, gp_Vec &theV2, gp_Vec &theV3) const
     Returns the point P of parameter U, the first, the second and the third derivative. Raised if the continuity of the current interval is not C3.
    gp_Vec DN (const double theU, const int theN) const
     The returned vector gives the value of the derivative for the order of derivation N. Raised if the continuity of the current interval is not CN. Raised if N < 1.
     ~Adaptor3d_Curve () override
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transient & operator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool IsKind (const opencascade::handle< Standard_Type > &theType) const
     Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    bool IsKind (const char *const theTypeName) const
     Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.
    Standard_Transient * This () const
     Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    Detailed Description

    This class provides an interface between the services provided by any curve from the package Geom and those required of the curve by algorithms which use it. Creation of the loaded curve the curve is C1 by piece.

    Polynomial coefficients of BSpline curves used for their evaluation are cached for better performance. Therefore these evaluations are not thread-safe and parallel evaluations need to be prevented.

    Member Typedef Documentation

    ◆ CurveDataVariant

    Initial value:
    std::variant<std::monostate,
    Describes a circle in 3D space. A circle is defined by its radius and positioned in space with a coor...
    Definition gp_Circ.hxx:52
    Describes an ellipse in 3D space. An ellipse is defined by its major and minor radii and positioned i...
    Definition gp_Elips.hxx:50
    Describes a branch of a hyperbola in 3D space. A hyperbola is defined by its major and minor radii an...
    Definition gp_Hypr.hxx:72
    Describes a line in 3D space. A line is positioned in space with an axis (a gp_Ax1 object) which give...
    Definition gp_Lin.hxx:40
    Describes a parabola in 3D space. A parabola is defined by its focal length (that is,...
    Definition gp_Parab.hxx:51
    Internal structure for BSpline curve evaluation data.
    Definition Geom2dAdaptor_Curve.hxx:75
    Internal structure for Bezier curve evaluation data.
    Definition Geom2dAdaptor_Curve.hxx:67
    Internal structure for 2D offset curve evaluation data.
    Definition Geom2dAdaptor_Curve.hxx:59

    Variant type for curve-specific evaluation data. Elementary curve primitives (gp_Lin, gp_Circ, etc.) are stored directly to enable direct ElCLib dispatch without virtual calls.

    Constructor & Destructor Documentation

    ◆ GeomAdaptor_Curve() [1/3]

    GeomAdaptor_Curve::GeomAdaptor_Curve ( )
    inline

    ◆ GeomAdaptor_Curve() [2/3]

    GeomAdaptor_Curve::GeomAdaptor_Curve ( const occ::handle< Geom_Curve > & theCurve)
    inline

    ◆ GeomAdaptor_Curve() [3/3]

    GeomAdaptor_Curve::GeomAdaptor_Curve ( const occ::handle< Geom_Curve > & theCurve,
    const double theUFirst,
    const double theULast )
    inline

    Standard_ConstructionError is raised if theUFirst > theULast + Precision::PConfusion().

    Member Function Documentation

    ◆ Bezier()

    occ::handle< Geom_BezierCurve > GeomAdaptor_Curve::Bezier ( ) const
    overridevirtual

    this will NOT make a copy of the Bezier Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.

    Reimplemented from Adaptor3d_Curve.

    ◆ BSpline()

    occ::handle< Geom_BSplineCurve > GeomAdaptor_Curve::BSpline ( ) const
    overridevirtual

    this will NOT make a copy of the BSpline Curve : If you want to modify the Curve please make a copy yourself Also it will NOT trim the surface to myFirst/Last.

    Reimplemented from Adaptor3d_Curve.

    ◆ Circle()

    gp_Circ GeomAdaptor_Curve::Circle ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Continuity()

    GeomAbs_Shape GeomAdaptor_Curve::Continuity ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Curve()

    const occ::handle< Geom_Curve > & GeomAdaptor_Curve::Curve ( ) const
    inline

    Provides a curve inherited from Hcurve from Adaptor. This is inherited to provide easy to use constructors.

    ◆ Degree()

    int GeomAdaptor_Curve::Degree ( ) const
    overridevirtual

    this should NEVER make a copy of the underlying curve to read the relevant information

    Reimplemented from Adaptor3d_Curve.

    ◆ Ellipse()

    gp_Elips GeomAdaptor_Curve::Ellipse ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD0()

    gp_Pnt GeomAdaptor_Curve::EvalD0 ( const double theU) const
    nodiscardfinalvirtual

    Point evaluation. Raises an exception on failure.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD1()

    Geom_Curve::ResD1 GeomAdaptor_Curve::EvalD1 ( const double theU) const
    nodiscardfinalvirtual

    D1 evaluation. Raises an exception on failure.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD2()

    Geom_Curve::ResD2 GeomAdaptor_Curve::EvalD2 ( const double theU) const
    nodiscardfinalvirtual

    D2 evaluation. Raises an exception on failure.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalD3()

    Geom_Curve::ResD3 GeomAdaptor_Curve::EvalD3 ( const double theU) const
    nodiscardfinalvirtual

    D3 evaluation. Raises an exception on failure.

    Reimplemented from Adaptor3d_Curve.

    ◆ EvalDN()

    gp_Vec GeomAdaptor_Curve::EvalDN ( const double theU,
    const int theN ) const
    nodiscardfinalvirtual

    DN evaluation. Raises an exception on failure.

    Reimplemented from Adaptor3d_Curve.

    ◆ FirstParameter()

    double GeomAdaptor_Curve::FirstParameter ( ) const
    inlineoverridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ GetType()

    GeomAbs_CurveType GeomAdaptor_Curve::GetType ( ) const
    inlineoverridevirtual

    Returns the type of the curve in the current interval: Line, Circle, Ellipse, Hyperbola, Parabola, BezierCurve, BSplineCurve, OtherCurve.

    Reimplemented from Adaptor3d_Curve.

    ◆ Hyperbola()

    gp_Hypr GeomAdaptor_Curve::Hyperbola ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Intervals()

    void GeomAdaptor_Curve::Intervals ( NCollection_Array1< double > & T,
    const GeomAbs_Shape S ) const
    overridevirtual

    Stores in <T> the parameters bounding the intervals of continuity .

    The array must provide enough room to accommodate for the parameters. i.e. T.Length() > NbIntervals()

    Reimplemented from Adaptor3d_Curve.

    ◆ IsClosed()

    bool GeomAdaptor_Curve::IsClosed ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ IsPeriodic()

    bool GeomAdaptor_Curve::IsPeriodic ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ IsRational()

    bool GeomAdaptor_Curve::IsRational ( ) const
    overridevirtual

    this should NEVER make a copy of the underlying curve to read the relevant information

    Reimplemented from Adaptor3d_Curve.

    ◆ LastParameter()

    double GeomAdaptor_Curve::LastParameter ( ) const
    inlineoverridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Line()

    gp_Lin GeomAdaptor_Curve::Line ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Load() [1/2]

    void GeomAdaptor_Curve::Load ( const occ::handle< Geom_Curve > & theCurve)
    inline

    ◆ Load() [2/2]

    void GeomAdaptor_Curve::Load ( const occ::handle< Geom_Curve > & theCurve,
    const double theUFirst,
    const double theULast )
    inline

    Standard_ConstructionError is raised if theUFirst > theULast + Precision::PConfusion().

    ◆ NbIntervals()

    int GeomAdaptor_Curve::NbIntervals ( const GeomAbs_Shape S) const
    overridevirtual

    Returns the number of intervals for continuity . May be one if Continuity(me) >= .

    Reimplemented from Adaptor3d_Curve.

    ◆ NbKnots()

    int GeomAdaptor_Curve::NbKnots ( ) const
    overridevirtual

    this should NEVER make a copy of the underlying curve to read the relevant information

    Reimplemented from Adaptor3d_Curve.

    ◆ NbPoles()

    int GeomAdaptor_Curve::NbPoles ( ) const
    overridevirtual

    this should NEVER make a copy of the underlying curve to read the relevant information

    Reimplemented from Adaptor3d_Curve.

    ◆ OffsetCurve()

    occ::handle< Geom_OffsetCurve > GeomAdaptor_Curve::OffsetCurve ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Parabola()

    gp_Parab GeomAdaptor_Curve::Parabola ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Period()

    double GeomAdaptor_Curve::Period ( ) const
    overridevirtual

    Reimplemented from Adaptor3d_Curve.

    ◆ Reset()

    void GeomAdaptor_Curve::Reset ( )

    Reset currently loaded curve (undone Load()).

    ◆ Resolution()

    double GeomAdaptor_Curve::Resolution ( const double R3d) const
    overridevirtual

    returns the parametric resolution

    Reimplemented from Adaptor3d_Curve.

    ◆ ShallowCopy()

    occ::handle< Adaptor3d_Curve > GeomAdaptor_Curve::ShallowCopy ( ) const
    overridevirtual

    Shallow copy of adaptor.

    Reimplemented from Adaptor3d_Curve.

    ◆ Trim()

    occ::handle< Adaptor3d_Curve > GeomAdaptor_Curve::Trim ( const double First,
    const double Last,
    const double Tol ) const
    overridevirtual

    Returns a curve equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. If <First> >= <Last>.

    Reimplemented from Adaptor3d_Curve.


    The documentation for this class was generated from the following file: