rwlogo

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 offset. More...
 
IlvDeltaPos getY () const
 Gets the y offset. More...
 
void move (IlvDeltaPos x, IlvDeltaPos y)
 Moves a vector object. More...
 
IlvDeltaPointoperator= (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 ( 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

IlvDeltaPos IlvDeltaPoint::getX ( ) const

Gets the x offset.

Retrieves the x offset for a vector.

Returns
The x offset.
IlvDeltaPos IlvDeltaPoint::getY ( ) const

Gets the y offset.

Retrieves the y offset for a vector.

Returns
The y offset.
void IlvDeltaPoint::move ( IlvDeltaPos  x,
IlvDeltaPos  y 
)

Moves a vector object.

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

Parameters
xThe x coordinate of the vector.
yThe y coordinate of the vector.
IlvDeltaPoint& IlvDeltaPoint::operator= ( const IlvDeltaPoint p)

Copies a delta point vector.

Copies p to the current object.

Parameters
pThe delta point vector.
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.
void IlvDeltaPoint::setX ( IlvDeltaPos  xx)

Sets the x offset.

Assigns a new x offset value to a vector.

Parameters
xxThe x offset.
void IlvDeltaPoint::setY ( IlvDeltaPos  yy)

Sets the y offset.

Assigns a new y offset value to a vector.

Parameters
yyThe y offset.
void IlvDeltaPoint::translate ( IlvDeltaPos  x,
IlvDeltaPos  y 
)

Translates a vector.

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

Parameters
xThe x offset.
yThe y offset.

© Copyright 2015, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.