OCC22357 Hidden face selection
[occt.git] / src / MeshVS / MeshVS_TextPrsBuilder.cdl
1 -- File     : MeshVS_TextPrsBuilder.cdl
2 -- Created  : 13 October 2003
3 -- Author   : Alexander SOLOVYOV
4 ---Copyright: Open CASCADE 2003
5
6 class TextPrsBuilder from MeshVS inherits PrsBuilder from MeshVS
7
8         ---Purpose: This class provides methods to create text data presentation.
9         -- It store map of texts assigned with nodes or elements.
10
11 uses
12   Real from Standard,
13
14   Presentation from Prs3d,
15
16   Boolean from Standard,
17   Integer from Standard,
18
19   Mesh                        from MeshVS,
20   MeshPtr                     from MeshVS,
21   DisplayModeFlags            from MeshVS,
22   DataSource                  from MeshVS,
23   DataMapOfIntegerAsciiString from MeshVS,
24   BuilderPriority             from MeshVS,
25   Color                       from Quantity,
26   AsciiString                 from TCollection,
27   PackedMapOfInteger          from TColStd
28
29 is
30
31   Create  ( Parent   : Mesh from MeshVS;
32             Height   : Real;
33             Color    : Color from Quantity;
34             Flags    : DisplayModeFlags from MeshVS = MeshVS_DMF_TextDataPrs;
35             DS       : DataSource from MeshVS = 0;
36             Id       : Integer = -1;
37             Priority : BuilderPriority from MeshVS = MeshVS_BP_Text ) returns mutable TextPrsBuilder from MeshVS;
38
39   Build   ( me; Prs        : Presentation from Prs3d;
40             IDs            : PackedMapOfInteger;
41             IDsToExclude   : in out PackedMapOfInteger;
42             IsElement      : Boolean;
43             theDisplayMode : Integer ) is virtual;
44         ---Purpose: Builds presentation of text data
45
46   GetTexts ( me; IsElement : Boolean ) returns DataMapOfIntegerAsciiString from MeshVS;
47         ---C++: return const &
48         ---Purpose: Returns map of text assigned with nodes ( IsElement = False ) or elements ( IsElement = True )
49
50   SetTexts ( me : mutable;
51              IsElement     : Boolean;
52              Map           : DataMapOfIntegerAsciiString from MeshVS );
53         ---Purpose: Sets map of text assigned with nodes or elements
54
55   HasTexts ( me; IsElement : Boolean )    returns Boolean;
56         ---Purpose: Returns True if map isn't empty
57
58   GetText  ( me; IsElement : Boolean;
59              ID            : Integer;
60              Text          : out AsciiString from TCollection )   returns Boolean;
61         ---Purpose: Returns text assigned with single node or element
62
63   SetText  ( me : mutable;
64              IsElement     : Boolean;
65              ID            : Integer;
66              Text          : AsciiString from TCollection );
67         ---Purpose: Sets text assigned with single node or element
68
69 fields
70   myNodeTextMap         : DataMapOfIntegerAsciiString from MeshVS;
71   myElemTextMap         : DataMapOfIntegerAsciiString from MeshVS;
72
73 end TextPrsBuilder;