final class lineObj (View source)

Properties

int $numpoints read-only

Methods

__construct()

No description

ms_newLineObj()

Old style constructor

int
add(pointObj $point)

Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE.

int
addXY(float $x, float $y, float $m)

Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE.

int
addXYZ(float $x, float $y, float $z, float $m)

Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE.

point(int $i)

Returns a reference to point number i.

int
project(projectionObj $in, projectionObj $out)

Project the line from "in" projection (1st argument) to "out" projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE.

Details

final __construct()

No description

final lineObj ms_newLineObj()

Old style constructor

Return Value

lineObj

final int add(pointObj $point)

Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE.

Parameters

pointObj $point

Return Value

int

final int addXY(float $x, float $y, float $m)

Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE.

.. note:: the 3rd parameter m is used for measured shape files only. It is not mandatory.

Parameters

float $x
float $y
float $m

Return Value

int

final int addXYZ(float $x, float $y, float $z, float $m)

Add a point to the end of line. Returns MS_SUCCESS/MS_FAILURE.

.. note:: the 4th parameter m is used for measured shape files only. It is not mandatory.

Parameters

float $x
float $y
float $z
float $m

Return Value

int

final pointObj point(int $i)

Returns a reference to point number i.

Parameters

int $i

Return Value

pointObj

final int project(projectionObj $in, projectionObj $out)

Project the line from "in" projection (1st argument) to "out" projection (2nd argument). Returns MS_SUCCESS/MS_FAILURE.

Parameters

projectionObj $in
projectionObj $out

Return Value

int