File: getcurrentpoint.xml

package info (click to toggle)
php-doc 20100521-2
  • links: PTS, VCS
  • area: main
  • in suites: squeeze, wheezy
  • size: 59,992 kB
  • ctags: 4,085
  • sloc: xml: 796,833; php: 21,338; cpp: 500; sh: 117; makefile: 58; awk: 28
file content (164 lines) | stat: -rw-r--r-- 4,736 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 299113 $ -->

<refentry xml:id="cairocontext.getcurrentpoint" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>CairoContext::getCurrentPoint</refname>
  <refname>cairo_get_current_point</refname>
  <refpurpose>The getCurrentPoint purpose</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>Object oriented style (method):</para>
  <methodsynopsis>
   <modifier>public</modifier> <type>array</type><methodname>CairoContext::getCurrentPoint</methodname>
   <void />
  </methodsynopsis>
  <para>Procedural style:</para>
  <methodsynopsis>
   <type>array</type><methodname>cairo_get_current_point</methodname>
   <methodparam><type>CairoContext</type><parameter>context</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets the current point of the current path, which is conceptually the final point reached by the path so far.
  </para>
  <para>
   The current point is returned in the user-space coordinate system. If there is no defined current point or if cr is in an error status, x and y will both be set to 0.0. It is possible to check this in advance with <methodname>CairoContext::hasCurrentPoint</methodname>.
  </para>
  <para>
   Most path construction functions alter the current point. See the following for details on how they affect the current point: <methodname>CairoContext::newPath</methodname>, 
   <methodname>CairoContext::newSubPath</methodname>, <methodname>CairoContext::appendPath</methodname>, <methodname>CairoContext::closePath</methodname>, <methodname>CairoContext::moveTo</methodname>, 
   <methodname>CairoContext::lineTo</methodname>, <methodname>CairoContext::curveTo</methodname>, <methodname>CairoContext::relMoveTo</methodname>, 
   <methodname>CairoContext::relLineTo</methodname>, <methodname>CairoContext::relCurveTo</methodname>, 
   <methodname>CairoContext::arc</methodname>, <methodname>CairoContext::arcNegative</methodname>, <methodname>CairoContext::rectangle</methodname>, 
   <methodname>CairoContext::textPath</methodname>, <methodname>CairoContext::glyphPath</methodname>.
  </para>
  <para>
   Some functions use and alter the current point but do not otherwise change current path: <methodname>CairoContext::showText</methodname>.
  </para>
  <para>
   Some functions unset the current path and as a result, current point: <methodname>CairoContext::fill</methodname>, <methodname>CairoContext::stroke</methodname>.
  </para>
  
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>context</parameter></term>
     <listitem>
      <para>
       A valid <classname>CairoContext</classname> object.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   An array containing the x (index 0) and y (index 1) coordinates of the current point.
  </para>
 </refsect1>
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Object oriented style</title>
    <programlisting role="php">
<![CDATA[
<?php

$s = new CairoImageSurface(CairoFormat::ARGB32, 100, 100);
$c = new CairoContext($s);

$c->moveTo(10, 10);

var_dump($c->getCurrentPoint());

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(2) {
  [0]=>
  float(10)
  [1]=>
  float(10)
}
]]>
    </screen>
   </example>
  </para>
  <para>
   <example>
    <title>Procedural style</title>
    <programlisting role="php">
<![CDATA[
<?php

$s = cairo_image_surface_create(CAIRO_SURFACE_TYPE_IMAGE, 100, 100);
$c = cairo_create($s);

cairo_move_to($c, 10, 10);

var_dump(cairo_get_current_point($c));

?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
array(2) {
  [0]=>
  float(10)
  [1]=>
  float(10)
}
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>CairoContext::moveTo</methodname></member>
    <member><methodname>CairoContext::hasCurrentPoint</methodname></member>
   </simplelist>
  </para>
 </refsect1>
 
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->