IGPoint2DArray

IGPoint2DArray provides array access for collections of IGPoint2Ds. IGPoint2DArray is used by IGPolyline2D, IGPolygon2D, and other classes. Note that IRawArray does not check whether allocation is successful. Before constructing a new array, check to ensure that there is enough memory, and use a reasonable size.


IGPoint2DArray - Member Functions and Data by Group

Constructors & Destructor

Use the functions in this group to construct or destroy an object of class IGPoint2DArray.


[view class]
~IGPoint2DArray
public:
~IGPoint2DArray()
Destroys the points array-access object of class IGPoint2DArray.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
IGPoint2DArray
Constructs an object of class IGPoint2DArray that provides array access for collections of IGPoint2D objects.


Overload 1
public:
IGPoint2DArray(unsigned long size = 0)

Create an IGPoint2DArray of the specified size.

size
The number of elements in the array

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Overload 2
public:
IGPoint2DArray(const IGPoint2DArray& source)
Use this constructor to create a points array-access object of class IGPoint2DArray that is copied from the given one.

source
A constant reference to the array to be copied.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Bounding Rectangle for all Points in the Array.

Use this function to create a rectangle that encompassess all the points in the array.


[view class]
bounds
public:
IGRect2D bounds() const
Creates an IGRect2D that bounds the points in the IGPoint2DArray.

Return
The bounding rectangle.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Obtaining Information About the Points Array Acess Object

Use the functions in this group to obtain information about the IGPoint2DArray access-array object, such as the number of points the array contains, and the point at a specific index into the array.


[view class]
numberOfPoints
public:
unsigned long numberOfPoints() const
Computes the number of points in the IGPoint2DArray.

Return
The number of points in the array.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
point
public:
IGPoint2D point(unsigned long i) const
Gets the IGPoint2D at the specified index.

i
The index, whose value must be less than the number of points in the array.

Return
The point at the specified index.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Setting the Array Access Points

Use the function in this group to set the point at a specific index into the array of the IGPoint2DArray object.


[view class]
setPoint
public:
void setPoint(unsigned long i, const IGPoint2D& p)
Sets the IGPoint2D at the specified index, to the specified point.

i
The index, whose value must be less than the number of points in the array.
p
The new point.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


Streaming an Object In and Out

Use the functions in this group to read an IGPoint2DArray object in from the specified stream or write it out to it.


[view class]
operator <<=
public:
IDataStream& operator <<=(IDataStream&)
Reads the object in from the specified stream.

fromWhere
A reference to the stream from which the object is read in.

Return
The original stream.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


[view class]
operator >>=
public:
IDataStream& operator >>=(IDataStream&) const
Writes the object out to the specified stream.

toWhere
A reference to the stream that the object is written out to.

Return
The original stream.

Supported Platforms

Windows OS/2 AIX
Yes Yes Yes


IGPoint2DArray - Inherited Member Functions and Data

Inherited Public Functions

IRawArray

Inherited Public Data

Inherited Protected Functions

Inherited Protected Data