OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    Law_Interpol Class Reference

    Provides an evolution law that interpolates a set of parameter and value pairs (wi, radi). More...

    #include <Law_Interpol.hxx>

    Inheritance diagram for Law_Interpol:

    Public Member Functions

     Law_Interpol ()
     Constructs an empty interpolative evolution law. The function Set is used to define the law.
    void Set (const NCollection_Array1< gp_Pnt2d > &ParAndRad, const bool Periodic=false)
     Defines this evolution law by interpolating the set of 2D points ParAndRad. The Y coordinate of a point of ParAndRad is the value of the function at the parameter point given by its X coordinate. If Periodic is true, this function is assumed to be periodic. Warning.
    void SetInRelative (const NCollection_Array1< gp_Pnt2d > &ParAndRad, const double Ud, const double Uf, const bool Periodic=false)
    void Set (const NCollection_Array1< gp_Pnt2d > &ParAndRad, const double Dd, const double Df, const bool Periodic=false)
     Defines this evolution law by interpolating the set of 2D points ParAndRad. The Y coordinate of a point of ParAndRad is the value of the function at the parameter point given by its X coordinate. If Periodic is true, this function is assumed to be periodic. In the second syntax, Dd and Df define the values of the first derivative of the function at its first and last points. Warning.
    void SetInRelative (const NCollection_Array1< gp_Pnt2d > &ParAndRad, const double Ud, const double Uf, const double Dd, const double Df, const bool Periodic=false)
    Public Member Functions inherited from Law_BSpFunc
     Law_BSpFunc ()
     Law_BSpFunc (const occ::handle< Law_BSpline > &C, const double First, const double Last)
    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 . The array must provide enough room to accommodate for the parameters, i.e. T.Length() > NbIntervals().
    double Value (const double X) override
     Returns the value of the function at the point of parameter X.
    void D1 (const double X, double &F, double &D) override
     Returns the value F and the first derivative D of the function at the point of parameter X.
    void D2 (const double X, double &F, double &D, double &D2) override
     Returns the value, first and second derivatives at parameter X.
    occ::handle< Law_FunctionTrim (const double PFirst, const double PLast, const double Tol) const override
     Returns a law equivalent of <me> between parameters <First> and <Last>. <Tol> is used to test for 3d points confusion. It is usfule to determines the derivatives in these values <First> and <Last> if the Law is not Cn.
    void Bounds (double &PFirst, double &PLast) override
     Returns the parametric bounds of the function.
    occ::handle< Law_BSplineCurve () const
    void SetCurve (const occ::handle< Law_BSpline > &C)
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (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_TransientThis () 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

    typedef void base_type
     Returns a type descriptor about this object.
    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

    Provides an evolution law that interpolates a set of parameter and value pairs (wi, radi).

    Constructor & Destructor Documentation

    ◆ Law_Interpol()

    Law_Interpol::Law_Interpol ( )

    Constructs an empty interpolative evolution law. The function Set is used to define the law.

    Member Function Documentation

    ◆ Set() [1/2]

    void Law_Interpol::Set ( const NCollection_Array1< gp_Pnt2d > & ParAndRad,
    const bool Periodic = false )

    Defines this evolution law by interpolating the set of 2D points ParAndRad. The Y coordinate of a point of ParAndRad is the value of the function at the parameter point given by its X coordinate. If Periodic is true, this function is assumed to be periodic. Warning.

    • The X coordinates of points in the table ParAndRad must be given in ascendant order.
    • If Periodic is true, the first and last Y coordinates of points in the table ParAndRad are assumed to be equal. In addition, with the second syntax, Dd and Df are also assumed to be equal. If this is not the case, Set uses the first value(s) as last value(s).

    ◆ Set() [2/2]

    void Law_Interpol::Set ( const NCollection_Array1< gp_Pnt2d > & ParAndRad,
    const double Dd,
    const double Df,
    const bool Periodic = false )

    Defines this evolution law by interpolating the set of 2D points ParAndRad. The Y coordinate of a point of ParAndRad is the value of the function at the parameter point given by its X coordinate. If Periodic is true, this function is assumed to be periodic. In the second syntax, Dd and Df define the values of the first derivative of the function at its first and last points. Warning.

    • The X coordinates of points in the table ParAndRad must be given in ascendant order.
    • If Periodic is true, the first and last Y coordinates of points in the table ParAndRad are assumed to be equal. In addition, with the second syntax, Dd and Df are also assumed to be equal. If this is not the case, Set uses the first value(s) as last value(s).

    ◆ SetInRelative() [1/2]

    void Law_Interpol::SetInRelative ( const NCollection_Array1< gp_Pnt2d > & ParAndRad,
    const double Ud,
    const double Uf,
    const bool Periodic = false )

    ◆ SetInRelative() [2/2]

    void Law_Interpol::SetInRelative ( const NCollection_Array1< gp_Pnt2d > & ParAndRad,
    const double Ud,
    const double Uf,
    const double Dd,
    const double Df,
    const bool Periodic = false )

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