PMPoint Class Reference

#include <PMPoint.h>

Public Types
typedef base_type	data_type

Public Member Functions
constexpr	PMPoint () noexcept
constexpr	PMPoint (const PMPoint &) noexcept=default
constexpr	PMPoint (PMPoint &&) noexcept=default
PMPoint &	operator= (const PMPoint &) noexcept=default
PMPoint &	operator= (PMPoint &&) noexcept=default
constexpr	PMPoint (const PMReal &x_orig, const PMReal &y_orig) noexcept
constexpr	PMPoint (const SysPoint &p) noexcept
const PMReal &	X () const noexcept
PMReal &	X () noexcept
void	X (const PMReal &xParam) noexcept
const PMReal &	Y () const noexcept
PMReal &	Y () noexcept
void	Y (const PMReal &yParam) noexcept
PMReal	Distance (const PMPoint &otherPt) const
PMReal	VectorLength () const
PMReal	VectorAngle () const
PMPoint	MirrorPoint (const PMPoint &aligningPoint) const
PMPoint	ProjectOnLine (const PMPoint &pt0, const PMPoint &ptA) const
void	operator+= (const PMPoint &a)
void	operator-= (const PMPoint &a)
bool	operator< (const PMPoint &rhs) const noexcept
bool16	ConstrainTo (const PMRect &r)
void	Round ()
void	ReadWrite (IPMStream *iPMStream)

Friends
class	PMRect
SysPoint	ToSys (const PMPoint &pt)
PMPoint	operator+ (const PMPoint &a, const PMPoint &b)
PMPoint	operator- (const PMPoint &a, const PMPoint &b)
PMPoint	operator- (const PMPoint &a)
PMPoint	operator* (const PMReal &c, const PMPoint &pt)
PMPoint	operator* (const PMPoint &pt, const PMReal &c)
PMPoint	operator* (const PMPoint &a, const PMPoint &b)
PMPoint	operator/ (const PMPoint &numer, const PMPoint &denom)
PMPoint	operator/ (const PMPoint &numer, const PMReal &denom)
bool16	operator== (const PMPoint &a, const PMPoint &b) noexcept
bool16	operator!= (const PMPoint &a, const PMPoint &b) noexcept

Detailed Description

Simple class for representing a point in InDesign. Also used to represent a vector. Many of the operations supported by PMPoint interpret the point as a vector - PMPoints may be added together, multiplied by scalar values, have their lengths taken, etc.

See Also

PMReal

Constructor & Destructor Documentation

constexpr PMPoint::PMPoint ( )

inlinenoexcept

Default constructor. Initializes this point to the origin (0, 0).

constexpr PMPoint::PMPoint ( const PMPoint &  )

defaultnoexcept

Copy/move constructor & assignments. Initializes this point to the same values as the source point.

Parameters

aPoint

IN The point to copy

constexpr PMPoint::PMPoint ( const PMReal &  x_orig, const PMReal &  y_orig  )

inlinenoexcept

Constructs this point using specified PMReal x- and y-values.

Parameters

x_orig	IN The x-value for this point
y_orig	IN The y-value for this point

constexpr PMPoint::PMPoint ( const SysPoint &  p )

inlinenoexcept

Constructs this point from a system point.

Parameters

p	IN The system point this point is initialized to

Member Function Documentation

bool16 PMPoint::ConstrainTo

(

const PMRect &

r

)

Constrains this point to the specified rectangle

Parameters

r	IN The rectangle to constrain to

Returns

kTrue if this point was modified while being constrained, else kFalse if the point was already constrained

PMReal PMPoint::Distance ( const PMPoint &  otherPt ) const

inline

Returns the distance (a^2 + b^2 = c^2) from this point to the otherPt

Parameters

otherPt

IN The other point for the distance calculation

Returns

The scalar distance from this point to the other

PMPoint PMPoint::MirrorPoint ( const PMPoint &  aligningPoint ) const

inline

Returns the mirror of this point, using the specified alignment point.

Parameters

aligningPoint

IN The point about which the mirror point is calculated

Returns

The mirror of this point

void PMPoint::operator+= ( const PMPoint &  a )

inline

Increments this point by the specified (vector) point

Parameters

a	IN The amount by which to increment (as a vector)

void PMPoint::operator-= ( const PMPoint &  a )

inline

Decrements this point by the specified (vector) point

Parameters

a	IN The amount by which to decrement (as a vector)

bool PMPoint::operator< ( const PMPoint &  rhs ) const

inlinenoexcept

Define a partial ordering on PMPoints so they can be used in associative containers

PMPoint PMPoint::ProjectOnLine	(	const PMPoint &	pt0,
		const PMPoint &	ptA
	)		const

