OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    GeomAPI_ExtremaSurfaceSurface Class Reference

    Describes functions for computing all the extrema between two surfaces. An ExtremaSurfaceSurface algorithm minimizes or maximizes the distance between a point on the first surface and a point on the second surface. Results are start and end points of perpendiculars common to the two surfaces. Solutions consist of pairs of points, and an extremum is considered to be a segment joining the two points of a solution. An ExtremaSurfaceSurface object provides a framework for: More...

    #include <GeomAPI_ExtremaSurfaceSurface.hxx>

    Public Member Functions

     GeomAPI_ExtremaSurfaceSurface ()
     Constructs an empty algorithm for computing extrema between two surfaces. Use an Init function to define the surfaces on which it is going to work.
     GeomAPI_ExtremaSurfaceSurface (const occ::handle< Geom_Surface > &S1, const occ::handle< Geom_Surface > &S2)
     Computes the extrema distances between the surfaces <S1> and <S2>.
     GeomAPI_ExtremaSurfaceSurface (const occ::handle< Geom_Surface > &S1, const occ::handle< Geom_Surface > &S2, const double U1min, const double U1max, const double V1min, const double V1max, const double U2min, const double U2max, const double V2min, const double V2max)
     Computes the extrema distances between the portion of the surface S1 limited by the two values of parameter (U1min,U1max) in the u parametric direction, and by the two values of parameter (V1min,V1max) in the v parametric direction, and.
    void Init (const occ::handle< Geom_Surface > &S1, const occ::handle< Geom_Surface > &S2)
     Initializes this algorithm with the given arguments and computes the extrema distances between the surfaces <S1> and <S2>.
    void Init (const occ::handle< Geom_Surface > &S1, const occ::handle< Geom_Surface > &S2, const double U1min, const double U1max, const double V1min, const double V1max, const double U2min, const double U2max, const double V2min, const double V2max)
     Initializes this algorithm with the given arguments and computes the extrema distances between - the portion of the surface S1 limited by the two values of parameter (U1min,U1max) in the u parametric direction, and by the two values of parameter (V1min,V1max) in the v parametric direction, and.
    int NbExtrema () const
     Returns the number of extrema computed by this algorithm. Note: if this algorithm fails, NbExtrema returns 0.
     operator int () const
    void Points (const int Index, gp_Pnt &P1, gp_Pnt &P2) const
     Returns the points P1 on the first surface and P2 on the second surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.
    void Parameters (const int Index, double &U1, double &V1, double &U2, double &V2) const
     Returns the parameters (U1,V1) of the point on the first surface, and (U2,V2) of the point on the second surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.
    double Distance (const int Index) const
     Computes the distance between the end points of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.
    bool IsParallel () const
     Returns True if the surfaces are parallel.
    void NearestPoints (gp_Pnt &P1, gp_Pnt &P2) const
     Returns the points P1 on the first surface and P2 on the second surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.
    void LowerDistanceParameters (double &U1, double &V1, double &U2, double &V2) const
     Returns the parameters (U1,V1) of the point on the first surface and (U2,V2) of the point on the second surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions - StdFail_NotDone if this algorithm fails.
    double LowerDistance () const
     Computes the distance between the end points of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.
     operator double () const
    const Extrema_ExtSS & Extrema () const
     return the algorithmic object from Extrema

    Detailed Description

    Describes functions for computing all the extrema between two surfaces. An ExtremaSurfaceSurface algorithm minimizes or maximizes the distance between a point on the first surface and a point on the second surface. Results are start and end points of perpendiculars common to the two surfaces. Solutions consist of pairs of points, and an extremum is considered to be a segment joining the two points of a solution. An ExtremaSurfaceSurface object provides a framework for:

    • defining the construction of the extrema,
    • implementing the construction algorithm, and
    • consulting the results. Warning In some cases, the nearest points between the two surfaces do not correspond to one of the computed extrema. Instead, they may be given by:
    • a point of a bounding curve of one surface and one of the following:
    • its orthogonal projection on the other surface,
    • a point of a bounding curve of the other surface; or
    • any point on intersection curves between the two surfaces.

    Constructor & Destructor Documentation

    ◆ GeomAPI_ExtremaSurfaceSurface() [1/3]

    GeomAPI_ExtremaSurfaceSurface::GeomAPI_ExtremaSurfaceSurface ( )

    Constructs an empty algorithm for computing extrema between two surfaces. Use an Init function to define the surfaces on which it is going to work.

    ◆ GeomAPI_ExtremaSurfaceSurface() [2/3]

    GeomAPI_ExtremaSurfaceSurface::GeomAPI_ExtremaSurfaceSurface ( const occ::handle< Geom_Surface > & S1,
    const occ::handle< Geom_Surface > & S2 )

    Computes the extrema distances between the surfaces <S1> and <S2>.

    ◆ GeomAPI_ExtremaSurfaceSurface() [3/3]

    GeomAPI_ExtremaSurfaceSurface::GeomAPI_ExtremaSurfaceSurface ( const occ::handle< Geom_Surface > & S1,
    const occ::handle< Geom_Surface > & S2,
    const double U1min,
    const double U1max,
    const double V1min,
    const double V1max,
    const double U2min,
    const double U2max,
    const double V2min,
    const double V2max )

    Computes the extrema distances between the portion of the surface S1 limited by the two values of parameter (U1min,U1max) in the u parametric direction, and by the two values of parameter (V1min,V1max) in the v parametric direction, and.

    • the portion of the surface S2 limited by the two values of parameter (U2min,U2max) in the u parametric direction, and by the two values of parameter (V2min,V2max) in the v parametric direction.

    Member Function Documentation

    ◆ Distance()

    double GeomAPI_ExtremaSurfaceSurface::Distance ( const int Index) const

    Computes the distance between the end points of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

    ◆ Extrema()

    const Extrema_ExtSS & GeomAPI_ExtremaSurfaceSurface::Extrema ( ) const

    return the algorithmic object from Extrema

    ◆ Init() [1/2]

    void GeomAPI_ExtremaSurfaceSurface::Init ( const occ::handle< Geom_Surface > & S1,
    const occ::handle< Geom_Surface > & S2 )

    Initializes this algorithm with the given arguments and computes the extrema distances between the surfaces <S1> and <S2>.

    ◆ Init() [2/2]

    void GeomAPI_ExtremaSurfaceSurface::Init ( const occ::handle< Geom_Surface > & S1,
    const occ::handle< Geom_Surface > & S2,
    const double U1min,
    const double U1max,
    const double V1min,
    const double V1max,
    const double U2min,
    const double U2max,
    const double V2min,
    const double V2max )

    Initializes this algorithm with the given arguments and computes the extrema distances between - the portion of the surface S1 limited by the two values of parameter (U1min,U1max) in the u parametric direction, and by the two values of parameter (V1min,V1max) in the v parametric direction, and.

    • the portion of the surface S2 limited by the two values of parameter (U2min,U2max) in the u parametric direction, and by the two values of parameter (V2min,V2max) in the v parametric direction.

    ◆ IsParallel()

    bool GeomAPI_ExtremaSurfaceSurface::IsParallel ( ) const
    inline

    Returns True if the surfaces are parallel.

    ◆ LowerDistance()

    double GeomAPI_ExtremaSurfaceSurface::LowerDistance ( ) const

    Computes the distance between the end points of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

    ◆ LowerDistanceParameters()

    void GeomAPI_ExtremaSurfaceSurface::LowerDistanceParameters ( double & U1,
    double & V1,
    double & U2,
    double & V2 ) const

    Returns the parameters (U1,V1) of the point on the first surface and (U2,V2) of the point on the second surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions - StdFail_NotDone if this algorithm fails.

    ◆ NbExtrema()

    int GeomAPI_ExtremaSurfaceSurface::NbExtrema ( ) const

    Returns the number of extrema computed by this algorithm. Note: if this algorithm fails, NbExtrema returns 0.

    ◆ NearestPoints()

    void GeomAPI_ExtremaSurfaceSurface::NearestPoints ( gp_Pnt & P1,
    gp_Pnt & P2 ) const

    Returns the points P1 on the first surface and P2 on the second surface, which are the ends of the shortest extremum computed by this algorithm. Exceptions StdFail_NotDone if this algorithm fails.

    ◆ operator double()

    GeomAPI_ExtremaSurfaceSurface::operator double ( ) const

    ◆ operator int()

    GeomAPI_ExtremaSurfaceSurface::operator int ( ) const

    ◆ Parameters()

    void GeomAPI_ExtremaSurfaceSurface::Parameters ( const int Index,
    double & U1,
    double & V1,
    double & U2,
    double & V2 ) const

    Returns the parameters (U1,V1) of the point on the first surface, and (U2,V2) of the point on the second surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.

    ◆ Points()

    void GeomAPI_ExtremaSurfaceSurface::Points ( const int Index,
    gp_Pnt & P1,
    gp_Pnt & P2 ) const

    Returns the points P1 on the first surface and P2 on the second surface, which are the ends of the extremum of index Index computed by this algorithm. Exceptions Standard_OutOfRange if Index is not in the range [ 1,NbExtrema ], where NbExtrema is the number of extrema computed by this algorithm.


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