1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-21 10:13:43 +03:00
occt/src/BRepPrimAPI/BRepPrimAPI_MakeWedge.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

118 lines
3.5 KiB
Plaintext
Executable File

-- Created on: 1993-07-22
-- 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 MakeWedge from BRepPrimAPI inherits MakeShape from BRepBuilderAPI
---Purpose: Describes functions to build wedges, i.e. boxes with inclined faces.
-- A MakeWedge object provides a framework for:
-- - defining the construction of a wedge,
-- - implementing the construction algorithm, and
-- - consulting the result.
uses
Ax2 from gp,
Pnt from gp,
Shell from TopoDS,
Solid from TopoDS,
Wedge from BRepPrim
raises
DomainError from Standard,
NotDone from StdFail
is
Create( dx, dy, dz, ltx : Real)
returns MakeWedge from BRepPrimAPI
---Purpose: Make a STEP right angular wedge. (ltx >= 0)
---Level: Public
raises
DomainError from Standard; -- if dx,dy,dz <= Precision::Confusion()
Create(Axes : Ax2 from gp; dx, dy, dz, ltx : Real)
returns MakeWedge from BRepPrimAPI
---Purpose: Make a STEP right angular wedge. (ltx >= 0)
---Level: Public
raises
DomainError from Standard; -- if dx,dy,dz <= Precision::Confusion()
Create(dx,dy,dz,xmin,zmin,xmax,zmax : Real)
returns MakeWedge from BRepPrimAPI
---Purpose: Make a wedge. The face at dy is xmin,zmin xmax,zmax
---Level: Public
raises
DomainError from Standard; -- if dx,dy,dz <= Precision::Confusion()
Create(Axes : Ax2 from gp; dx,dy,dz,xmin,zmin,xmax,zmax : Real)
returns MakeWedge from BRepPrimAPI
---Purpose: Make a wedge. The face at dy is xmin,zmin xmax,zmax
---Level: Public
raises
DomainError from Standard; -- if dx,dy,dz <= Precision::Confusion()
----------------------------------------
-- Auxiliary methods
----------------------------------------
Wedge(me : in out) returns Wedge from BRepPrim
---Purpose: Returns the internal algorithm.
--
---C++: return &
---Level: Public
is static;
----------------------------------------
-- Results
----------------------------------------
Build(me : in out)
---Purpose: Stores the solid in myShape.
---Level: Public
is redefined;
Shell(me : in out) returns Shell from TopoDS
---C++: return const &
---C++: alias "Standard_EXPORT operator TopoDS_Shell();"
---Purpose: Returns the constructed box in the form of a shell.
is static;
Solid(me : in out) returns Solid from TopoDS
---C++: return const &
---C++: alias "Standard_EXPORT operator TopoDS_Solid();"
---Purpose: Returns the constructed box in the form of a solid.
is static;
fields
myWedge : Wedge from BRepPrim;
end MakeWedge;