CairoContext::getCurrentPoint

(PECL cairo >= 0.1.0)

The getCurrentPoint purpose

public array CairoContext::getCurrentPoint ( void )

Object oriented style

Procedural style

array cairo_get_current_point ( CairoContext $context )

Gets the current point of the current path, which is conceptually the final point reached by the path so far.

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 CairoContext::hasCurrentPoint().

Most path construction functions alter the current point. See the following for details on how they affect the current point: CairoContext::newPath(), CairoContext::newSubPath(), CairoContext::appendPath(), CairoContext::closePath(), CairoContext::moveTo(), CairoContext::lineTo(), CairoContext::curveTo(), CairoContext::relMoveTo(), CairoContext::relLineTo(), CairoContext::relCurveTo(), CairoContext::arc(), CairoContext::arcNegative(), CairoContext::rectangle(), CairoContext::textPath(), CairoContext::glyphPath().

Some functions use and alter the current point but do not otherwise change current path: CairoContext::showText().

Some functions unset the current path and as a result, current point: CairoContext::fill(), CairoContext::stroke().

Parameters:

context

A valid CairoContext object.

Returns:

An array containing the x (index 0) and y (index 1) coordinates of the current point.

Examples:

Object oriented style

<?php
 
$s = new CairoImageSurface(CairoFormat::ARGB32, 100, 100);
$c = new CairoContext($s);
 
$c->moveTo(10, 10);
 
var_dump($c->getCurrentPoint());
 
?>

The above example will output something similar to:

array(2) {
  [0]=>
  float(10)
  [1]=>
  float(10)
}

Procedural style

<?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));
 
?>

The above example will output something similar to:

array(2) {
  [0]=>
  float(10)
  [1]=>
  float(10)
}