Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
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 coordinate of the vector. More...
 
IlvDeltaPos getY () const
 Gets the y coordinate of the vector. More...
 
void move (IlvDeltaPos x, IlvDeltaPos y)
 Sets the x and y coordinates of the vector. More...
 
IlvDeltaPointoperator= (const IlvDeltaPoint &p)
 Copies a vector. More...
 
int operator== (const IlvDeltaPoint &p) const
 Tests vectors for equality. More...
 
void setX (IlvDeltaPos xx)
 Sets the x coordinate of the vector. More...
 
void setY (IlvDeltaPos yy)
 Sets the y coordinate of the vector. 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
xThe x coordinate of the vector.
yThe y coordinate of the vector.

Member Function Documentation

◆ getX()

IlvDeltaPos IlvDeltaPoint::getX ( ) const

Gets the x coordinate of the vector.

Returns
The x coordinate.

◆ getY()

IlvDeltaPos IlvDeltaPoint::getY ( ) const

Gets the y coordinate of the vector.

Returns
The y offset.

◆ move()

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

Sets the x and y coordinates of the vector.

Parameters
xThe x coordinate.
yThe y coordinate.

◆ operator=()

IlvDeltaPoint& IlvDeltaPoint::operator= ( const IlvDeltaPoint p)

Copies a vector.

Copies p to the object this.

Parameters
pThe vector to copy.

◆ operator==()

int IlvDeltaPoint::operator== ( const IlvDeltaPoint p) const

Tests vectors for equality.

Parameters
pThe delta point vector.
Returns
0 if p is different from the current object.

◆ setX()

void IlvDeltaPoint::setX ( IlvDeltaPos  xx)

Sets the x coordinate of the vector.

Parameters
xxThe x coordinate.

◆ setY()

void IlvDeltaPoint::setY ( IlvDeltaPos  yy)

Sets the y coordinate of the vector.

Parameters
yyThe y coordinate.

◆ translate()

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

Translates a vector.

Adds the x and y values to the x and y coordinates.

Parameters
xThe value to add to the x coordinate.
yThe value to add to the y coordinate.