1 -- Created on: 2003-10-13
2 -- Created by: Alexander SOLOVYOV
3 -- Copyright (c) 2003-2014 OPEN CASCADE SAS
5 -- This file is part of Open CASCADE Technology software library.
7 -- This library is free software; you can redistribute it and / or modify it
8 -- under the terms of the GNU Lesser General Public version 2.1 as published
9 -- by the Free Software Foundation, with special exception defined in the file
10 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 -- distribution for complete text of the license and disclaimer of any warranty.
13 -- Alternatively, this file may be used under the terms of Open CASCADE
14 -- commercial license or contractual agreement.
16 class TextPrsBuilder from MeshVS inherits PrsBuilder from MeshVS
18 ---Purpose: This class provides methods to create text data presentation.
19 -- It store map of texts assigned with nodes or elements.
24 Presentation from Prs3d,
26 Boolean from Standard,
27 Integer from Standard,
31 DisplayModeFlags from MeshVS,
32 DataSource from MeshVS,
33 DataMapOfIntegerAsciiString from MeshVS,
34 BuilderPriority from MeshVS,
36 AsciiString from TCollection,
37 PackedMapOfInteger from TColStd
41 Create ( Parent : Mesh from MeshVS;
43 Color : Color from Quantity;
44 Flags : DisplayModeFlags from MeshVS = MeshVS_DMF_TextDataPrs;
45 DS : DataSource from MeshVS = 0;
47 Priority : BuilderPriority from MeshVS = MeshVS_BP_Text ) returns mutable TextPrsBuilder from MeshVS;
49 Build ( me; Prs : Presentation from Prs3d;
50 IDs : PackedMapOfInteger;
51 IDsToExclude : in out PackedMapOfInteger;
53 theDisplayMode : Integer ) is virtual;
54 ---Purpose: Builds presentation of text data
56 GetTexts ( me; IsElement : Boolean ) returns DataMapOfIntegerAsciiString from MeshVS;
57 ---C++: return const &
58 ---Purpose: Returns map of text assigned with nodes ( IsElement = False ) or elements ( IsElement = True )
60 SetTexts ( me : mutable;
62 Map : DataMapOfIntegerAsciiString from MeshVS );
63 ---Purpose: Sets map of text assigned with nodes or elements
65 HasTexts ( me; IsElement : Boolean ) returns Boolean;
66 ---Purpose: Returns True if map isn't empty
68 GetText ( me; IsElement : Boolean;
70 Text : out AsciiString from TCollection ) returns Boolean;
71 ---Purpose: Returns text assigned with single node or element
73 SetText ( me : mutable;
76 Text : AsciiString from TCollection );
77 ---Purpose: Sets text assigned with single node or element
80 myNodeTextMap : DataMapOfIntegerAsciiString from MeshVS;
81 myElemTextMap : DataMapOfIntegerAsciiString from MeshVS;