Chemical Data Processing Library C++ API - Version 1.2.0
Vis/ReactionFunctions.hpp
Go to the documentation of this file.
1 /*
2  * ReactionFunctions.hpp
3  *
4  * This file is part of the Chemical Data Processing Toolkit
5  *
6  * Copyright (C) 2003 Thomas Seidel <thomas.seidel@univie.ac.at>
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this library; see the file COPYING. If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23 
29 #ifndef CDPL_VIS_REACTIONFUNCTIONS_HPP
30 #define CDPL_VIS_REACTIONFUNCTIONS_HPP
31 
32 #include "CDPL/Vis/APIPrefix.hpp"
33 
34 
35 namespace CDPL
36 {
37 
38  namespace Chem
39  {
40 
41  class Reaction;
42  }
43 
44  namespace Vis
45  {
46 
47  class Color;
48  class SizeSpecification;
49 
50  CDPL_VIS_API unsigned int getArrowStyle(const Chem::Reaction& rxn);
51 
52  CDPL_VIS_API void setArrowStyle(Chem::Reaction& rxn, unsigned int style);
53 
55 
57 
58 
60 
61  CDPL_VIS_API void setArrowColor(Chem::Reaction& rxn, const Color& color);
62 
64 
66 
67 
69 
71 
73 
75 
76 
78 
80 
82 
84 
85 
87 
89 
91 
93 
94 
96 
98 
100 
102 
103 
105 
107 
109 
111 
112 
114 
115  CDPL_VIS_API void setComponentLayout(Chem::Reaction& rxn, unsigned int layout);
116 
118 
120 
121 
123 
125 
127 
129 
130 
132 
134 
136 
138 
139 
141 
143 
145 
147 
148 
150 
152 
154 
156 
157 
159 
161 
163 
165 
166 
168 
169  CDPL_VIS_API void setAgentAlignment(Chem::Reaction& rxn, unsigned int alignment);
170 
172 
174 
175 
176  CDPL_VIS_API unsigned int getAgentLayout(const Chem::Reaction& rxn);
177 
178  CDPL_VIS_API void setAgentLayout(Chem::Reaction& rxn, unsigned int layout);
179 
181 
183 
184 
186 
188 
190 
192 
193 
195 
197 
199 
201 
202 
204 
206 
208 
210 
211 
213 
215 
217 
219 
220 
222 
224 
226 
228  } // namespace Vis
229 } // namespace CDPL
230 
231 #endif // CDPL_VIS_REACTIONFUNCTIONS_HPP
Definition of the preprocessor macro CDPL_VIS_API.
#define CDPL_VIS_API
Tells the compiler/linker which classes, functions and variables are part of the library API.
Reaction.
Definition: Reaction.hpp:52
Specifies a color in terms of its red, green and blue components and an alpha-channel for transparenc...
Definition: Color.hpp:52
Specifies the value and type of a size attribute and defines how the value may change during processi...
Definition: SizeSpecification.hpp:45
VectorNorm2< E >::ResultType length(const VectorExpression< E > &e)
Definition: VectorExpression.hpp:553
CDPL_VIS_API void setAgentLayoutDirection(Chem::Reaction &rxn, unsigned int dir)
CDPL_VIS_API bool getShowAgents(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasComponentMargin(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasArrowLength(const Chem::Reaction &rxn)
CDPL_VIS_API void clearAgentAlignment(Chem::Reaction &rxn)
CDPL_VIS_API void clearComponentMargin(Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getArrowHeadLength(const Chem::Reaction &rxn)
CDPL_VIS_API void setComponentLayout(Chem::Reaction &rxn, unsigned int layout)
CDPL_VIS_API bool hasArrowLineWidth(const Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getArrowLineWidth(const Chem::Reaction &rxn)
CDPL_VIS_API bool getShowPlusSigns(const Chem::Reaction &rxn)
CDPL_VIS_API void clearShowReactants(Chem::Reaction &rxn)
CDPL_VIS_API const Color & getArrowColor(const Chem::Reaction &rxn)
CDPL_VIS_API void clearAgentLayout(Chem::Reaction &rxn)
CDPL_VIS_API void setArrowLength(Chem::Reaction &rxn, const SizeSpecification &length)
CDPL_VIS_API void clearPlusSignColor(Chem::Reaction &rxn)
CDPL_VIS_API unsigned int getArrowStyle(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasPlusSignColor(const Chem::Reaction &rxn)
CDPL_VIS_API void clearPlusSignLineWidth(Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getPlusSignLineWidth(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasPlusSignLineWidth(const Chem::Reaction &rxn)
CDPL_VIS_API bool getShowProducts(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasArrowStyle(const Chem::Reaction &rxn)
CDPL_VIS_API void clearShowPlusSigns(Chem::Reaction &rxn)
CDPL_VIS_API bool hasArrowShaftWidth(const Chem::Reaction &rxn)
CDPL_VIS_API void setShowProducts(Chem::Reaction &rxn, bool show)
CDPL_VIS_API bool hasShowPlusSigns(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasArrowHeadWidth(const Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getPlusSignSize(const Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getArrowLength(const Chem::Reaction &rxn)
CDPL_VIS_API void setArrowStyle(Chem::Reaction &rxn, unsigned int style)
CDPL_VIS_API void clearPlusSignSize(Chem::Reaction &rxn)
CDPL_VIS_API void setShowPlusSigns(Chem::Reaction &rxn, bool show)
CDPL_VIS_API void setPlusSignSize(Chem::Reaction &rxn, const SizeSpecification &size)
CDPL_VIS_API void clearComponentLayout(Chem::Reaction &rxn)
CDPL_VIS_API void clearShowProducts(Chem::Reaction &rxn)
CDPL_VIS_API unsigned int getAgentLayoutDirection(const Chem::Reaction &rxn)
CDPL_VIS_API void clearArrowHeadLength(Chem::Reaction &rxn)
CDPL_VIS_API void setAgentLayout(Chem::Reaction &rxn, unsigned int layout)
CDPL_VIS_API void clearArrowStyle(Chem::Reaction &rxn)
CDPL_VIS_API unsigned int getComponentLayoutDirection(const Chem::Reaction &rxn)
CDPL_VIS_API void clearArrowColor(Chem::Reaction &rxn)
CDPL_VIS_API void setArrowLineWidth(Chem::Reaction &rxn, const SizeSpecification &width)
CDPL_VIS_API unsigned int getComponentLayout(const Chem::Reaction &rxn)
CDPL_VIS_API unsigned int getAgentLayout(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasShowProducts(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasShowAgents(const Chem::Reaction &rxn)
CDPL_VIS_API void setPlusSignColor(Chem::Reaction &rxn, const Color &color)
CDPL_VIS_API void setShowReactants(Chem::Reaction &rxn, bool show)
CDPL_VIS_API void clearComponentLayoutDirection(Chem::Reaction &rxn)
CDPL_VIS_API bool hasAgentLayout(const Chem::Reaction &rxn)
CDPL_VIS_API void clearArrowLineWidth(Chem::Reaction &rxn)
CDPL_VIS_API void setShowAgents(Chem::Reaction &rxn, bool show)
CDPL_VIS_API void clearArrowHeadWidth(Chem::Reaction &rxn)
CDPL_VIS_API void clearArrowLength(Chem::Reaction &rxn)
CDPL_VIS_API bool hasPlusSignSize(const Chem::Reaction &rxn)
CDPL_VIS_API void setArrowHeadWidth(Chem::Reaction &rxn, const SizeSpecification &width)
CDPL_VIS_API void clearArrowShaftWidth(Chem::Reaction &rxn)
CDPL_VIS_API void setPlusSignLineWidth(Chem::Reaction &rxn, const SizeSpecification &width)
CDPL_VIS_API void clearShowAgents(Chem::Reaction &rxn)
CDPL_VIS_API void setComponentMargin(Chem::Reaction &rxn, const SizeSpecification &margin)
CDPL_VIS_API const SizeSpecification & getArrowHeadWidth(const Chem::Reaction &rxn)
CDPL_VIS_API void setAgentAlignment(Chem::Reaction &rxn, unsigned int alignment)
CDPL_VIS_API void setArrowHeadLength(Chem::Reaction &rxn, const SizeSpecification &length)
CDPL_VIS_API bool hasAgentLayoutDirection(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasAgentAlignment(const Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getArrowShaftWidth(const Chem::Reaction &rxn)
CDPL_VIS_API unsigned int getAgentAlignment(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasComponentLayout(const Chem::Reaction &rxn)
CDPL_VIS_API void setComponentLayoutDirection(Chem::Reaction &rxn, unsigned int dir)
CDPL_VIS_API bool hasShowReactants(const Chem::Reaction &rxn)
CDPL_VIS_API void clearAgentLayoutDirection(Chem::Reaction &rxn)
CDPL_VIS_API const Color & getPlusSignColor(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasArrowHeadLength(const Chem::Reaction &rxn)
CDPL_VIS_API void setArrowColor(Chem::Reaction &rxn, const Color &color)
CDPL_VIS_API bool getShowReactants(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasComponentLayoutDirection(const Chem::Reaction &rxn)
CDPL_VIS_API bool hasArrowColor(const Chem::Reaction &rxn)
CDPL_VIS_API const SizeSpecification & getComponentMargin(const Chem::Reaction &rxn)
CDPL_VIS_API void setArrowShaftWidth(Chem::Reaction &rxn, const SizeSpecification &width)
The namespace of the Chemical Data Processing Library.