{{+bindTo:partials.standard_nacl_api}}

point.h File Reference

{{- dummy div to appease doxygen -}}
Include dependency graph for point.h:

Classes

class  pp::Point
 A 2 dimensional point with 0,0 being the upper-left starting coordinate. More...
class  pp::FloatPoint
 A 2 dimensional floating-point point with 0,0 being the upper-left starting coordinate. More...

Namespaces

namespace  pp

Functions

bool operator== (const pp::Point &lhs, const pp::Point &rhs)
bool operator!= (const pp::Point &lhs, const pp::Point &rhs)
bool operator== (const pp::FloatPoint &lhs, const pp::FloatPoint &rhs)
bool operator!= (const pp::FloatPoint &lhs, const pp::FloatPoint &rhs)

Detailed Description

This file defines the API to create a 2 dimensional point.


Function Documentation

bool operator!= ( const pp::Point lhs,
const pp::Point rhs 
) [inline]

Determines whether two Points have different coordinates.

Parameters:
[in]lhsThe Point on the left-hand side of the equation.
[in]rhsThe Point on the right-hand side of the equation.
Returns:
true if the coordinates of lhs are equal to the coordinates of rhs, otherwise false.
bool operator!= ( const pp::FloatPoint lhs,
const pp::FloatPoint rhs 
) [inline]

Determines whether two Points have different coordinates.

Parameters:
[in]lhsThe Point on the left-hand side of the equation.
[in]rhsThe Point on the right-hand side of the equation.
Returns:
true if the coordinates of lhs are equal to the coordinates of rhs, otherwise false.
bool operator== ( const pp::Point lhs,
const pp::Point rhs 
) [inline]

Determines whether the x and y values of two Points are equal.

Parameters:
[in]lhsThe Point on the left-hand side of the equation.
[in]rhsThe Point on the right-hand side of the equation.
Returns:
true if they are equal, false if unequal.
bool operator== ( const pp::FloatPoint lhs,
const pp::FloatPoint rhs 
) [inline]

Determines whether the x and y values of two FloatPoints are equal.

Parameters:
[in]lhsThe Point on the left-hand side of the equation.
[in]rhsThe Point on the right-hand side of the equation.
Returns:
true if they are equal, false if unequal.
{{/partials.standard_nacl_api}}