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

-- File:       BRepMesh_IncrementalMesh.cdl
-- Created:    Tue Jun 20 10:19:28 1995
-- Author:     Stagiaire Alain JOURDAIN <ajo@phobox>
--
---Copyright:  Matra Datavision 1995

class IncrementalMesh from BRepMesh

inherits DiscretRoot from BRepMesh

    ---Purpose: Builds the mesh of a shape with respect of their
    --          correctly triangulated parts
    --

uses
    Box from Bnd,
    Shape from TopoDS,
    Face  from TopoDS,
    Edge  from TopoDS,
    MapOfShape  from TopTools,
    IndexedDataMapOfShapeListOfShape from TopTools,
    DataMapOfShapeReal from TopTools,
    FastDiscret  from BRepMesh,
    Status       from BRepMesh,
    PDiscretRoot from BRepMesh

is
    Create
        returns IncrementalMesh from BRepMesh;
    ---C++: alias "Standard_EXPORT virtual ~BRepMesh_IncrementalMesh();"

    Create (S       : Shape   from TopoDS;
            D       : Real    from Standard;
            Relatif : Boolean from Standard = Standard_False;
            Ang     : Real    from Standard = 0.5)
        returns IncrementalMesh from BRepMesh;
    ---Purpose: If the  boolean    <Relatif>   is  True,    the
    --          deflection used   for the polygonalisation   of
    --          each edge will be <D> * Size of Edge.
    --          the deflection used for the faces will be the maximum
    --          deflection of their edges.

    SetRelative (     me : mutable;
                 theFlag : Boolean from Standard);

    Relative (me)
        returns Boolean from Standard;

    Init (me : mutable)
        is redefined protected;

    Perform (me : mutable)
        is redefined;

    Update (me : mutable;
             S : Shape from TopoDS)
        is static;
    ---Purpose: Builds the incremental mesh of the shape

    IsModified (me)
        returns Boolean from Standard
        is static;

    Update (me : mutable;
            E  : Edge from TopoDS)
        is static private;
    ---Purpose: Locate a correct discretisation if it exists
    --          Set no one otherwise

    Update (me : mutable;
            F  : Face from TopoDS)
        is static private;
    ---Purpose: If the face is  not correctly triangulated, or
    --          if  one  of its edges  is  to be discretisated
    --          correctly, the triangulation  of this face  is
    --          built.

    GetStatusFlags (me)
        returns Integer from Standard
        is static;

    SetParallel (           me : mutable;
                 theInParallel : Boolean from Standard);
    ---Purpose:
    -- Request algorithm to launch in multiple threads to improve performance.

    IsParallel (me)
        returns Boolean from Standard;
    ---Purpose:
    -- Returns the multi-threading usage flag.

    --
    --  Plugin interface
    --
    Discret (myclass;
             theShape      : Shape from TopoDS;
             theDeflection : Real from Standard;
             theAngle      : Real from Standard;
             theAlgo       : out PDiscretRoot from BRepMesh)
        returns Integer from Standard;
    ---Purpose:
    -- Plugin interface for the Mesh Factories.

    IsParallelDefault (myclass)
        returns Boolean from Standard;
    ---Purpose:
    -- Returns multi-threading usage flag set by default in
    -- Discret() static method (thus applied only to Mesh Factories).

    SetParallelDefault (myclass;
                        theInParallel : Boolean from Standard);
    ---Purpose:
    -- Setup multi-threading usage flag set by default in
    -- Discret() static method (thus applied only to Mesh Factories).

fields
    myRelative   : Boolean     from Standard is protected;
    myInParallel : Boolean     from Standard is protected;
    myMap        : MapOfShape  from TopTools is protected;
    myMesh       : FastDiscret from BRepMesh is protected;
    myModified   : Boolean     from Standard is protected;
    mymapedge    : DataMapOfShapeReal from TopTools is protected;
    myancestors  : IndexedDataMapOfShapeListOfShape from TopTools is protected;
    mydtotale    : Real from Standard is protected;
    myBox        : Box  from Bnd is protected;
    myStatus     : Integer from Standard is protected;

end IncrementalMesh;
Commit	Line	Data
0b97567d K	1	-- File: BRepMesh_IncrementalMesh.cdl
	2	-- Created: Tue Jun 20 10:19:28 1995
	3	-- Author: Stagiaire Alain JOURDAIN <ajo@phobox>
	4	--
	5	---Copyright: Matra Datavision 1995
