[occt.git] / src / BRepMesh / BRepMesh_VertexTool.cdl

-- File:        BRepMesh_VertexTool.cdl
-- Created:     Jun 2 11:35:21 2011
-- Author:      Oleg AGASHIN
---Copyright:   Open CASCADE SAS 2011


class VertexTool from BRepMesh 

  ---Purpose: Describes the data structure necessary for the
  --          mesh algorithm and contains the vertices in UV space.

  uses    Boolean from Standard,
          Integer from Standard,
          Real from Standard,
          XY from gp,
          ListOfInteger from BRepMesh,
          VertexCellFilter from BRepMesh,
          VertexInspector from BRepMesh,
          BaseAllocator from BRepMesh,
          Vertex from BRepMesh,
          DataMapOfIntegerListOfInteger from BRepMesh,
          Array1OfReal from TColStd

  is      Create (theAlloc : in BaseAllocator from BRepMesh)
          returns VertexTool from BRepMesh;


          Create     (nbComp   : in Integer from Standard;
                      theAlloc : in BaseAllocator from BRepMesh)
             ---Purpose: Constructs a VertexTool with an  evaluation of the
             --          number of vertices.
             returns VertexTool from BRepMesh;

          SetCellSize(me                 : in out;
                      theSize            : in Real from Standard)
            ---Purpose: Sets new size for cellfilter.
            is static;
            
          SetCellSize(me                 : in out;
                       theXSize            : in Real from Standard;
                       theYSize            : in Real from Standard)
             ---Purpose: Sets new size for cellfilter.
             is static;

          SetTolerance(me                 : in out;
                      theTol            : in Real from Standard)
            ---Purpose: Sets new size for cellfilter.
            is static;
            
          SetTolerance(me                 : in out;
                       theTolX            : in Real from Standard;
                       theTolY            : in Real from Standard)
             ---Purpose: Sets new size for cellfilter.
             is static;

          Add       (me       : in out;
                     theVertex: in Vertex from BRepMesh;
                     theParams: in ListOfInteger from BRepMesh)
            ---Purpose: Adds a vertex to the tool.
            returns Integer from Standard is static;

          Add       (me       : in out;
                     theVertex: in Vertex from BRepMesh)
            ---Purpose: Adds a vertex to the tool.
            returns Integer from Standard is static;

          Delete   (me : in out; theIndex : Integer from Standard) 
            ---Purpose: Deletes a vertex from the tool.
            is static;

          FindFromIndex   (me; theIndex : Integer from Standard)
            ---Purpose: Returns data assigned to theIndex.
            ---C++: alias operator() 
            ---C++: return &
            returns ListOfInteger from BRepMesh is static;
          
          FindKey   (me: out; theIndex: Integer from Standard)
            ---Purpose: Selects the vertex by theIndex.
            ---C++: return const &
            returns Vertex from BRepMesh is static;
            
          FindIndex (me: out;
	  	     theVertex: Vertex from BRepMesh)
            ---Purpose: Returns an index of theVertex.
            returns Integer from Standard is static;
            
          Extent    (me)
            ---Purpose: Returns a number of vertices.
            returns Integer from Standard is static;
            
          IsEmpty   (me)
            ---Purpose: Returns True when the map contains no keys.
            returns Boolean from Standard is static;
          
          Substitute(me: in out; Index: Integer from Standard;
                     theVertex: Vertex from BRepMesh;
                     theData  : ListOfInteger from BRepMesh)
            ---Purpose: Substitutes vertex with Index on
            --          theVertex with attributes theData.
            is static;
            
          RemoveLast(me: out)
            ---Purpose: Remove last node from the structure.
            is static;
            
          GetListOfDelNodes(me)
            ---Purpose: Returns the list with indexes of
            --          vertices that have Movability attribute
            --          equal to BRepMesh_Deleted and can be 
            --          replaced with another node.
            ---C++: return const &
            returns ListOfInteger from BRepMesh
            is static;
            
          ExpandPoint(me: in out;
                      thePnt: in XY from gp;
                      theMinPnt: out XY from gp;
                      theMaxPnt: out XY from gp)
            is static private;
            
          Statistics(me; S: in out OStream from Standard)
            ---Purpose: Prints statistics.
            is static;
            
  fields  myAllocator    : BaseAllocator from BRepMesh;
          myCellFilter   : VertexCellFilter from BRepMesh;
          mySelector     : VertexInspector from BRepMesh;
          myLinksMap     : DataMapOfIntegerListOfInteger from BRepMesh;
          myTol          : Array1OfReal from TColStd;

