[occt.git] / src / BRepFeat / BRepFeat_MakePrism.cdl

-- Created on: 1996-02-13
-- Created by: Jacques GOUSSARD
-- Copyright (c) 1996-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 MakePrism from BRepFeat inherits Form from BRepFeat

	---Purpose: Describes functions to build prism features.
    	-- These can be depressions or protrusions.
    	-- The semantics of prism feature creation is
    	-- based on the construction of shapes:
    	-- -   along a length
    	-- -   up to a limiting face
    	-- -   from a limiting face to a height.
    	-- The shape defining construction of the prism feature can be 
    	-- either the supporting edge or the concerned area of a face.
    	-- In case of the supporting edge, this contour
    	-- can be attached to a face of the basis shape by
    	-- binding. When the contour is bound to this face,
    	-- the information that the contour will slide on the
    	-- face becomes available to the relevant class methods.
    	-- In case of the concerned area of a face, you
    	-- could, for example, cut it out and move it to a
    	-- different height which will define the limiting
    	-- face of a protrusion or depression.

uses Shape                     from TopoDS,
     Face                      from TopoDS,
     Edge                      from TopoDS,
     DataMapOfShapeListOfShape from TopTools,
     Dir                       from gp,
     DataMapOfShapeShape       from TopTools,
     SequenceOfCurve           from TColGeom,
     Curve                     from Geom,
     StatusError               from BRepFeat
     
raises ConstructionError from Standard

is


    Create

    	returns MakePrism from BRepFeat;
	---Purpose: Builds a prism by projecting a
    	-- wire along the face of a shape. Initializes the prism class.
	---C++: inline


    Create(Sbase     : Shape from TopoDS;
           Pbase     : Shape from TopoDS;
           Skface    : Face  from TopoDS;
	   Direction : Dir   from gp;
           Fuse      : Integer from Standard;
           Modify    : Boolean from Standard)
    
	---Purpose: Builds a prism by projecting a
    	-- wire along the face of a shape. a face Pbase is selected in
    	--   the shape Sbase to serve as the basis for
    	--   the prism. The orientation of the prism will
    	--   be defined by the vector Direction.
    	-- Fuse offers a choice between:
    	-- -   removing matter with a Boolean cut using the setting 0
    	-- -   adding matter with Boolean fusion using the setting 1.
    	--   The sketch face Skface serves to determine
    	-- the type of operation. If it is inside the basis
    	-- shape, a local operation such as glueing can be performed.
    	-- Exceptions
    	-- Standard_ConstructionError if the face
    	-- does not belong to the basis or the prism shape.
    		---C++: inline
    	    	returns MakePrism from BRepFeat;


    Init(me: in out; Sbase     : Shape from TopoDS;
                     Pbase     : Shape from TopoDS;
                     Skface    : Face  from TopoDS;
	             Direction : Dir   from gp;
                     Fuse      : Integer from Standard;
                     Modify    : Boolean from Standard)
    
    	is static;
    	---Purpose: Initializes this algorithm for building prisms along surfaces.
    	-- A face Pbase is selected in the shape Sbase
    	-- to serve as the basis for the prism. The
    	-- orientation of the prism will be defined by the vector Direction.
    	-- Fuse offers a choice between:
    	-- -   removing matter with a Boolean cut using the setting 0
    	-- -   adding matter with Boolean fusion using the setting 1.
    	-- The sketch face Skface serves to determine
    	-- the type of operation. If it is inside the basis
    	-- shape, a local operation such as glueing can be performed.

    Add(me: in out; E: Edge from TopoDS; OnFace: Face from TopoDS)

	---Purpose: Indicates that the edge <E> will slide on the face
	--  <OnFace>. Raises ConstructionError if the  face does not belong to the
	-- basis shape, or the edge to the prismed shape.
    	raises ConstructionError from Standard
	
	is static;


    Perform(me: in out; Length: Real from Standard)
    
    	is static;


    Perform(me: in out; Until:  Shape from TopoDS)
    
    	is static;


    Perform(me: in out; From :  Shape from TopoDS;
                        Until:  Shape from TopoDS)
    
    	is static;
    	---Purpose: Assigns one of the following semantics
    	-- -   to a height Length
    	-- -   to a face Until
    	-- -   from a face From to a height Until.
    	-- Reconstructs the feature topologically according to the semantic option chosen.

    PerformUntilEnd(me: in out)
    
    	is static;
    	--- Purpose: Realizes a semi-infinite prism, limited by the
    	-- position of the prism base. All other faces extend infinitely.

    PerformFromEnd(me: in out; FUntil: Shape from TopoDS)
    
    	is static;
    	---Purpose: Realizes a semi-infinite prism, limited by the face Funtil.


    PerformThruAll(me: in out)
    
    	is static;
    	---Purpose: Builds an infinite prism. The infinite descendants will not be kept in the result.
        
    PerformUntilHeight(me: in out; Until :  Shape from TopoDS;
                        Length:  Real  from Standard)
    
    	is static;
    	---Purpose: Assigns both a limiting shape, Until from
    	-- TopoDS_Shape, and a height, Length at which to stop generation of the prism feature.
        
    Curves(me: in out; S : in out SequenceOfCurve from TColGeom);
    	--- Purpose: Returns the list of curves S parallel to the axis of the prism.   

    BarycCurve(me: in out)    
    	returns Curve from Geom;
    	---Purpose: Generates a curve along the center of mass of the primitive.