7fd59977	6
7fd59977	7	class IncrementalMesh from BRepMesh
7fd59977	8
0b97567d K	9	inherits DiscretRoot from BRepMesh
	10
	11	---Purpose: Builds the mesh of a shape with respect of their
	12	-- correctly triangulated parts
	13	--
7fd59977	14
0b97567d	15	uses
7fd59977	16	Box from Bnd,
	17	Shape from TopoDS,
	18	Face from TopoDS,
	19	Edge from TopoDS,
	20	MapOfShape from TopTools,
	21	IndexedDataMapOfShapeListOfShape from TopTools,
	22	DataMapOfShapeReal from TopTools,
0b97567d K	23	FastDiscret from BRepMesh,
	24	Status from BRepMesh,
	25	PDiscretRoot from BRepMesh
7fd59977	26
0b97567d	27	is
7fd59977	28	Create
0b97567d	29	returns IncrementalMesh from BRepMesh;
7fd59977	30	---C++: alias "Standard_EXPORT virtual ~BRepMesh_IncrementalMesh();"
0b97567d K	31
	32	Create (S : Shape from TopoDS;
	33	D : Real from Standard;
	34	Relatif : Boolean from Standard = Standard_False;
	35	Ang : Real from Standard = 0.5)
	36	returns IncrementalMesh from BRepMesh;
	37	---Purpose: If the boolean <Relatif> is True, the
	38	-- deflection used for the polygonalisation of
	39	-- each edge will be <D> * Size of Edge.
	40	-- the deflection used for the faces will be the maximum
	41	-- deflection of their edges.
	42
	43	SetRelative ( me : mutable;
	44	theFlag : Boolean from Standard);
	45
	46	Relative (me)
	47	returns Boolean from Standard;
	48
	49	Init (me : mutable)
	50	is redefined protected;
	51
	52	Perform (me : mutable)
	53	is redefined;
	54
	55	Update (me : mutable;
	56	S : Shape from TopoDS)
	57	is static;
	58	---Purpose: Builds the incremental mesh of the shape
	59
	60	IsModified (me)
	61	returns Boolean from Standard
	62	is static;
	63
	64	Update (me : mutable;
	65	E : Edge from TopoDS)
	66	is static private;
	67	---Purpose: Locate a correct discretisation if it exists
	68	-- Set no one otherwise
	69
	70	Update (me : mutable;
	71	F : Face from TopoDS)
	72	is static private;
	73	---Purpose: If the face is not correctly triangulated, or
	74	-- if one of its edges is to be discretisated
	75	-- correctly, the triangulation of this face is
	76	-- built.
	77
	78	GetStatusFlags (me)
	79	returns Integer from Standard
	80	is static;
	81
	82	SetParallel ( me : mutable;
	83	theInParallel : Boolean from Standard);
	84	---Purpose:
	85	-- Request algorithm to launch in multiple threads to improve performance.
	86
	87	IsParallel (me)
	88	returns Boolean from Standard;
	89	---Purpose:
	90	-- Returns the multi-threading usage flag.
	91
	92	--
	93	-- Plugin interface
	94	--
95	Discret (myclass;
96	theShape : Shape from TopoDS;
97	theDeflection : Real from Standard;
98	theAngle : Real from Standard;
99	theAlgo : out PDiscretRoot from BRepMesh)
100	returns Integer from Standard;
101	---Purpose:
102	-- Plugin interface for the Mesh Factories.
103
104	IsParallelDefault (myclass)
105	returns Boolean from Standard;
106	---Purpose:
107	-- Returns multi-threading usage flag set by default in
108	-- Discret() static method (thus applied only to Mesh Factories).
109
110	SetParallelDefault (myclass;
111	theInParallel : Boolean from Standard);
112	---Purpose:
113	-- Setup multi-threading usage flag set by default in
114	-- Discret() static method (thus applied only to Mesh Factories).
115
7fd59977	116	fields
7fd59977	117	myRelative : Boolean from Standard is protected;
0b97567d	118	myInParallel : Boolean from Standard is protected;
7fd59977	119	myMap : MapOfShape from TopTools is protected;
	120	myMesh : FastDiscret from BRepMesh is protected;
	121	myModified : Boolean from Standard is protected;
0b97567d	122	mymapedge : DataMapOfShapeReal from TopTools is protected;
7fd59977	123	myancestors : IndexedDataMapOfShapeListOfShape from TopTools is protected;
	124	mydtotale : Real from Standard is protected;
	125	myBox : Box from Bnd is protected;
d51c7072	126	myStatus : Integer from Standard is protected;
7fd59977	127
7fd59977	128	end IncrementalMesh;