Class: TGPoint3DArray

Declaration: Point3DArray.h

Taxonomy Categories:

Member Functions:

TGPoint3DArray
~TGPoint3DArray
GetPoint
SetPoint
GetNumberOfPoints
GetBounds

Interface Category:

API.

Inherits From:

TRawArray

Inherited By:

None.

Purpose:

TGPoint3DArray is a low-level class that provides access to linear arrays of TGPoint3Ds (3-D ordered points). TGPoint3DArray is used by TGPolyline3D and the 3-D spline classes.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None. Do not create derived classes.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TGPoint3DArray::TGPoint3DArray

TGPoint3DArray (unsigned long size =0)
TGPoint3DArray (const TGPoint3DArray & source)

Interface Category:

API.

Purpose:

Creates a TGPoint3DArray of the specified size. The points are not initialized.
Copy constructor.

Calling Context:

Call this function directly.
Called to copy an object.

Parameters:

unsigned long size =0 -The size of the array.
const TGPoint3DArray & source -The array to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGPoint3DArray::~TGPoint3DArray

~ TGPoint3DArray ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGPoint3DArray::GetPoint

TGPoint3D GetPoint (unsigned long i) const

Interface Category:

API.

Purpose:

Gets the TGPoint3D at the specified index.

Calling Context:

Call this function directly.

Parameters:

unsigned long i -The index (whose value must be less than the number of points in the array).

Return Value:

Returns the point at the specified index.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGPoint3DArray::SetPoint

void SetPoint (unsigned long i, const TGPoint3D & p)

Interface Category:

API.

Purpose:

Sets the TGPoint3D at the specified index to the specified point.

Calling Context:

Call this function directly.

Parameters:

unsigned long i -The index (whose value must be less than the number of points in the array).
const TGPoint3D & p -The new point.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Member Function: TGPoint3DArray::GetNumberOfPoints

unsigned long GetNumberOfPoints () const

Interface Category:

API.

Purpose:

Computes the number of points in the TGPoint3DArray.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the number of points in the array.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGPoint3DArray::GetBounds

TGBox3D GetBounds () const

Interface Category:

API.

Purpose:

Returns a TGBox3D that bounds the TGPoint3Ds in this TGPoint3DArray.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the bounding box of all the points in the array.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.