fields

    myPbase  : Shape                     from TopoDS;
    mySlface : DataMapOfShapeListOfShape from TopTools;
    myDir    : Dir                       from gp;
    myCurves : SequenceOfCurve           from TColGeom;
    myBCurve : Curve                     from Geom;
    myStatusError : StatusError          from BRepFeat;

end MakePrism;
Commit	Line	Data
b311480e	1	-- Created on: 1996-02-13
	2	-- Created by: Jacques GOUSSARD
	3	-- Copyright (c) 1996-1999 Matra Datavision
	4	-- Copyright (c) 1999-2012 OPEN CASCADE SAS
	5	--
	6	-- The content of this file is subject to the Open CASCADE Technology Public
	7	-- License Version 6.5 (the "License"). You may not use the content of this file
	8	-- except in compliance with the License. Please obtain a copy of the License
	9	-- at http://www.opencascade.org and read it completely before using this file.
	10	--
	11	-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
	12	-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
	13	--
	14	-- The Original Code and all software distributed under the License is
	15	-- distributed on an "AS IS" basis, without warranty of any kind, and the
	16	-- Initial Developer hereby disclaims all such warranties, including without
	17	-- limitation, any warranties of merchantability, fitness for a particular
	18	-- purpose or non-infringement. Please see the License for the specific terms
	19	-- and conditions governing the rights and limitations under the License.
	20
7fd59977	21
	22
	23	class MakePrism from BRepFeat inherits Form from BRepFeat
	24
	25	---Purpose: Describes functions to build prism features.
	26	-- These can be depressions or protrusions.
	27	-- The semantics of prism feature creation is
	28	-- based on the construction of shapes:
	29	-- - along a length
	30	-- - up to a limiting face
	31	-- - from a limiting face to a height.
	32	-- The shape defining construction of the prism feature can be
	33	-- either the supporting edge or the concerned area of a face.
	34	-- In case of the supporting edge, this contour
	35	-- can be attached to a face of the basis shape by
	36	-- binding. When the contour is bound to this face,
	37	-- the information that the contour will slide on the
	38	-- face becomes available to the relevant class methods.
	39	-- In case of the concerned area of a face, you
	40	-- could, for example, cut it out and move it to a
	41	-- different height which will define the limiting
	42	-- face of a protrusion or depression.
	43
	44	uses Shape from TopoDS,
	45	Face from TopoDS,
	46	Edge from TopoDS,
	47	DataMapOfShapeListOfShape from TopTools,
	48	Dir from gp,
	49	DataMapOfShapeShape from TopTools,
	50	SequenceOfCurve from TColGeom,
	51	Curve from Geom,
	52	StatusError from BRepFeat
	53
	54	raises ConstructionError from Standard
	55
	56	is
	57
	58
	59	Create
	60
	61	returns MakePrism from BRepFeat;
	62	---Purpose: Builds a prism by projecting a
	63	-- wire along the face of a shape. Initializes the prism class.
	64	---C++: inline
	65
	66
	67	Create(Sbase : Shape from TopoDS;
	68	Pbase : Shape from TopoDS;
	69	Skface : Face from TopoDS;
	70	Direction : Dir from gp;
	71	Fuse : Integer from Standard;
	72	Modify : Boolean from Standard)
	73
	74	---Purpose: Builds a prism by projecting a
	75	-- wire along the face of a shape. a face Pbase is selected in
	76	-- the shape Sbase to serve as the basis for
	77	-- the prism. The orientation of the prism will
	78	-- be defined by the vector Direction.
	79	-- Fuse offers a choice between:
	80	-- - removing matter with a Boolean cut using the setting 0
	81	-- - adding matter with Boolean fusion using the setting 1.
	82	-- The sketch face Skface serves to determine
	83	-- the type of operation. If it is inside the basis
	84	-- shape, a local operation such as glueing can be performed.
