CVector4Array Class Reference

Search for all occurrences

#include <xsi_vector3.h>

---

Class Description

The CVector4Array is an uni-dimensional array of CVector4.

The array is zero-based, which means that the first item index is 0 and the larger index is one less that the number of elements contained in the array.

See also:

MATH::CVector4, CControlPointRefArray::GetArray, CControlPointRefArray::PutArray, CNurbsCurveData.m_aControlPoints, CNurbsSurfaceData.m_aControlPoints

List of all members.

Public Member Functions
	CVector4Array (LONG in_size=0)
	CVector4Array (const CVector4Array &in_ArrayToCopy)
	~CVector4Array ()
CVector4Array &	operator= (const CVector4Array &in_array)
LONG	GetCount () const
CStatus	Add (const CVector4 &in_item)
CStatus	Clear ()
CStatus	Resize (LONG in_size)
const CVector4 &	operator[] (LONG in_index) const
CVector4 &	operator[] (LONG in_index)
bool	operator== (const CVector4Array &in_array) const
bool	operator!= (const CVector4Array &in_array) const

---

Constructor & Destructor Documentation

CVector4Array

(

LONG

in_size = 0

)

Constructs a CVector4Array and optionally initializes the array to a known size.

Parameters:

in_size

Size of array, defaults to 0.

CVector4Array

(

const CVector4Array &

in_ArrayToCopy

)

Constructs a CVector4Array object from another CVector4Array object.

Parameters:

in_ArrayToCopy

constant CVector4Array object.

~CVector4Array

(

)

Default destructor.

---

Member Function Documentation

CVector4Array& operator=

(

const CVector4Array &

in_array

)

Assignment operator.

Parameters:

in_array

constant class object.

Returns:

A reference to this array.

LONG GetCount

(

)

const

Search for all occurrences

Returns the number of items in this CVector4Array

Returns:

The number of items in the array.

CStatus Add

(

const CVector4 &

in_item

)

Search for all occurrences

Adds a LONG at the end of this array.

Parameters:

in_item

New item to be added at the end of the array.

Returns:

CStatus::OK success

CStatus Clear

(

)

Search for all occurrences

Erases all elements contained in the array.

Returns:

CStatus::OK success

CStatus Resize

(

LONG

in_size

)

Search for all occurrences

Reallocates memory for the array, preserves its contents if new new size is larger than existing size.

Parameters:

in_size

New size of the array.

Returns:

CStatus::OK success

CStatus::InvalidArgument in_size < 0

const CVector4& operator[]

(

LONG

in_index

)

const

Accessor to elements at a given index. This function can only be called by constant objects, the returned value is read-only.

Parameters:

in_index

index in this zero-based array. The index must be greater or equal to zero and smaller than the number of elements in the array, otherwise the results are unpredictable.

Returns:

A read-only reference to the indexed item.

CVector4& operator[]

(

LONG

in_index

)

Accessor to elements at a given index.

Parameters:

in_index

index in this zero-based array. The index must be greater or equal to zero and smaller than the number of elements in the array, otherwise the results are unpredictable.

Returns:

A reference to the indexed item.

bool operator==

(

const CVector4Array &

in_array

)

const

Equality operator.

Parameters:

in_array

CVector4Array to compare with.

Returns:

true if in_array contains the same number of elements as this array and if all members of in_array are equal to the corresponding one contained in this array.

bool operator!=

(

const CVector4Array &

in_array

)

const

Inequality operator.

Parameters:

in_array

Returns:

true if one member of in_array is different from the corresponding members in this array or if the arrays are not of the same size.

---

The documentation for this class was generated from the following file:

• xsi_vector4.h