Projects this point to the line defined by pt0, ptA, keeping the distance to pt0 unchanged.

Parameters

pt0	IN The first point defining the line to project to
ptA	IN The second point defining the line to project to

Returns

The point, projected on to the line defined by pt0 and ptA

void PMPoint::ReadWrite

(

IPMStream *

iPMStream

)

Streams this point to an IPMStream. The point is written out if the stream is writing, and is read in if the stream is reading.

Parameters

iPMStream

IN The stream to which this point is written or read

void PMPoint::Round ( )

inline

Rounds this point's x- and y-values.

PMReal PMPoint::VectorAngle

(

)

const

Returns the angle (in degrees) of this point, interpreted as a vector

Returns

The angle (in degrees) of this point, interpreted as a vector

PMReal PMPoint::VectorLength ( ) const

inline

Returns the length of the vector represented by this point

Returns

The scalar length of this point, interpreted as a vector

const PMReal& PMPoint::X ( ) const

inlinenoexcept

Const-accessor for this point's x-value.

Returns

Const reference to the point's x-value

PMReal& PMPoint::X ( )

inlinenoexcept

Non-const-accessor for this point's x-value.

Returns

Non-const reference to this point's x-value

void PMPoint::X ( const PMReal &  xParam )

inlinenoexcept

Sets the x-value for this point.

Parameters

xParam

IN The new x-value for this point

const PMReal& PMPoint::Y ( ) const

inlinenoexcept

Const-accessor for this point's y-value.

Returns

Const reference to this point's y-value

PMReal& PMPoint::Y ( )

inlinenoexcept

Non-const-accessor for this point's y-value.

Returns

Non-const reference to this point's y-value

void PMPoint::Y ( const PMReal &  yParam )

inlinenoexcept

Sets the y-value for this point.

Parameters

yParam

IN The new y-value for this point

Friends And Related Function Documentation

bool16 operator!= ( const PMPoint &  a, const PMPoint &  b  )

friend

Compares two points for inequality.

Parameters

a	IN First point to compare
b	IN Second point to compare

Returns

kTrue if x- and y-values do not match, else kFalse

PMPoint operator* ( const PMReal &  c, const PMPoint &  pt  )

friend

Multiplies a point by a scalar: result = PMPoint(pt.x * c, pt.y * c)

Parameters

c	IN The scalar to multiply by
pt	IN The point to multiply by

Returns

The product of the point and the scalar

PMPoint operator* ( const PMPoint &  pt, const PMReal &  c  )

friend

Multiplies a point by a scalar: result = PMPoint(pt.x * c, pt.y * c)

Parameters

pt	IN The point to multiply by
c	IN The scalar to multiply by

Returns

The product of the point and the scalar

PMPoint operator* ( const PMPoint &  a, const PMPoint &  b  )

friend

Multiplies two points: result = PMPoint(a.x * b.x, a.y * b.y)

Parameters

a	IN The first point to multiply
b	IN The second point to multiply

Returns

The product of the two points

PMPoint operator+ ( const PMPoint &  a, const PMPoint &  b  )

friend

Adds two points: result = PMPoint(a.x + b.x, a.y + b.y)

Parameters

a	IN The first point to add
b	IN The second point to add

Returns

The sum of the two points

PMPoint operator- ( const PMPoint &  a, const PMPoint &  b  )

friend

Subtracts two points: result = PMPoint(a.x - b.x, a.y - b.y)

Parameters

a	IN The first point to subtract
b	IN The second point to subtract

Returns

The difference of the two points

PMPoint operator- ( const PMPoint &  a )

friend

Negates a point: result = PMPoint(-a.x, -a.y)

Parameters

a	IN The point to negate

Returns

The negated point

PMPoint operator/ ( const PMPoint &  numer, const PMPoint &  denom  )

friend

Divides one point by another: result = PMPoint(numer.x / denom.x, numer.y / denom.y)

Parameters

numer	IN The numerator as a PMPoint
denom	IN The denomination as a PMPoint

Returns

The divided point

PMPoint operator/ ( const PMPoint &  numer, const PMReal &  denom  )

friend

Divides a point by a scalar: result = PMPoint(numer.x / denom, numer.y / denom)

Parameters

numer	IN The point being divided
denom	IN The scalar denominator

Returns

The divided point

bool16 operator== ( const PMPoint &  a, const PMPoint &  b  )

friend

Compares two points for equality.

Parameters

a	IN First point to compare
b	IN Second point to compare

Returns

kTrue if x- and y-values match, else kFalse

SysPoint ToSys ( const PMPoint &  pt )

friend

Converts a PMPoint to a system point.

Parameters

pt	IN The PMPoint to convert

Returns

The equivalent system point