Files
OCCT/src/BRepLib/BRepLib_MakeEdge.cdl
bugmaster b311480ed5 0023024: Update headers of OCCT files
Added appropriate copyright and license information in source files
2012-03-21 19:43:04 +04:00

364 lines
10 KiB
Plaintext
Executable File

-- Created on: 1993-07-06
-- Created by: Remi LEQUETTE
-- Copyright (c) 1993-1999 Matra Datavision
-- Copyright (c) 1999-2012 OPEN CASCADE SAS
--
-- The content of this file is subject to the Open CASCADE Technology Public
-- License Version 6.5 (the "License"). You may not use the content of this file
-- except in compliance with the License. Please obtain a copy of the License
-- at http://www.opencascade.org and read it completely before using this file.
--
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
--
-- The Original Code and all software distributed under the License is
-- distributed on an "AS IS" basis, without warranty of any kind, and the
-- Initial Developer hereby disclaims all such warranties, including without
-- limitation, any warranties of merchantability, fitness for a particular
-- purpose or non-infringement. Please see the License for the specific terms
-- and conditions governing the rights and limitations under the License.
class MakeEdge from BRepLib inherits MakeShape from BRepLib
---Purpose: Provides methods to build edges.
--
-- The methods have the following syntax, where
-- TheCurve is one of Lin, Circ, ...
--
-- Create(C : TheCurve)
--
-- Makes an edge on the whole curve. Add vertices
-- on finite curves.
--
-- Create(C : TheCurve; p1,p2 : Real)
--
-- Make an edge on the curve between parameters p1
-- and p2. if p2 < p1 the edge will be REVERSED. If
-- p1 or p2 is infinite the curve will be open in
-- that direction. Vertices are created for finite
-- values of p1 and p2.
--
-- Create(C : TheCurve; P1, P2 : Pnt from gp)
--
-- Make an edge on the curve between the points P1
-- and P2. The points are projected on the curve
-- and the previous method is used. An error is
-- raised if the points are not on the curve.
--
-- Create(C : TheCurve; V1, V2 : Vertex from TopoDS)
--
-- Make an edge on the curve between the vertices
-- V1 and V2. Same as the previous but no vertices
-- are created. If a vertex is Null the curve will
-- be open in this direction.
uses
EdgeError from BRepLib,
Edge from TopoDS,
Vertex from TopoDS,
Pnt from gp,
Lin from gp,
Circ from gp,
Elips from gp,
Hypr from gp,
Parab from gp,
Curve from Geom2d,
Curve from Geom,
Surface from Geom
raises
NotDone from StdFail
is
Create returns MakeEdge from BRepLib;
----------------------------------------
-- Points
----------------------------------------
Create(V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
Create(P1, P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Lin
----------------------------------------
Create(L : Lin from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Lin from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Lin from gp; P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Lin from gp; V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Circ
----------------------------------------
Create(L : Circ from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Circ from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Circ from gp; P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Circ from gp; V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Elips
----------------------------------------
Create(L : Elips from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Elips from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Elips from gp; P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Elips from gp; V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Hypr
----------------------------------------
Create(L : Hypr from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Hypr from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Hypr from gp; P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Hypr from gp; V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Parab
----------------------------------------
Create(L : Parab from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Parab from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Parab from gp; P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Parab from gp; V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Curve
----------------------------------------
Create(L : Curve from Geom)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom;
P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom;
V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom;
P1,P2 : Pnt from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom;
V1, V2 : Vertex from TopoDS;
p1, p2 :Real)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Curve and surface
----------------------------------------
Create(L : Curve from Geom2d; S : Surface from Geom)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom2d; S : Surface from Geom; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom2d; S : Surface from Geom;
P1,P2 : Pnt from gp)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom2d; S : Surface from Geom;
V1, V2 : Vertex from TopoDS)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom2d; S : Surface from Geom;
P1,P2 : Pnt from gp; p1,p2 : Real)
---Level: Public
returns MakeEdge from BRepLib;
Create(L : Curve from Geom2d; S : Surface from Geom;
V1, V2 : Vertex from TopoDS;
p1, p2 :Real)
---Level: Public
returns MakeEdge from BRepLib;
----------------------------------------
-- Auxiliary methods
----------------------------------------
Init(me : in out; C : Curve from Geom)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom;
p1, p2 : Real)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom;
P1, P2 : Pnt from gp)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom;
V1, V2 : Vertex from TopoDS)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom;
P1, P2 : Pnt from gp;
p1, p2 : Real)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom;
V1, V2 : Vertex from TopoDS;
p1, p2 : Real)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom2d; S : Surface from Geom)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
p1, p2 : Real)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
P1, P2 : Pnt from gp)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
V1, V2 : Vertex from TopoDS)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
P1, P2 : Pnt from gp;
p1, p2 : Real)
---Level: Public
is static;
Init(me : in out; C : Curve from Geom2d; S : Surface from Geom;
V1, V2 : Vertex from TopoDS;
p1, p2 : Real)
---Level: Public
is static;
----------------------------------------
-- Results
----------------------------------------
Error(me) returns EdgeError from BRepLib
---Purpose: Returns the error description when NotDone.
---Level: Public
is static;
Edge(me) returns Edge from TopoDS
---C++: return const &
---C++: alias "Standard_EXPORT operator TopoDS_Edge() const;"
---Level: Public
raises
NotDone from StdFail
is static;
Vertex1(me) returns Vertex from TopoDS
---Purpose: Returns the first vertex of the edge. May be Null.
--
---C++: return const &
---Level: Public
is static;
Vertex2(me) returns Vertex from TopoDS
---Purpose: Returns the second vertex of the edge. May be Null.
--
---C++: return const &
---Level: Public
is static;
fields
myError : EdgeError from BRepLib;
myVertex1 : Vertex from TopoDS;
myVertex2 : Vertex from TopoDS;
end MakeEdge;