text.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2015 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::text
26 
27 Description
28 
29 SourceFiles
30  text.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef text_H
35 #define text_H
36 
37 #include "geometryBase.H"
38 #include "Tuple2.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 class vtkRenderer;
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class text Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class text
52 :
53  public geometryBase
54 {
55 private:
56 
57  // Private Member Functions
58 
59  //- Disallow default bitwise copy construct
60  text(const text&);
61 
62  //- Disallow default bitwise assignment
63  void operator=(const text&);
64 
65 
66 protected:
67 
68  // Protected data
69 
70  //- Text
71  string string_;
72 
73  //- Position
75 
76  //- Size
77  scalar size_;
78 
79  //- Colour
81 
82  //- Bold flag
83  bool bold_;
84 
85 
86 public:
87 
88  // Constructors
89 
90  //- Construct from dictionary
91  text
92  (
94  const dictionary& dict,
96  );
97 
98 
99  //- Destructor
100  virtual ~text();
101 
102 
103  // Member Functions
104 
105  //- Add surface(s) to scene
106  virtual void addGeometryToScene
107  (
108  const scalar position,
109  vtkRenderer* renderer
110  );
111 
112  //- Update actors
113  virtual void updateActors(const scalar position);
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
Foam::text::~text
virtual ~text()
Destructor.
Definition: text.C:65
Foam::text::operator=
void operator=(const text &)
Disallow default bitwise assignment.
Foam::text::updateActors
virtual void updateActors(const scalar position)
Update actors.
Definition: text.C:104
Foam::word
A class for handling words, derived from string.
Definition: word.H:59
Foam::text::colour_
autoPtr< DataEntry< vector > > colour_
Colour.
Definition: text.H:79
Tuple2.H
Foam::text::string_
string string_
Text.
Definition: text.H:70
geometryBase.H
Foam::geometryBase
Definition: geometryBase.H:56
Foam::text::size_
scalar size_
Size.
Definition: text.H:76
Foam::runTimePostProcessing
Function object to generate images during run-time.
Definition: runTimePostProcessing.H:83
Foam::text::position_
Tuple2< scalar, scalar > position_
Position.
Definition: text.H:73
Foam::text::addGeometryToScene
virtual void addGeometryToScene(const scalar position, vtkRenderer *renderer)
Add surface(s) to scene.
Definition: text.C:72
Foam::geometryBase::colours
const HashPtrTable< DataEntry< vector >, word > & colours() const
Return reference to the colours.
Definition: geometryBase.C:143
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:137
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::geometryBase::parent
const runTimePostProcessing & parent() const
Return the reference to the parent function object.
Definition: geometryBase.C:118
Foam::autoPtr
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
Foam::HashPtrTable
A HashTable specialization for hashing pointers.
Definition: HashPtrTable.H:50
Foam::text::text
text(const text &)
Disallow default bitwise copy construct.
Foam::Tuple2< scalar, scalar >
Foam::text
Definition: text.H:50
Foam::DataEntry
Top level data entry class for use in dictionaries. Provides a mechanism to specify a variable as a c...
Definition: DataEntry.H:52
Foam::text::bold_
bool bold_
Bold flag.
Definition: text.H:82