1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
-- Created on: 1994-03-18
-- Created by: Bruno DUMORTIER
-- Copyright (c) 1994-1999 Matra Datavision
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
--
-- This file is part of Open CASCADE Technology software library.
--
-- This library is free software; you can redistribute it and/or modify it under
-- the terms of the GNU Lesser General Public License version 2.1 as published
-- by the Free Software Foundation, with special exception defined in the file
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
-- distribution for complete text of the license and disclaimer of any warranty.
--
-- Alternatively, this file may be used under the terms of Open CASCADE
-- commercial license or contractual agreement.
class ExtremaCurveSurface from GeomAPI
---Purpose: Describes functions for computing all the extrema
-- between a curve and a surface.
-- An ExtremaCurveSurface algorithm minimizes or
-- maximizes the distance between a point on the curve
-- and a point on the surface. Thus, it computes start
-- and end points of perpendiculars common to the
-- curve and the surface (an intersection point is not an
-- extremum except where the curve and the surface
-- are tangential at this point).
-- Solutions consist of pairs of points, and an extremum
-- is considered to be a segment joining the two points of a solution.
-- An ExtremaCurveSurface 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 a curve
-- and a surface do not correspond to one of the
-- computed extrema. Instead, they may be given by:
-- - a point of a bounding curve of the surface and one of the following:
-- - its orthogonal projection on the curve,
-- - a limit point of the curve; or
-- - a limit point of the curve and its projection on the surface; or
-- - an intersection point between the curve and the surface.
uses
Curve from Geom,
Surface from Geom,
ExtCS from Extrema,
Pnt from gp,
Length from Quantity,
Parameter from Quantity
raises
OutOfRange from Standard,
NotDone from StdFail
is
Create
---Purpose: Constructs an empty algorithm for computing
-- extrema between a curve and a surface. Use an
-- Init function to define the curve and the surface on
-- which it is going to work.
returns ExtremaCurveSurface from GeomAPI;
Create(Curve : Curve from Geom;
Surface : Surface from Geom)
---Purpose: Computes the extrema distances between the
-- curve <C> and the surface <S>.
---Level: Public
returns ExtremaCurveSurface from GeomAPI;
Create(Curve : Curve from Geom;
Surface : Surface from Geom;
Wmin, Wmax : Parameter from Quantity;
Umin, Umax : Parameter from Quantity;
Vmin, Vmax : Parameter from Quantity)
---Purpose: Computes the extrema distances between the
-- curve <C> and the surface <S>. The solution
-- point are computed in the domain [Wmin,Wmax] of
-- the curve and in the domain [Umin,Umax]
-- [Vmin,Vmax] of the surface.
-- Warning
-- Use the function NbExtrema to obtain the number
-- of solutions. If this algorithm fails, NbExtrema returns 0.
returns ExtremaCurveSurface from GeomAPI;
Init(me : in out;
Curve : Curve from Geom;
Surface : Surface from Geom)
---Purpose: Computes the extrema distances between the
-- curve <C> and the surface <S>.
---Level: Public
is static;
Init(me : in out;
Curve : Curve from Geom;
Surface : Surface from Geom;
Wmin, Wmax : Parameter from Quantity;
Umin, Umax : Parameter from Quantity;
Vmin, Vmax : Parameter from Quantity)
---Purpose: Computes the extrema distances between the
-- curve <C> and the surface <S>. The solution
-- point are computed in the domain [Wmin,Wmax] of
-- the curve and in the domain [Umin,Umax]
-- [Vmin,Vmax] of the surface.
-- Warning
-- Use the function NbExtrema to obtain the number
-- of solutions. If this algorithm fails, NbExtrema returns 0.
is static;
NbExtrema(me)
---Purpose: Returns the number of extrema computed by this algorithm.
-- Note: if this algorithm fails, NbExtrema returns 0.
returns Integer from Standard
---C++: alias "Standard_EXPORT operator Standard_Integer() const;"
is static;
Points(me; Index : Integer from Standard;
P1, P2 : out Pnt from gp )
---Purpose: Returns the points P1 on the curve and P2 on the
-- 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.
raises
OutOfRange from Standard
is static;
Parameters(me; Index : Integer from Standard;
W : out Parameter from Quantity;
U, V : out Parameter from Quantity)
---Purpose: Returns the parameters W of the point on the curve,
-- and (U,V) of the point on the 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.
raises
OutOfRange from Standard
is static;
Distance(me; Index : Integer from Standard)
returns Length from Quantity
---Purpose: 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.
raises
OutOfRange from Standard
is static;
NearestPoints(me; PC, PS : out Pnt from gp)
---Purpose: Returns the points PC on the curve and PS on the
-- surface, which are the ends of the shortest extremum computed by this algorithm.
-- Exceptions - StdFail_NotDone if this algorithm fails.
raises
NotDone from StdFail
is static;
LowerDistanceParameters(me; W : out Parameter from Quantity;
U, V : out Parameter from Quantity)
---Purpose: Returns the parameters W of the point on the curve
-- and (U,V) of the point on the surface, which are the
-- ends of the shortest extremum computed by this algorithm.
-- Exceptions - StdFail_NotDone if this algorithm fails.
raises
NotDone from StdFail
is static;
LowerDistance(me)
---Purpose: Computes the distance between the end points of the
-- shortest extremum computed by this algorithm.
-- Exceptions - StdFail_NotDone if this algorithm fails.
returns Length from Quantity
---C++: alias "Standard_EXPORT operator Standard_Real() const;"
raises
NotDone from StdFail
is static;
Extrema(me)
---Purpose: Returns the algorithmic object from Extrema
---Level: Advanced
---C++: return const&
---C++: inline
returns ExtCS from Extrema
is static;
fields
myIsDone: Boolean from Standard;
myIndex : Integer from Standard; -- index of the nearest solution
myExtCS : ExtCS from Extrema;
end ExtremaCurveSurface;
|