IFXAuthorVertexUpdate

The IFXAuthorVertexUpdate class is an update record that presents an authoring time description of how a single vertex can be inserted or removed from an associated IFXAuthorMesh. Depending on how the update record is applied, its data describes how many faces and attributes will be added or removed. Its data also describes how many faces will be modified and how they will be modified, all found in a list of IFXAuthorFaceUpdate records.

Interface Methods

Description

IFXAuthorVertexUpdate

Class constructor

~IFXAuthorVertexUpdate

Class destructor

VertexIndex

Returns a reference to the VertexIndex field

ParentVertexIndex

Returns a reference to the ParentVertexIndex field

NumFaceUpdates

Returns a reference to the NumFaceUpdates field

NumNewFaces

Returns a reference to the NumNewFaces field

NumNewNormals

Returns a reference to the NumNewNormals field

NumNewTexCoords

Returns a reference to the NumNewTexCoords field

VertexUpdateType

Returns a reference to the VertexUpdateType field

GetFaceUpdate

Provides access to a specific IFXAuthorFaceUpdate record

SetFaceUpdatePtr

Sets the internal pointer to the short list of IFXAuthorFaceUpdate records


IFXAuthorVertexUpdate::IFXAuthorVertexUpdate()

Class constructor.

Parameters:

None

Return Values:

None


IFXAuthorVertexUpdate::~IFXAuthorVertexUpdate()

Class destructor.

Parameters:

None

Return Values:

None


IFXAuthorVertexUpdate::VertexIndex()

This method returns a reference to the VertexIndex field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value. The vertex index is the mesh index of the vertex to be inserted or removed.

Parameters:

None

Return Values:

A reference to the VertexIndex integer field.


IFXAuthorVertexUpdate::ParentVertexIndex()

This method returns a reference to the ParentVertexIndex field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value. The parent vertex index is the mesh index of the parent vertex of the vertex specified in the VertexIndex field. VertexIndex and ParentVertexIndex indicate the two vertices that define the edge that is either collapsed or expanded through the application of this IFXAuthorVertexUpdate record.

Parameters:

None

Return Values:

A reference to the ParentVertexIndex integer field.


IFXAuthorVertexUpdate::NumFaceUpdates()

This method returns a reference to the NumFaceUpdates field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value. NumFaceUpdates describes the number of IFXAuthorFaceUpdate records associated with this IFXAuthorVertexUpdate record. 

Parameters:

None

Return Values:

A reference to the NumFaceUpdates integer field.


IFXAuthorVertexUpdate::NumNewFaces()

This method returns a reference to the NumNewFaces field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value.  

Parameters:

None

Return Values:

A reference to the NumNewFaces integer field.


IFXAuthorVertexUpdate::NumNewNormals()

This method returns a reference to the NumNewNormals field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value. NumNewNormals describes the number of normals that will be added or removed from the associated IFXAuthorMesh by application of this IFXAuthorVertexUpdate record.

Parameters:

None

Return Values:

A reference to the NumFaceNormals integer field.


IFXAuthorVertexUpdate::NumNewTexCoords(U32 layerNum = 0)

This method returns a reference to the NumNewTexCoords field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value. NumNewTexCoords describes the number of texture coordiantes that will be added or removed from the associated IFXAuthorMesh by application of this IFXAuthorVertexUpdate record. Because an IFXAuthorMesh may have multiple layers of texture coordinates, an additional parameter is required to indicate the desired texture coordinate layer.

Parameters:

LayerNum

This is the desired texture coordinate layer.
Defaults to layer 0 if not specified.

Return Values:

A reference to the NumNewTexCoords integer field.


IFXAuthorVertexUpdate::VertexUpdateType()

This method returns a reference to the VertexUpdateType field of the IFXAuthorVertexUpdate record. The method can be used to get or set the associated data value.

Parameters:

None

Return Values:

A reference to the VertexUpdateType field.


IFXAuthorVertexUpdate::GetFaceUpdate(U32 index)

This method provides access to a specific IFXAuthorFaceUpdate record that is associated with the IFXAuthorVertexUpdate record.

Parameters:

index

An integer index into the list of associated IFXAuthorFaceUpdate records. Should be in the range [0..NumFaceUpdates]

Return Values:

A pointer to the specific IFXAuthorFaceUpdate record.


IFXAuthorVertexUpdate::SetFaceUpdatePtr (IFXAuthorFaceUpdate *pFaceUpdate)

This method sets the internal pointer to the short list of IFXAuthorFaceUpdate records. It is used by IFXAuthorUpdateRecordGroup:: AllocateFaceUpdatesToVertexUpdate() to associate a short, contiguous array of IFXAuthorFaceUpdates with a particular IFXAuthorVertexUpdate record.

Parameters:

pFaceUpdate

A pointer to the array of IFXAuthorFaceUpdate records

Return Values:

None

§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.