85	-- Exceptions
86	-- Standard_ConstructionError if the face
87	-- does not belong to the basis or the prism shape.
88	---C++: inline
89	returns MakePrism from BRepFeat;
90
91
92	Init(me: in out; Sbase : Shape from TopoDS;
93	Pbase : Shape from TopoDS;
94	Skface : Face from TopoDS;
95	Direction : Dir from gp;
96	Fuse : Integer from Standard;
97	Modify : Boolean from Standard)
98
99	is static;
100	---Purpose: Initializes this algorithm for building prisms along surfaces.
101	-- A face Pbase is selected in the shape Sbase
102	-- to serve as the basis for the prism. The
103	-- orientation of the prism will be defined by the vector Direction.
104	-- Fuse offers a choice between:
105	-- - removing matter with a Boolean cut using the setting 0
106	-- - adding matter with Boolean fusion using the setting 1.
107	-- The sketch face Skface serves to determine
108	-- the type of operation. If it is inside the basis
109	-- shape, a local operation such as glueing can be performed.
110
111	Add(me: in out; E: Edge from TopoDS; OnFace: Face from TopoDS)
112
113	---Purpose: Indicates that the edge <E> will slide on the face
114	-- <OnFace>. Raises ConstructionError if the face does not belong to the
115	-- basis shape, or the edge to the prismed shape.
116	raises ConstructionError from Standard
117
118	is static;
119
120
121	Perform(me: in out; Length: Real from Standard)
122
123	is static;
124
125
126	Perform(me: in out; Until: Shape from TopoDS)
127
128	is static;
129
130
131	Perform(me: in out; From : Shape from TopoDS;
132	Until: Shape from TopoDS)
133
134	is static;
135	---Purpose: Assigns one of the following semantics
136	-- - to a height Length
137	-- - to a face Until
138	-- - from a face From to a height Until.
139	-- Reconstructs the feature topologically according to the semantic option chosen.
140
141	PerformUntilEnd(me: in out)
142
143	is static;
144	--- Purpose: Realizes a semi-infinite prism, limited by the
145	-- position of the prism base. All other faces extend infinitely.
146
147	PerformFromEnd(me: in out; FUntil: Shape from TopoDS)
148
149	is static;
150	---Purpose: Realizes a semi-infinite prism, limited by the face Funtil.
151
152
153	PerformThruAll(me: in out)
154
155	is static;
156	---Purpose: Builds an infinite prism. The infinite descendants will not be kept in the result.
157
158	PerformUntilHeight(me: in out; Until : Shape from TopoDS;
159	Length: Real from Standard)
160
161	is static;
162	---Purpose: Assigns both a limiting shape, Until from
163	-- TopoDS_Shape, and a height, Length at which to stop generation of the prism feature.
164
165	Curves(me: in out; S : in out SequenceOfCurve from TColGeom);
166	--- Purpose: Returns the list of curves S parallel to the axis of the prism.
167
168	BarycCurve(me: in out)
169	returns Curve from Geom;
170	---Purpose: Generates a curve along the center of mass of the primitive.
171	fields
172
173	myPbase : Shape from TopoDS;
174	mySlface : DataMapOfShapeListOfShape from TopTools;
175	myDir : Dir from gp;
176	myCurves : SequenceOfCurve from TColGeom;
177	myBCurve : Curve from Geom;
178	myStatusError : StatusError from BRepFeat;
179
180	end MakePrism;