Imported Upstream version 1.63.0
[platform/upstream/boost.git] / libs / geometry / doc / doxy / doxygen_output / xml / classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer.xml
1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
3   <compounddef id="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer" kind="class" prot="public">
4     <compoundname>boost::geometry::strategy::transform::map_transformer</compoundname>
5     <basecompoundref refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1ublas__transformer" prot="public" virt="non-virtual">boost::geometry::strategy::transform::ublas_transformer&lt; CalculationType, Dimension1, Dimension2 &gt;</basecompoundref>
6     <includes local="no">map_transformer.hpp</includes>
7     <templateparamlist>
8       <param>
9         <type>typename CalculationType</type>
10       </param>
11       <param>
12         <type>std::size_t</type>
13         <declname>Dimension1</declname>
14         <defname>Dimension1</defname>
15       </param>
16       <param>
17         <type>std::size_t</type>
18         <declname>Dimension2</declname>
19         <defname>Dimension2</defname>
20       </param>
21       <param>
22         <type>bool</type>
23         <declname>Mirror</declname>
24         <defname>Mirror</defname>
25         <defval>false</defval>
26       </param>
27       <param>
28         <type>bool</type>
29         <declname>SameScale</declname>
30         <defname>SameScale</defname>
31         <defval>true</defval>
32       </param>
33     </templateparamlist>
34       <sectiondef kind="private-type">
35       <memberdef kind="typedef" id="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1a416db5cfd8ae96934826bdd3d04c4a2c" prot="private" static="no">
36         <type>boost::numeric::ublas::matrix&lt; CalculationType &gt;</type>
37         <definition>typedef boost::numeric::ublas::matrix&lt;CalculationType&gt; boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;::M</definition>
38         <argsstring></argsstring>
39         <name>M</name>
40         <briefdescription>
41         </briefdescription>
42         <detaileddescription>
43         </detaileddescription>
44         <inbodydescription>
45         </inbodydescription>
46         <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" line="51" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" bodystart="51" bodyend="-1"/>
47       </memberdef>
48       </sectiondef>
49       <sectiondef kind="public-func">
50       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aa0973e14c29879db15b67d63c571d7dd" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
51         <templateparamlist>
52           <param>
53             <type>typename B</type>
54           </param>
55           <param>
56             <type>typename D</type>
57           </param>
58         </templateparamlist>
59         <type></type>
60         <definition>boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;::map_transformer</definition>
61         <argsstring>(B const &amp;box, D const &amp;width, D const &amp;height)</argsstring>
62         <name>map_transformer</name>
63         <param>
64           <type>B const &amp;</type>
65           <declname>box</declname>
66         </param>
67         <param>
68           <type>D const &amp;</type>
69           <declname>width</declname>
70         </param>
71         <param>
72           <type>D const &amp;</type>
73           <declname>height</declname>
74         </param>
75         <briefdescription>
76         </briefdescription>
77         <detaileddescription>
78         </detaileddescription>
79         <inbodydescription>
80         </inbodydescription>
81         <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" line="55" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" bodystart="55" bodyend="61"/>
82       </memberdef>
83       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aec8d46f54b17a0e9f57386f43a566ccf" prot="public" static="no" const="no" explicit="yes" inline="yes" virt="non-virtual">
84         <templateparamlist>
85           <param>
86             <type>typename W</type>
87           </param>
88           <param>
89             <type>typename D</type>
90           </param>
91         </templateparamlist>
92         <type></type>
93         <definition>boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;::map_transformer</definition>
94         <argsstring>(W const &amp;wx1, W const &amp;wy1, W const &amp;wx2, W const &amp;wy2, D const &amp;width, D const &amp;height)</argsstring>
95         <name>map_transformer</name>
96         <param>
97           <type>W const &amp;</type>
98           <declname>wx1</declname>
99         </param>
100         <param>
101           <type>W const &amp;</type>
102           <declname>wy1</declname>
103         </param>
104         <param>
105           <type>W const &amp;</type>
106           <declname>wx2</declname>
107         </param>
108         <param>
109           <type>W const &amp;</type>
110           <declname>wy2</declname>
111         </param>
112         <param>
113           <type>D const &amp;</type>
114           <declname>width</declname>
115         </param>
116         <param>
117           <type>D const &amp;</type>
118           <declname>height</declname>
119         </param>
120         <briefdescription>
121         </briefdescription>
122         <detaileddescription>
123         </detaileddescription>
124         <inbodydescription>
125         </inbodydescription>
126         <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" line="64" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" bodystart="64" bodyend="68"/>
127       </memberdef>
128       </sectiondef>
129       <sectiondef kind="private-func">
130       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aaed2f446537b9e354cf10eb712bfd690" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
131         <templateparamlist>
132           <param>
133             <type>typename W</type>
134           </param>
135           <param>
136             <type>typename D</type>
137           </param>
138         </templateparamlist>
139         <type>void</type>
140         <definition>void boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;::set_transformation</definition>
141         <argsstring>(W const &amp;wx1, W const &amp;wy1, W const &amp;wx2, W const &amp;wy2, D const &amp;width, D const &amp;height)</argsstring>
142         <name>set_transformation</name>
143         <param>
144           <type>W const &amp;</type>
145           <declname>wx1</declname>
146         </param>
147         <param>
148           <type>W const &amp;</type>
149           <declname>wy1</declname>
150         </param>
151         <param>
152           <type>W const &amp;</type>
153           <declname>wx2</declname>
154         </param>
155         <param>
156           <type>W const &amp;</type>
157           <declname>wy2</declname>
158         </param>
159         <param>
160           <type>D const &amp;</type>
161           <declname>width</declname>
162         </param>
163         <param>
164           <type>D const &amp;</type>
165           <declname>height</declname>
166         </param>
167         <briefdescription>
168         </briefdescription>
169         <detaileddescription>
170         </detaileddescription>
171         <inbodydescription>
172         </inbodydescription>
173         <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" line="103" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" bodystart="103" bodyend="158"/>
174       </memberdef>
175       <memberdef kind="function" id="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aa295338b3acd1839be29734f587173e4" prot="private" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
176         <templateparamlist>
177           <param>
178             <type>typename W</type>
179           </param>
180           <param>
181             <type>typename P</type>
182           </param>
183           <param>
184             <type>typename S</type>
185           </param>
186         </templateparamlist>
187         <type>void</type>
188         <definition>void boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;::set_transformation_point</definition>
189         <argsstring>(W const &amp;wx, W const &amp;wy, P const &amp;px, P const &amp;py, S const &amp;scalex, S const &amp;scaley)</argsstring>
190         <name>set_transformation_point</name>
191         <param>
192           <type>W const &amp;</type>
193           <declname>wx</declname>
194         </param>
195         <param>
196           <type>W const &amp;</type>
197           <declname>wy</declname>
198         </param>
199         <param>
200           <type>P const &amp;</type>
201           <declname>px</declname>
202         </param>
203         <param>
204           <type>P const &amp;</type>
205           <declname>py</declname>
206         </param>
207         <param>
208           <type>S const &amp;</type>
209           <declname>scalex</declname>
210         </param>
211         <param>
212           <type>S const &amp;</type>
213           <declname>scaley</declname>
214         </param>
215         <briefdescription>
216         </briefdescription>
217         <detaileddescription>
218         </detaileddescription>
219         <inbodydescription>
220         </inbodydescription>
221         <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" line="73" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" bodystart="73" bodyend="99"/>
222       </memberdef>
223       </sectiondef>
224     <briefdescription>
225 <para>Transformation strategy to map from one to another Cartesian coordinate system. </para>    </briefdescription>
226     <detaileddescription>
227 <para><parameterlist kind="templateparam"><parameteritem>
228 <parameternamelist>
229 <parametername>Mirror</parametername>
230 </parameternamelist>
231 <parameterdescription>
232 <para>if true map is mirrored upside-down (in most cases pixels are from top to bottom, while map is from bottom to top) </para></parameterdescription>
233 </parameteritem>
234 </parameterlist>
235 </para>    </detaileddescription>
236     <inheritancegraph>
237       <node id="1539">
238         <label>boost::geometry::strategy::transform::ublas_transformer&lt; CalculationType, Dimension1, Dimension2 &gt;</label>
239         <link refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1ublas__transformer"/>
240       </node>
241       <node id="1538">
242         <label>boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;</label>
243         <link refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer"/>
244         <childnode refid="1539" relation="public-inheritance">
245         </childnode>
246       </node>
247     </inheritancegraph>
248     <collaborationgraph>
249       <node id="1541">
250         <label>boost::geometry::strategy::transform::ublas_transformer&lt; CalculationType, Dimension1, Dimension2 &gt;</label>
251         <link refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1ublas__transformer"/>
252       </node>
253       <node id="1540">
254         <label>boost::geometry::strategy::transform::map_transformer&lt; CalculationType, Dimension1, Dimension2, Mirror, SameScale &gt;</label>
255         <link refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer"/>
256         <childnode refid="1541" relation="public-inheritance">
257         </childnode>
258       </node>
259     </collaborationgraph>
260     <location file="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" line="50" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/transform/map_transformer.hpp" bodystart="48" bodyend="159"/>
261     <listofallmembers>
262       <member refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1a416db5cfd8ae96934826bdd3d04c4a2c" prot="private" virt="non-virtual"><scope>boost::geometry::strategy::transform::map_transformer</scope><name>M</name></member>
263       <member refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aa0973e14c29879db15b67d63c571d7dd" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::transform::map_transformer</scope><name>map_transformer</name></member>
264       <member refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aec8d46f54b17a0e9f57386f43a566ccf" prot="public" virt="non-virtual"><scope>boost::geometry::strategy::transform::map_transformer</scope><name>map_transformer</name></member>
265       <member refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aaed2f446537b9e354cf10eb712bfd690" prot="private" virt="non-virtual"><scope>boost::geometry::strategy::transform::map_transformer</scope><name>set_transformation</name></member>
266       <member refid="classboost_1_1geometry_1_1strategy_1_1transform_1_1map__transformer_1aa295338b3acd1839be29734f587173e4" prot="private" virt="non-virtual"><scope>boost::geometry::strategy::transform::map_transformer</scope><name>set_transformation_point</name></member>
267     </listofallmembers>
268   </compounddef>
269 </doxygen>