[occt.git] / src / BRepToIGESBRep / BRepToIGESBRep_Entity.cdl

-- File:	BRepToIGESBRep_Entity.cdl
-- Created:	Tue Apr 25 11:39:19 1995
-- Author:	Marie Jose MARTZ
--		<mjm@pronox>
---Copyright:	 Matra Datavision 1995

class Entity from BRepToIGESBRep inherits BREntity from BRepToIGES


    ---Purpose : provides methods to transfer BRep entity from CASCADE to IGESBRep.

uses

    Geometry                 from Geom,
    Shape                    from TopoDS,
    Vertex                   from TopoDS,
    Edge                     from TopoDS,
    Wire                     from TopoDS,
    Face                     from TopoDS,
    Shell                    from TopoDS,
    Solid                    from TopoDS,
    CompSolid	             from TopoDS,
    Compound                 from TopoDS,
    IndexedMapOfShape        from TopTools,
    IndexedMapOfTransient    from TColStd,
    IGESEntity               from IGESData,
    IGESModel                from IGESData,
    VertexList               from IGESSolid,
    EdgeList                 from IGESSolid,
    Loop                     from IGESSolid,
    Face                     from IGESSolid,   
    Shell                    from IGESSolid, 
    ManifoldSolid            from IGESSolid,
    CString                  from Standard,
    FinderProcess            from Transfer

is

    Create 
    	returns Entity from BRepToIGESBRep;
    ---Purpose : Creates a tool Entity


    Clear              (me        : in out);
    ---Purpose : Clears the contents of the fields


    TransferVertexList (me        : in out);
    ---Purpose :  Create the VertexList entity 


    IndexVertex        (me; 
                        myvertex    : Vertex from TopoDS) 
    returns Integer
    ---Purpose: Returns the index of <myvertex> in "myVertices"
    is static;


    AddVertex          (me        : in out; 
                        myvertex  : Vertex from TopoDS) 
    returns Integer
    ---Purpose: Stores <myvertex> in "myVertices"
    --          Returns the index of <myvertex>.
    is static;
	

    TransferEdgeList   (me        : in out);
    ---Purpose :  Transfert an Edge entity from TopoDS to IGES


    IndexEdge          (me; 
                        myedge    : Edge from TopoDS) 
    returns Integer
    ---Purpose: Returns the index of <myedge> in "myEdges"
    is static;


    AddEdge            (me        : in out; 
                        myedge    : Edge from TopoDS;
			mycurve3d : IGESEntity from IGESData)
    returns Integer
    ---Purpose: Stores <myedge> in "myEdges" and <mycurve3d> in "myCurves".
    --           Returns the index of <myedge>.
    is static;
	

    TransferShape      (me : in out; start : Shape from TopoDS)
    returns IGESEntity from IGESData is redefined;
    ---Purpose : Returns the result of the transfert of any Shape
    --           If  the transfer has  failed, this member return a NullEntity.
	

    TransferEdge       (me        : in out;
                        myedge    : Edge     from TopoDS)
    returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert an Edge entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferEdge       (me        : in out;
                        myedge    : Edge     from TopoDS;
		        myface    : Face     from TopoDS;
                        length    : in Real   from Standard)		    				    
    returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert an Edge entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferWire       (me        : in out;
                        mywire    : Wire     from TopoDS;
		        myface    : Face     from TopoDS;
			length    : in Real   from Standard)		    
    returns mutable Loop from IGESSolid;
    ---Purpose :  Transfert a Wire entity from TopoDS to IGES.
    --            Returns the curve associated to mywire in the parametric space of myface.
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferFace       (me    : in out;
                        start : Face from TopoDS)
    returns mutable Face from IGESSolid;
    ---Purpose :  Transfert a Face entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferShell      (me    : in out;
                        start : Shell from TopoDS)
    returns mutable Shell from IGESSolid;
    ---Purpose :  Transfert an Shell entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferSolid      (me    : in out;
                        start : Solid from TopoDS)
    	 returns mutable ManifoldSolid from IGESSolid;
    ---Purpose :  Transfert a Solid entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferCompSolid  (me    : in out;
                        start : CompSolid from TopoDS)
    	 returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert an CompSolid entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.


    TransferCompound   (me    : in out;
                        start : Compound from TopoDS)
    	 returns mutable IGESEntity from IGESData;
    ---Purpose :  Transfert a Compound entity from TopoDS to IGES
    --            If this Entity could not be converted, this member returns a NullEntity.

fields

    myVertices    : IndexedMapOfShape from TopTools;
    myEdges       : IndexedMapOfShape from TopTools;
    myCurves      : IndexedMapOfTransient from TColStd;
    myEdgeList    : EdgeList from IGESSolid;
    myVertexList  : VertexList from IGESSolid;
    
    
