PHP Class League\Geotools\Vertex\Vertex

Author: Antoine Corcy ([email protected])
Inheritance: extends League\Geotools\AbstractGeotools, implements League\Geotools\Vertex\VertexInterface
Show file Open project: toin0u/geotools Class Usage Examples

Protected Properties

Property Type Description
$gradient integer
$ordinateIntercept integer

Public Methods

Method Description
destination ( integer $bearing, integer $distance ) : League\Geotools\Coordinate\CoordinateInterface Returns the destination point with a given bearing in degrees travelling along a (shortest distance) great circle arc and a distance in meters.
finalBearing ( ) : float Returns the final bearing from the origin coordinate to the destination coordinate in degrees.
finalCardinal ( ) : string Returns the final cardinal point / direction from the origin coordinate to the destination coordinate.
getFrom ( ) {@inheritDoc}
getGradient ( ) {@inheritDoc}
getOrdinateIntercept ( ) {@inheritDoc}
getOtherCoordinate ( League\Geotools\Coordinate\CoordinateInterface $coordinate ) : null | Coordinate Returns the other coordinate who is not the coordinate passed on argument
getPrecision ( ) : integer
getTo ( ) {@inheritDoc}
initialBearing ( ) : float Returns the initial bearing from the origin coordinate to the destination coordinate in degrees.
initialCardinal ( ) : string Returns the initial cardinal point / direction from the origin coordinate to the destination coordinate.
isOnSameLine ( Vertex $vertex ) : boolean Returns true if the vertex passed on argument is on the same line as this object
middle ( ) : League\Geotools\Coordinate\CoordinateInterface Returns the half-way point / coordinate along a great circle path between the origin and the destination coordinates.
setFrom ( League\Geotools\Coordinate\CoordinateInterface $from ) {@inheritDoc}
setPrecision ( integer $precision )
setTo ( League\Geotools\Coordinate\CoordinateInterface $to ) {@inheritDoc}

Method Details

destination() public method

Returns the destination point with a given bearing in degrees travelling along a (shortest distance) great circle arc and a distance in meters.
public destination ( integer $bearing, integer $distance ) : League\Geotools\Coordinate\CoordinateInterface
$bearing integer The bearing of the origin in degrees.
$distance integer The distance from the origin in meters.
return League\Geotools\Coordinate\CoordinateInterface

finalBearing() public method

Returns the final bearing from the origin coordinate to the destination coordinate in degrees.
public finalBearing ( ) : float
return float The final bearing in degrees

finalCardinal() public method

Returns the final cardinal point / direction from the origin coordinate to the destination coordinate.
See also: http://en.wikipedia.org/wiki/Cardinal_direction
public finalCardinal ( ) : string
return string The final cardinal point / direction

getFrom() public method

{@inheritDoc}
public getFrom ( )

getGradient() public method

{@inheritDoc}
public getGradient ( )

getOrdinateIntercept() public method

{@inheritDoc}
public getOrdinateIntercept ( )

getOtherCoordinate() public method

Returns the other coordinate who is not the coordinate passed on argument
public getOtherCoordinate ( League\Geotools\Coordinate\CoordinateInterface $coordinate ) : null | Coordinate
$coordinate League\Geotools\Coordinate\CoordinateInterface
return null | League\Geotools\Coordinate\Coordinate

getPrecision() public method

public getPrecision ( ) : integer
return integer

getTo() public method

{@inheritDoc}
public getTo ( )

initialBearing() public method

Returns the initial bearing from the origin coordinate to the destination coordinate in degrees.
public initialBearing ( ) : float
return float The initial bearing in degrees

initialCardinal() public method

Returns the initial cardinal point / direction from the origin coordinate to the destination coordinate.
See also: http://en.wikipedia.org/wiki/Cardinal_direction
public initialCardinal ( ) : string
return string The initial cardinal point / direction

isOnSameLine() public method

Returns true if the vertex passed on argument is on the same line as this object
public isOnSameLine ( Vertex $vertex ) : boolean
$vertex Vertex The vertex to compare
return boolean

middle() public method

Returns the half-way point / coordinate along a great circle path between the origin and the destination coordinates.
public middle ( ) : League\Geotools\Coordinate\CoordinateInterface
return League\Geotools\Coordinate\CoordinateInterface

setFrom() public method

{@inheritDoc}
public setFrom ( League\Geotools\Coordinate\CoordinateInterface $from )
$from League\Geotools\Coordinate\CoordinateInterface

setPrecision() public method

public setPrecision ( integer $precision )
$precision integer

setTo() public method

{@inheritDoc}
public setTo ( League\Geotools\Coordinate\CoordinateInterface $to )
$to League\Geotools\Coordinate\CoordinateInterface

Property Details

$gradient protected property

protected int $gradient
return integer

$ordinateIntercept protected property

protected int $ordinateIntercept
return integer