IlvDeltaPoint Class Reference

Geometric class. More...

#include <ilviews/base/geometry.h>

Public Member Functions
	IlvDeltaPoint (IlvDeltaPos x=0, IlvDeltaPos y=0)
	Constructor. More...
IlvDeltaPos	getX () const
	Gets the x offset. More...
IlvDeltaPos	getY () const
	Gets the y offset. More...
void	move (IlvDeltaPos x, IlvDeltaPos y)
	Moves a vector object. More...
IlvDeltaPoint &	operator= (const IlvDeltaPoint &p)
	Copies a delta point vector. More...
int	operator== (const IlvDeltaPoint &p) const
	Tests vectors for equality. More...
void	setX (IlvDeltaPos xx)
	Sets the x offset. More...
void	setY (IlvDeltaPos yy)
	Sets the y offset. More...
void	translate (IlvDeltaPos x, IlvDeltaPos y)
	Translates a vector. More...

Detailed Description

Geometric class.

Library: xviews or winviews or mviews (mutually exclusive)

The IlvDeltaPoint class is used to create a vector. A vector is an oriented displacement in a two-dimensional coordinate system.

See also

IlvPoint, IlvFloatPoint, IlvDoublePoint.

Constructor & Destructor Documentation

IlvDeltaPoint()

IlvDeltaPoint::IlvDeltaPoint	(	IlvDeltaPos	x = 0,
		IlvDeltaPos	y = 0
	)

Constructor.

Initializes a vector with defined coordinates.

Parameters

x	The x coordinate of the vector.
y	The y coordinate of the vector.

Member Function Documentation

getX()

IlvDeltaPos IlvDeltaPoint::getX

(

)

const

Gets the x offset.

Retrieves the x offset for a vector.

Returns

The x offset.

getY()

IlvDeltaPos IlvDeltaPoint::getY

(

)

const

Gets the y offset.

Retrieves the y offset for a vector.

Returns

The y offset.

move()

void IlvDeltaPoint::move	(	IlvDeltaPos	x,
		IlvDeltaPos	y
	)

Moves a vector object.

Takes an existing vector object and assigns another value to it.

Parameters

x	The x coordinate of the vector.
y	The y coordinate of the vector.

operator=()

IlvDeltaPoint& IlvDeltaPoint::operator=

(

const IlvDeltaPoint &

p

)

Copies a delta point vector.

Copies p to the current object.

Parameters

p	The delta point vector.

operator==()

int IlvDeltaPoint::operator==

(

const IlvDeltaPoint &

p

)

const

Tests vectors for equality.

Parameters

p	The delta point vector.

Returns

0 if p is different from the current object.

setX()

void IlvDeltaPoint::setX

(

IlvDeltaPos

xx

)

Sets the x offset.

Assigns a new x offset value to a vector.

Parameters

xx	The x offset.

setY()

void IlvDeltaPoint::setY

(

IlvDeltaPos

yy

)

Sets the y offset.

Assigns a new y offset value to a vector.

Parameters

yy	The y offset.

translate()

void IlvDeltaPoint::translate	(	IlvDeltaPos	x,
		IlvDeltaPos	y
	)

Translates a vector.

Uses the delta parameters to modify the current value of the vector.

Parameters

x	The x offset.
y	The y offset.