Class: TCurveList3D

Declaration: CurveList.h

Taxonomy Categories:

Member Functions:

TCurveList3D
~TCurveList3D
SetCurve
AdoptCurve
GetCurve
GetCurveRef
GetCurvePosition
SetCurvePosition
SetNumberCurves
GetNumberCurves
SetArclengthMapped
ArclengthMapped
operator=
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

A TCurveList3D is a collection of TGCurve3Ds, just as a TCurveList is a collection of TGCurves. For each curve in the list, the TCurveList3D maintains a distinct parametric value, used to keep track of the position of the curve in a sweep or loft operation.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCurveList3D::TCurveList3D

TCurveList3D ()
TCurveList3D (const TGCurve3D & singleCurve)
TCurveList3D (unsigned long numberCurves)
TCurveList3D (const TCurveList3D & curveList)

Interface Category:

API.

Purpose:

Default constructor.
Creates a TCurveList3D with the specified curve in it.
Creates a TCurveList3D with the specified number of curves in it.
Copy constructor.

Calling Context:

Called by the stream-in operators. You can also call this function directly.
Call this function directly.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TGCurve3D & singleCurve -The curve that is to be the only one in the curve list.
unsigned long numberCurves -The number of curves to be included in the curve list.
const TCurveList3D & curveList -The new curve list that this object is set to.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::~TCurveList3D

~ TCurveList3D ()

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: TCurveList3D::SetCurve

void SetCurve (unsigned long nr, const TGCurve3D & crv, GParametric u)
void SetCurve (const TGCurve3D & singleCurve)

Interface Category:

API.

Purpose:

Adds a copy of the TGCurve3D to the list at the location specified by the index. The specified parametric value is associated with the curve. If the index is larger than the size of curve list, the list is resized and padded with NILs.
Sets the first element in the list equal to a copy of the specified curve. Sets the associated parametric value to 0.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

unsigned long nr -The location in the list to be set to the new curve.
const TGCurve3D & crv -The new curve.
GParametric u -The parametric value to be associated with the new curve.
const TGCurve3D & singleCurve -The new curve.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::AdoptCurve

void AdoptCurve (unsigned long nr, TGCurve3D * crv, GParametric u)

Interface Category:

API.

Purpose:

Adds the TGCurve3D to the list at the location specified by the index. The specified parametric value is associated with the curve. If the index is equal to or larger than the size of curve list, the list is resized and padded with NILs.

Calling Context:

Call this function directly.

Parameters:

unsigned long nr -The location (an array index) in the list.
TGCurve3D * crv -The curve to be adopted.
GParametric u -The parametric value to be associated with the adopted curve.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::GetCurve

void GetCurve (unsigned long nr, TGCurve3D & crv, GParametric & u) const
void GetCurve (TGCurve3D & singleCurve) const

Interface Category:

API.

Purpose:

Returns the TGCurve3D (from the location specified by the index) and its associated parametric value in the specified parameters.
Returns the list's first TGCurve3D in the specified parameter.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

unsigned long nr -The location index.
TGCurve3D & crv -The curve from the specified location.
GParametric & u -The associated parametric value.
TGCurve3D & singleCurve -The first curve in the list.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::GetCurveRef

TGCurve3D * GetCurveRef (unsigned long i) const

Interface Category:

API.

Purpose:

Returns a pointer to the TGCurve3D specified by the index.

Calling Context:

Call this function directly.

Parameters:

unsigned long i -The index.

Return Value:

A pointer to the curve specified by the index.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::GetCurvePosition

GParametric GetCurvePosition (unsigned long i) const

Interface Category:

API.

Purpose:

Returns the parametric value associated with the TGCurve3D at the specified index.

Calling Context:

Call this function directly.

Parameters:

unsigned long i -The index.

Return Value:

The parametric value of the indexed curve.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::SetCurvePosition

void SetCurvePosition (unsigned long i, GParametric u)

Interface Category:

API.

Purpose:

Sets the parametric value associated with the TGCurve3D at the specified index to the new value.

Calling Context:

Call this function directly.

Parameters:

unsigned long i -The index into the list of curves. The first curve is numbered 0.
GParametric u -The new parametric value.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::SetNumberCurves

void SetNumberCurves (unsigned long n)

Interface Category:

API.

Purpose:

Sets the number of curves in the curve list. If the number is smaller than before, the extra curves are deleted; if the number is larger, the TCurveList3D is padded with NILs.

Calling Context:

Call this function directly.

Parameters:

unsigned long n -The new number of curves in the list.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::GetNumberCurves

unsigned long GetNumberCurves () const

Interface Category:

API.

Purpose:

Returns the number of curves in this TCurveList3D.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The number of curves in this list.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::SetArclengthMapped

void SetArclengthMapped (bool mapped)

Interface Category:

API.

Purpose:

Sets the fArclengthMapped flag to the specified Boolean.

Calling Context:

Call this function directly.

Parameters:

bool mapped -The desired Boolean.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::ArclengthMapped

bool ArclengthMapped () const

Interface Category:

API.

Purpose:

Determines whether the fArclengthMapped flag is set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if the ArclengthMapped flag is set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::operator=

TCurveList3D & operator =(const TCurveList3D & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCurveList3D & source -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::operator<<=

TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream which the object's data is streamed in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCurveList3D::operator>>=

TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & towhere -The stream which the object's data is streamed out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

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.