end CircleTool;
Commit	Line	Data
	1	-- File: BRepMesh_VertexTool.cdl
	2	-- Created: Jun 2 11:35:21 2011
	3	-- Author: Oleg AGASHIN
	4	---Copyright: Open CASCADE SAS 2011
	5
	6
	7	class VertexTool from BRepMesh
	8
	9	---Purpose: Describes the data structure necessary for the
	10	-- mesh algorithm and contains the vertices in UV space.
	11
	12	uses Boolean from Standard,
	13	Integer from Standard,
	14	Real from Standard,
	15	XY from gp,
	16	ListOfInteger from BRepMesh,
	17	VertexCellFilter from BRepMesh,
	18	VertexInspector from BRepMesh,
	19	BaseAllocator from BRepMesh,
	20	Vertex from BRepMesh,
	21	DataMapOfIntegerListOfInteger from BRepMesh,
	22	Array1OfReal from TColStd
	23
	24	is Create (theAlloc : in BaseAllocator from BRepMesh)
	25	returns VertexTool from BRepMesh;
	26
	27
	28	Create (nbComp : in Integer from Standard;
	29	theAlloc : in BaseAllocator from BRepMesh)
	30	---Purpose: Constructs a VertexTool with an evaluation of the
	31	-- number of vertices.
	32	returns VertexTool from BRepMesh;
	33
	34	SetCellSize(me : in out;
	35	theSize : in Real from Standard)
	36	---Purpose: Sets new size for cellfilter.
	37	is static;
	38
	39	SetCellSize(me : in out;
	40	theXSize : in Real from Standard;
	41	theYSize : in Real from Standard)
	42	---Purpose: Sets new size for cellfilter.
	43	is static;
	44
	45	SetTolerance(me : in out;
	46	theTol : in Real from Standard)
	47	---Purpose: Sets new size for cellfilter.
	48	is static;
	49
	50	SetTolerance(me : in out;
	51	theTolX : in Real from Standard;
	52	theTolY : in Real from Standard)
	53	---Purpose: Sets new size for cellfilter.
	54	is static;
	55
	56	Add (me : in out;
	57	theVertex: in Vertex from BRepMesh;
	58	theParams: in ListOfInteger from BRepMesh)
	59	---Purpose: Adds a vertex to the tool.
	60	returns Integer from Standard is static;
	61
	62	Add (me : in out;
	63	theVertex: in Vertex from BRepMesh)
	64	---Purpose: Adds a vertex to the tool.
	65	returns Integer from Standard is static;
	66
	67	Delete (me : in out; theIndex : Integer from Standard)
	68	---Purpose: Deletes a vertex from the tool.
	69	is static;
	70
	71	FindFromIndex (me; theIndex : Integer from Standard)
	72	---Purpose: Returns data assigned to theIndex.
	73	---C++: alias operator()
	74	---C++: return &
	75	returns ListOfInteger from BRepMesh is static;
	76
	77	FindKey (me: out; theIndex: Integer from Standard)
	78	---Purpose: Selects the vertex by theIndex.
	79	---C++: return const &
	80	returns Vertex from BRepMesh is static;
	81
	82	FindIndex (me: out;
	83	theVertex: Vertex from BRepMesh)
	84	---Purpose: Returns an index of theVertex.
	85	returns Integer from Standard is static;
	86
	87	Extent (me)
	88	---Purpose: Returns a number of vertices.
	89	returns Integer from Standard is static;
	90
	91	IsEmpty (me)
	92	---Purpose: Returns True when the map contains no keys.
	93	returns Boolean from Standard is static;
	94
	95	Substitute(me: in out; Index: Integer from Standard;
	96	theVertex: Vertex from BRepMesh;
	97	theData : ListOfInteger from BRepMesh)
	98	---Purpose: Substitutes vertex with Index on
	99	-- theVertex with attributes theData.
	100	is static;
	101
	102	RemoveLast(me: out)
	103	---Purpose: Remove last node from the structure.
	104	is static;
	105
	106	GetListOfDelNodes(me)
	107	---Purpose: Returns the list with indexes of
	108	-- vertices that have Movability attribute
	109	-- equal to BRepMesh_Deleted and can be
	110	-- replaced with another node.
	111	---C++: return const &
	112	returns ListOfInteger from BRepMesh
	113	is static;
	114
	115	ExpandPoint(me: in out;
	116	thePnt: in XY from gp;
	117	theMinPnt: out XY from gp;
	118	theMaxPnt: out XY from gp)
	119	is static private;
	120
	121	Statistics(me; S: in out OStream from Standard)
	122	---Purpose: Prints statistics.
	123	is static;
	124
	125	fields myAllocator : BaseAllocator from BRepMesh;
	126	myCellFilter : VertexCellFilter from BRepMesh;
	127	mySelector : VertexInspector from BRepMesh;
	128	myLinksMap : DataMapOfIntegerListOfInteger from BRepMesh;
	129	myTol : Array1OfReal from TColStd;
	130
	131	end CircleTool;