HPS::ShapePoint Class Reference

`#include <hps.h>`

## Public Member Functions

bool Equals (ShapePoint const &in_that) const

bool operator!= (ShapePoint const &in_that) const

bool operator== (ShapePoint const &in_that) const

ShapePoint ()
Default constructor.

ShapePoint (ShapeCoordinate const &in_x, ShapeCoordinate const &in_y)

ShapePoint (float in_x, float in_y)

## Public Attributes

ShapeCoordinate x

ShapeCoordinate y

## Detailed Description

The ShapePoint class is a point used in shape definitions. It is a 2d point.

## ◆ ShapePoint() [1/2]

 HPS::ShapePoint::ShapePoint ( ShapeCoordinate const & in_x, ShapeCoordinate const & in_y )

Construct a new ShapePoint from two ShapeCoordinate objects.

Parameters
 in_x A ShapeCoordinate which will be used in the x direction. in_y A ShapeCoordinate which will be used in the x direction.

## ◆ ShapePoint() [2/2]

 HPS::ShapePoint::ShapePoint ( float in_x, float in_y )

Construct a new ShapePoint, with margins computed automatically This is equivalent to using a ShapePoint constructed with the following two ShapeCoordinates ShapeCoordinate(A, 0, FloatArray(1, A)) ShapeCoordiante(0, B, FloatArray(1, B))

Parameters
 in_x A normalized distance over the horizontal text bounds and margins in_y A normalized distance over the vertical text bounds and margins.

## ◆ Equals()

 bool HPS::ShapePoint::Equals ( ShapePoint const & in_that ) const
inline

This function is used to check an object for equivalence to this.

Parameters
 in_that The object to compare to this.
Returns
true if the objects are equivalent, false otherwise.

## ◆ operator!=()

 bool HPS::ShapePoint::operator!= ( ShapePoint const & in_that ) const
inline

This function is used to check an object for equivalence to this.

Parameters
 in_that The object to compare to this.
Returns
true if the objects are not equivalent, false otherwise.

## ◆ operator==()

 bool HPS::ShapePoint::operator== ( ShapePoint const & in_that ) const
inline

This function is used to check an object for equivalence to this.

Parameters
 in_that The object to compare to this.
Returns
true if the objects are equivalent, false otherwise.

The documentation for this class was generated from the following file: