[occt.git] / src / BRepPrimAPI / BRepPrimAPI_MakeRevol.cdl

-- File:	BRepPrimAPI_MakeRevol.cdl
-- Created:	Tue Oct 12 11:45:39 1993
-- Author:	Remi LEQUETTE
--		<rle@phylox>
---Copyright:	 Matra Datavision 1993


-- Modified by skv - Fri Mar  4 15:50:09 2005
-- Add methods for supporting history.

class MakeRevol from BRepPrimAPI inherits MakeSweep from BRepPrimAPI

	---Purpose: Class to make revolved sweep topologies.
	--          
	--          a revolved sweep is defined by :
	--          
	--          * A basis topology which is swept.
	--          
	--            The   basis topology  must   not  contain solids
	--            (neither composite solids.).
	--            
	--            The basis topology  may be copied  or  shared in
	--            the result.
	--            
	--          * A rotation axis and angle :
	--          
	--            - The axis is an Ax1 from gp.
	--            
	--            - The angle is in [0, 2*Pi].
	--            
	--            - The angle default value is 2*Pi.
	--          
	--          
	--          The result is a topology with a higher dimension :
	--          
	--            - Vertex -> Edge.
	--            - Edge   -> Face.
	--            - Wire   -> Shell.
	--            - Face   -> Solid.
	--            - Shell  -> CompSolid.
	--            
	--            Sweeping a Compound sweeps  the elements  of the
	--            compound  and creates    a  compound with    the
	--            results. 
	--           

uses
    Revol      from BRepSweep,
    Shape      from TopoDS,
    ListOfShape from TopTools,
    Edge       from TopoDS,
    Ax1        from gp

is

    Create (S    : Shape   from TopoDS;
    	    A    : Ax1     from gp;
	    D    : Real    from Standard;
    	    Copy : Boolean from Standard = Standard_False)
        ---Purpose: Builds the Revol of base S, axis  A and angle  D. If C
        --          is true, S is copied.
	---Level: Public
    returns MakeRevol from BRepPrimAPI;


    Create (S    : Shape   from TopoDS;
    	    A    : Ax1     from gp;
    	    Copy : Boolean from Standard = Standard_False)
        ---Purpose: Builds the Revol of base S, axis  A and angle 2*Pi. If
        --          C is true, S is copied.
	---Level: Public
    returns MakeRevol from BRepPrimAPI;


    Revol(me) returns Revol from BRepSweep
	---Purpose: Returns the internal sweeping algorithm.
	--          
	---C++: return const &
	---Level: Public
    is static;

    
    Build(me : in out)
    is redefined;
	---Purpose: Builds the resulting shape (redefined from MakeShape).
	---Level: Public    


    FirstShape (me : in out)
    	---Purpose: Returns the first shape of the revol  (coinciding with
    	--          the generating shape).
    returns Shape from TopoDS;


    LastShape (me : in out)
    	---Purpose: Returns the TopoDS Shape of the end of the revol.
    returns Shape from TopoDS;


    Generated (me: in out; S : Shape from TopoDS)
        ---C++: return const & 
        ---Level: Public
    returns ListOfShape from TopTools
    is redefined;

-- Modified by skv - Fri Mar  4 15:50:09 2005 Begin
-- Add methods for supporting history. 

    FirstShape (me : in out; theShape : Shape from TopoDS)
    	---Purpose: Returns the TopoDS Shape of the beginning of the revolution,
    	--          generated with theShape  (subShape of the generating shape).
    returns Shape from TopoDS
    is static;


    LastShape (me : in out; theShape : Shape from TopoDS)
    	---Purpose: Returns the TopoDS Shape of the end of the revolution,
    	--          generated with  theShape (subShape of the  generating shape).
    returns Shape from TopoDS
    is static;
 

    HasDegenerated(me) 
    	---Purpose: Check if there are degenerated edges in the result.
        ---Level: Public
    returns Boolean from Standard 
    is static;
 

    Degenerated(me)
        ---C++: return const & 
        ---Level: Public
    returns ListOfShape from TopTools
    is static;
 
-- Modified by skv - Fri Mar  4 15:50:09 2005 End

 
fields

    myRevol      :  Revol       from BRepSweep; 
    myDegenerated:  ListOfShape from TopTools;   -- skv
    