end Entity;
Commit	Line	Data
7fd59977	1	-- File: BRepToIGESBRep_Entity.cdl
	2	-- Created: Tue Apr 25 11:39:19 1995
	3	-- Author: Marie Jose MARTZ
	4	-- <mjm@pronox>
	5	---Copyright: Matra Datavision 1995
	6
	7	class Entity from BRepToIGESBRep inherits BREntity from BRepToIGES
	8
	9
	10	---Purpose : provides methods to transfer BRep entity from CASCADE to IGESBRep.
	11
	12	uses
	13
	14	Geometry from Geom,
	15	Shape from TopoDS,
	16	Vertex from TopoDS,
	17	Edge from TopoDS,
	18	Wire from TopoDS,
	19	Face from TopoDS,
	20	Shell from TopoDS,
	21	Solid from TopoDS,
	22	CompSolid from TopoDS,
	23	Compound from TopoDS,
	24	IndexedMapOfShape from TopTools,
	25	IndexedMapOfTransient from TColStd,
	26	IGESEntity from IGESData,
	27	IGESModel from IGESData,
	28	VertexList from IGESSolid,
	29	EdgeList from IGESSolid,
	30	Loop from IGESSolid,
	31	Face from IGESSolid,
	32	Shell from IGESSolid,
	33	ManifoldSolid from IGESSolid,
	34	CString from Standard,
	35	FinderProcess from Transfer
	36
	37	is
	38
	39	Create
	40	returns Entity from BRepToIGESBRep;
	41	---Purpose : Creates a tool Entity
	42
	43
	44	Clear (me : in out);
	45	---Purpose : Clears the contents of the fields
	46
	47
	48	TransferVertexList (me : in out);
	49	---Purpose : Create the VertexList entity
	50
	51
	52	IndexVertex (me;
	53	myvertex : Vertex from TopoDS)
	54	returns Integer
	55	---Purpose: Returns the index of <myvertex> in "myVertices"
	56	is static;
	57
	58
	59	AddVertex (me : in out;
	60	myvertex : Vertex from TopoDS)
	61	returns Integer
	62	---Purpose: Stores <myvertex> in "myVertices"
	63	-- Returns the index of <myvertex>.
	64	is static;
65
66
67	TransferEdgeList (me : in out);
68	---Purpose : Transfert an Edge entity from TopoDS to IGES
69
70
71	IndexEdge (me;
72	myedge : Edge from TopoDS)
73	returns Integer
74	---Purpose: Returns the index of <myedge> in "myEdges"
75	is static;
76
77
78	AddEdge (me : in out;
79	myedge : Edge from TopoDS;
80	mycurve3d : IGESEntity from IGESData)
81	returns Integer
82	---Purpose: Stores <myedge> in "myEdges" and <mycurve3d> in "myCurves".
83	-- Returns the index of <myedge>.
84	is static;
85
86
87	TransferShape (me : in out; start : Shape from TopoDS)
88	returns IGESEntity from IGESData is redefined;
89	---Purpose : Returns the result of the transfert of any Shape
90	-- If the transfer has failed, this member return a NullEntity.
91
92
93	TransferEdge (me : in out;
94	myedge : Edge from TopoDS)
95	returns mutable IGESEntity from IGESData;
96	---Purpose : Transfert an Edge entity from TopoDS to IGES
97	-- If this Entity could not be converted, this member returns a NullEntity.
98
99
100	TransferEdge (me : in out;
101	myedge : Edge from TopoDS;
102	myface : Face from TopoDS;
103	length : in Real from Standard)
104	returns mutable IGESEntity from IGESData;
105	---Purpose : Transfert an Edge entity from TopoDS to IGES
106	-- If this Entity could not be converted, this member returns a NullEntity.
107
108
109	TransferWire (me : in out;
110	mywire : Wire from TopoDS;
111	myface : Face from TopoDS;
112	length : in Real from Standard)
113	returns mutable Loop from IGESSolid;
114	---Purpose : Transfert a Wire entity from TopoDS to IGES.
115	-- Returns the curve associated to mywire in the parametric space of myface.
116	-- If this Entity could not be converted, this member returns a NullEntity.
117
118
119	TransferFace (me : in out;
120	start : Face from TopoDS)
121	returns mutable Face from IGESSolid;
122	---Purpose : Transfert a Face entity from TopoDS to IGES
123	-- If this Entity could not be converted, this member returns a NullEntity.
124
125
126	TransferShell (me : in out;
127	start : Shell from TopoDS)
128	returns mutable Shell from IGESSolid;
129	---Purpose : Transfert an Shell entity from TopoDS to IGES
130	-- If this Entity could not be converted, this member returns a NullEntity.
131
132
133	TransferSolid (me : in out;
134	start : Solid from TopoDS)
135	returns mutable ManifoldSolid from IGESSolid;
136	---Purpose : Transfert a Solid entity from TopoDS to IGES
137	-- If this Entity could not be converted, this member returns a NullEntity.
138
139
140	TransferCompSolid (me : in out;
141	start : CompSolid from TopoDS)
142	returns mutable IGESEntity from IGESData;
143	---Purpose : Transfert an CompSolid entity from TopoDS to IGES
144	-- If this Entity could not be converted, this member returns a NullEntity.
145
146
147	TransferCompound (me : in out;
148	start : Compound from TopoDS)
149	returns mutable IGESEntity from IGESData;
150	---Purpose : Transfert a Compound entity from TopoDS to IGES
151	-- If this Entity could not be converted, this member returns a NullEntity.
152
153	fields
154
155	myVertices : IndexedMapOfShape from TopTools;
156	myEdges : IndexedMapOfShape from TopTools;
157	myCurves : IndexedMapOfTransient from TColStd;
158	myEdgeList : EdgeList from IGESSolid;
159	myVertexList : VertexList from IGESSolid;
160
161
162	end Entity;
163