Files
OCCT/src/BRepOffsetAPI/BRepOffsetAPI_MakeOffset.cdl

114 lines
4.2 KiB
Plaintext
Executable File

-- Created on: 1995-09-18
-- Created by: Bruno DUMORTIER
-- Copyright (c) 1995-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 MakeOffset from BRepOffsetAPI inherits MakeShape from BRepBuilderAPI
---Purpose: Describes algorithms for offsetting wires from a set of
-- wires contained in a planar face.
-- A MakeOffset object provides a framework for:
-- - defining the construction of an offset,
-- - implementing the construction algorithm, and
-- - consulting the result.
uses
Shape from TopoDS,
Wire from TopoDS,
Face from TopoDS,
ListOfShape from TopTools,
OffsetWire from BRepFill,
ListOfOffsetWire from BRepFill,
JoinType from GeomAbs
raises
NotDone from StdFail
is
Create returns MakeOffset from BRepOffsetAPI;
---Purpose: Constructs an algorithm for creating an empty offset
Create( Spine : Face from TopoDS;
Join : JoinType from GeomAbs = GeomAbs_Arc)
returns MakeOffset from BRepOffsetAPI;
---Purpose: Constructs an algorithm for creating an algorithm
-- to build parallels to the spine Spine
Init( me : in out;
Spine : Face from TopoDS;
Join : JoinType from GeomAbs = GeomAbs_Arc)
---Purpose: Initializes the algorithm to construct parallels to the spine Spine.
-- Join defines the type of parallel generated by the
-- salient vertices of the spine. The default type is
-- GeomAbs_Arc where the vertices generate sections
-- of a circle. At present, this is the only construction type implemented.
is static;
Create( Spine : Wire from TopoDS;
Join : JoinType from GeomAbs = GeomAbs_Arc)
returns MakeOffset from BRepOffsetAPI;
Init( me : in out;
Join : JoinType from GeomAbs = GeomAbs_Arc)
---Purpose: Initialize the evaluation of Offseting.
is static;
AddWire (me : in out;
Spine : Wire from TopoDS)
---Purpose: Initializes the algorithm to construct parallels to the wire Spine.
is static;
Perform (me : in out;
Offset : Real from Standard;
Alt : Real from Standard = 0.0)
---Purpose: Computes a parallel to the spine at distance Offset and
-- at an altitude Alt from the plane of the spine in relation
-- to the normal to the spine.
-- Exceptions: StdFail_NotDone if the offset is not built.
raises
NotDone from StdFail
is static;
Build(me : in out)
is redefined;
---Purpose: Builds the resulting shape (redefined from MakeShape).
---Level: Public
Generated (me: in out; S : Shape from TopoDS)
---Purpose: returns a list of the created shapes
-- from the shape <S>.
---C++: return const &
---Level: Public
returns ListOfShape from TopTools
is redefined;
fields
myIsInitialized : Boolean from Standard;
myLastIsLeft : Boolean from Standard;
myJoin : JoinType from GeomAbs;
myFace : Face from TopoDS;
myWires : ListOfShape from TopTools;
myLeft : ListOfOffsetWire from BRepFill;
myRight : ListOfOffsetWire from BRepFill;
end MakeOffset;