end MakeRevol;
Commit	Line	Data
7fd59977	1	-- File: BRepPrimAPI_MakeRevol.cdl
	2	-- Created: Tue Oct 12 11:45:39 1993
	3	-- Author: Remi LEQUETTE
	4	-- <rle@phylox>
	5	---Copyright: Matra Datavision 1993
	6
	7
	8	-- Modified by skv - Fri Mar 4 15:50:09 2005
	9	-- Add methods for supporting history.
	10
	11	class MakeRevol from BRepPrimAPI inherits MakeSweep from BRepPrimAPI
	12
	13	---Purpose: Class to make revolved sweep topologies.
	14	--
	15	-- a revolved sweep is defined by :
	16	--
	17	-- * A basis topology which is swept.
	18	--
	19	-- The basis topology must not contain solids
	20	-- (neither composite solids.).
	21	--
	22	-- The basis topology may be copied or shared in
	23	-- the result.
	24	--
	25	-- * A rotation axis and angle :
	26	--
	27	-- - The axis is an Ax1 from gp.
	28	--
	29	-- - The angle is in [0, 2*Pi].
	30	--
	31	-- - The angle default value is 2*Pi.
	32	--
	33	--
	34	-- The result is a topology with a higher dimension :
	35	--
	36	-- - Vertex -> Edge.
	37	-- - Edge -> Face.
	38	-- - Wire -> Shell.
	39	-- - Face -> Solid.
	40	-- - Shell -> CompSolid.
	41	--
	42	-- Sweeping a Compound sweeps the elements of the
	43	-- compound and creates a compound with the
	44	-- results.
	45	--
	46
	47	uses
	48	Revol from BRepSweep,
	49	Shape from TopoDS,
	50	ListOfShape from TopTools,
	51	Edge from TopoDS,
	52	Ax1 from gp
	53
	54	is
	55
	56	Create (S : Shape from TopoDS;
	57	A : Ax1 from gp;
	58	D : Real from Standard;
	59	Copy : Boolean from Standard = Standard_False)
	60	---Purpose: Builds the Revol of base S, axis A and angle D. If C
	61	-- is true, S is copied.
	62	---Level: Public
	63	returns MakeRevol from BRepPrimAPI;
	64
65
66	Create (S : Shape from TopoDS;
67	A : Ax1 from gp;
68	Copy : Boolean from Standard = Standard_False)
69	---Purpose: Builds the Revol of base S, axis A and angle 2*Pi. If
70	-- C is true, S is copied.
71	---Level: Public
72	returns MakeRevol from BRepPrimAPI;
73
74
75	Revol(me) returns Revol from BRepSweep
76	---Purpose: Returns the internal sweeping algorithm.
77	--
78	---C++: return const &
79	---Level: Public
80	is static;
81
82
83	Build(me : in out)
84	is redefined;
85	---Purpose: Builds the resulting shape (redefined from MakeShape).
86	---Level: Public
87
88
89	FirstShape (me : in out)
90	---Purpose: Returns the first shape of the revol (coinciding with
91	-- the generating shape).
92	returns Shape from TopoDS;
93
94
95	LastShape (me : in out)
96	---Purpose: Returns the TopoDS Shape of the end of the revol.
97	returns Shape from TopoDS;
98
99
100	Generated (me: in out; S : Shape from TopoDS)
101	---C++: return const &
102	---Level: Public
103	returns ListOfShape from TopTools
104	is redefined;
105
106	-- Modified by skv - Fri Mar 4 15:50:09 2005 Begin
107	-- Add methods for supporting history.
108
109	FirstShape (me : in out; theShape : Shape from TopoDS)
110	---Purpose: Returns the TopoDS Shape of the beginning of the revolution,
111	-- generated with theShape (subShape of the generating shape).
112	returns Shape from TopoDS
113	is static;
114
115
116	LastShape (me : in out; theShape : Shape from TopoDS)
117	---Purpose: Returns the TopoDS Shape of the end of the revolution,
118	-- generated with theShape (subShape of the generating shape).
119	returns Shape from TopoDS
120	is static;
121
122
123	HasDegenerated(me)
124	---Purpose: Check if there are degenerated edges in the result.
125	---Level: Public
126	returns Boolean from Standard
127	is static;
128
129
130	Degenerated(me)
131	---C++: return const &
132	---Level: Public
133	returns ListOfShape from TopTools
134	is static;
135
136	-- Modified by skv - Fri Mar 4 15:50:09 2005 End
137
138
139	fields
140
141	myRevol : Revol from BRepSweep;
142	myDegenerated: ListOfShape from TopTools; -- skv
143
144
145	end MakeRevol;