HPS::ShapePoint Class Reference

The ShapePoint class is a point used in shape definitions. More...

#include <hps.h>

Collaboration diagram for HPS::ShapePoint:

Public Member Functions
	ShapePoint ()
	Default constructor. More...
	ShapePoint (ShapeCoordinate const &in_x, ShapeCoordinate const &in_y)
	Construct a new ShapePoint from two ShapeCoordinate objects. More...
	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)) More...
bool	Equals (ShapePoint const &in_that) const
	This function is used to check an object for equivalence to this. More...
bool	operator== (ShapePoint const &in_that) const
	This function is used to check an object for equivalence to this. More...
bool	operator!= (ShapePoint const &in_that) const
	This function is used to check an object for equivalence to this. More...

Public Attributes
ShapeCoordinate	x
ShapeCoordinate	y

Detailed Description

The ShapePoint class is a point used in shape definitions.

It is a 2d point.

Constructor & Destructor Documentation

ShapePoint() [1/3]

HPS::ShapePoint::ShapePoint

(

)

Default constructor.

ShapePoint() [2/3]

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() [3/3]

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.

Member Function Documentation

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.

Member Data Documentation

x

ShapeCoordinate HPS::ShapePoint::x

y

ShapeCoordinate HPS::ShapePoint::y

---

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

• hps.h