AIMeshVertexIteratorSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to traverse and manipulate the vertices in a mesh through a reference-counted iterator object. More...

#include <AIMesh.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	AddRef )(AIMeshVertexIterator vertex)
	Increments the reference count of a vertex iterator object.
AIAPI ai::int32(*	Release )(AIMeshVertexIterator vertex)
	Decrements the reference count of a vertex iterator object, and frees the associated memory when the count reaches 0.
AIAPI AIErr(*	Copy )(AIMeshVertexIterator vertex, AIMeshVertexIterator from)
	Copies the contents of a vertex iterator into another, existing iterator object.
AIAPI AIErr(*	Clone )(AIMeshVertexIterator vertex, AIMeshVertexIterator *clone)
	Duplicates a vertex iterator, creating a new iterator object.
AIAPI AIBoolean(*	IsEqual )(AIMeshVertexIterator vertex1, AIMeshVertexIterator vertex2)
	Reports whether two vertex iterator objects reference the same vertex.
AIAPI AIBoolean(*	AtEnd )(AIMeshVertexIterator vertex)
	Reports whether a vertex iterator has reached the last vertex.
AIAPI void(*	Next )(AIMeshVertexIterator vertex)
	Advances a vertex iterator, so that it contains the next vertex in the mesh.
AIAPI void(*	Prev )(AIMeshVertexIterator vertex)
	Backs up a vertex iterator, so that it contains the previous vertex in the mesh.
AIAPI void(*	NextI )(AIMeshVertexIterator vertex)
	Advances a vertex iterator, so that it contains the next vertex in the mesh, increasing along the I axis.
AIAPI void(*	PrevI )(AIMeshVertexIterator vertex)
	Backs up a vertex iterator, so that it contains the previous vertex in the mesh, decreasing along the I axis.
AIAPI void(*	NextJ )(AIMeshVertexIterator vertex)
	Advances a vertex iterator, so that it contains the next vertex in the mesh, increasing along the J axis.
AIAPI void(*	PrevJ )(AIMeshVertexIterator vertex)
	Backs up a vertex iterator, so that it contains the previous vertex in the mesh, decreasing along the J axis.
AIAPI ai::int32(*	CountSegments )(AIMeshVertexIterator vertex)
	Reports the number of segments connected to a vertex.
AIAPI AIBoolean(*	IsNode )(AIMeshVertexIterator vertex)
	Reports whether a vertex iterator identifies a node.
AIAPI ai::int32(*	GetSegmentIndex )(AIMeshVertexIterator vertex, ai::int32 axis, ai::int32 sense)
	Retrieves the index position of a segment in a given direction from a connected vertex along a given axis.
AIAPI ai::int32(*	GetSegmentOpposite )(AIMeshVertexIterator vertex, ai::int32 i)
	Retrieves the index position of the segment that is opposite a segment identified by index position around a connected vertex.
AIAPI AIErr(*	SetColor )(AIMeshVertexIterator vertex, AIColor *c)
	Sets the color of a node.
AIAPI void(*	GetColor )(AIMeshVertexIterator vertex, AIColor *c)
	Retrieves the color of a node.
AIAPI AIErr(*	SetPoint )(AIMeshVertexIterator vertex, AIRealPoint *point)
	Sets the position of the ends of all segments attached to a vertex.
AIAPI void(*	GetPoint )(AIMeshVertexIterator vertex, AIRealPoint *point)
	Retrieves the position of the ends of all segments attached to a vertex.
AIAPI void(*	GetUV )(AIMeshVertexIterator vertex, AIReal u, AIReal v)
	Retrieves the (U,V) coordinates of a vertex.
AIAPI AIErr(*	SetTangent )(AIMeshVertexIterator vertex, ai::int32 i, AIRealPoint *point)
	Sets the second point of the bezier control polygon of a segment identified by index position around a connected vertex.
AIAPI void(*	GetTangent )(AIMeshVertexIterator vertex, ai::int32 i, AIRealPoint *point)
	Retrieves the second point of the bezier control polygon of a segment identified by index position around a connected vertex.
AIAPI AIErr(*	SetSmooth )(AIMeshVertexIterator vertex, ai::int32 i, AIBoolean smooth)
	Sets the smoothing state of a segment identified by index position around a connected vertex.
AIAPI AIBoolean(*	GetSmooth )(AIMeshVertexIterator vertex, ai::int32 i)
	Retrieves the smoothing state of a segment identified by index position around a connected vertex.
AIAPI AIErr(*	GetSegment )(AIMeshVertexIterator vertex, ai::int32 i, AIMeshSegmentIterator *segment)
	Creates an iterator for a segment identified by index position around a connected vertex.
AIAPI AIErr(*	GetPatch )(AIMeshVertexIterator vertex, ai::int32 i, AIMeshPatchIterator *patch)
	Creates an iterator for one of the patches adjacent to a segment identified by index position around a connected vertex.
AIAPI AIBoolean(*	IsOnBoundary )(AIMeshVertexIterator vertex)
	Reports whether a vertex is on the edge of the mesh.
AIAPI AIErr(*	SetOpacity )(AIMeshVertexIterator vertex, AIReal o)
	Sets the opacity of a node.
AIAPI void(*	GetOpacity )(AIMeshVertexIterator vertex, AIReal *o)
	Retrieves the opacity of a node.

Detailed Description

This suite provides functions that allow you to traverse and manipulate the vertices in a mesh through a reference-counted iterator object.

The segments and tangents associated with a vertex are addressed by a 0-based index.

See Mesh Iterators.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIMeshVertexIteratorSuite and kAIMeshVertexIteratorVersion.

Member Data Documentation

AIAPI ai::int32(* AIMeshVertexIteratorSuite::AddRef)(AIMeshVertexIterator vertex)

Increments the reference count of a vertex iterator object.

The initial reference count is 1, so you do not typically need to call this function. (Note that this function returns a numeric value, not an error code.)

Parameters:

vertex

The vertex iterator object.

Returns:: The current reference count.

AIAPI AIBoolean(* AIMeshVertexIteratorSuite::AtEnd)(AIMeshVertexIterator vertex)

Reports whether a vertex iterator has reached the last vertex.

When this function returns true, the iterator no longer contains a valid vertex, and can no longer be used with the iteration functions. Check this before calling Next(), Prev(), or related functions if there is a chance of walking off the end of the mesh. (Note that this function returns a boolean value, not an error code.)

Parameters:

vertex

The vertex iterator object.

Returns:: True when the iterator is past the last vertex.

AIAPI AIErr(* AIMeshVertexIteratorSuite::Clone)(AIMeshVertexIterator vertex, AIMeshVertexIterator *clone)

Duplicates a vertex iterator, creating a new iterator object.

Parameters:

	vertex	The source iterator object.
	clone	[out] A buffer in which to return the new iterator object.

AIAPI AIErr(* AIMeshVertexIteratorSuite::Copy)(AIMeshVertexIterator vertex, AIMeshVertexIterator from)

Copies the contents of a vertex iterator into another, existing iterator object.

Parameters:

	vertex	The destination iterator object.
	from	The source iterator object.

AIAPI ai::int32(* AIMeshVertexIteratorSuite::CountSegments)(AIMeshVertexIterator vertex)

Reports the number of segments connected to a vertex.

(Note that this function returns a numeric value, not an error code.)

Parameters:

vertex

The vertex iterator object.

Returns:: The number of connected segments.

AIAPI void(* AIMeshVertexIteratorSuite::GetColor)(AIMeshVertexIterator vertex, AIColor *c)

Retrieves the color of a node.

(Note that this function does not return an error code.)

Parameters:

	vertex	The vertex iterator object, for which the current vertex is a node.
	c	[out] A buffer in which to return the color.

AIAPI void(* AIMeshVertexIteratorSuite::GetOpacity)(AIMeshVertexIterator vertex, AIReal *o)

Retrieves the opacity of a node.

(Note that this function does not return an error code.)

Parameters:

	vertex	The vertex iterator object, for which the current vertex is a node.
	o	[out] A buffer in which to return the opacity.

AIAPI AIErr(* AIMeshVertexIteratorSuite::GetPatch)(AIMeshVertexIterator vertex, ai::int32 i, AIMeshPatchIterator *patch)

Creates an iterator for one of the patches adjacent to a segment identified by index position around a connected vertex.

Parameters:

	vertex	The vertex iterator object.
	i	The 0-based index of the segment.
	patch	[out] A buffer in which to return the patch iterator.

AIAPI void(* AIMeshVertexIteratorSuite::GetPoint)(AIMeshVertexIterator vertex, AIRealPoint *point)

Retrieves the position of the ends of all segments attached to a vertex.

(Note that this function does not return an error code.)

Parameters:

	vertex	The vertex iterator object.
	point	[out] A buffer in which to return the endpoint.

AIAPI AIErr(* AIMeshVertexIteratorSuite::GetSegment)(AIMeshVertexIterator vertex, ai::int32 i, AIMeshSegmentIterator *segment)

Creates an iterator for a segment identified by index position around a connected vertex.

Parameters:

	vertex	The vertex iterator object.
	i	The 0-based index of the segment.
	segment	[out] A buffer in which to return the segment iterator.

AIAPI ai::int32(* AIMeshVertexIteratorSuite::GetSegmentIndex)(AIMeshVertexIterator vertex, ai::int32 axis, ai::int32 sense)

Retrieves the index position of a segment in a given direction from a connected vertex along a given axis.

(Note that this function returns a numeric value, not an error code.)

Parameters:

	vertex	The vertex iterator object.
	axis	The axis, an `AIMeshAxis` value.
	sense	The direction, an `AIMeshAxisSense` value.

Returns:: The index position of the segment.

AIAPI ai::int32(* AIMeshVertexIteratorSuite::GetSegmentOpposite)(AIMeshVertexIterator vertex, ai::int32 i)

Retrieves the index position of the segment that is opposite a segment identified by index position around a connected vertex.

(Note that this function returns a numeric value, not an error code.)

Parameters:

	vertex	The vertex iterator object.
	i	The index position of a segment connected to the vertex.

Returns:: The index of the opposite segment, or -1 if there is no opposite segment.

AIAPI AIBoolean(* AIMeshVertexIteratorSuite::GetSmooth)(AIMeshVertexIterator vertex, ai::int32 i)

Retrieves the smoothing state of a segment identified by index position around a connected vertex.

When smoothing is on, adjusting the tangent similarly adjusts that of the opposite segment. (Note that this function returns a boolean value, not an error code.)

Parameters:

	vertex	The vertex iterator object.
	i	The 0-based index of the segment.

Returns:: True if smoothing is on, false if it is off.

AIAPI void(* AIMeshVertexIteratorSuite::GetTangent)(AIMeshVertexIterator vertex, ai::int32 i, AIRealPoint *point)

Retrieves the second point of the bezier control polygon of a segment identified by index position around a connected vertex.

(Note that this function does not return an error code.)

Parameters:

	vertex	The vertex iterator object.
	i	The 0-based index of the segment.
	point	[out] A buffer in which to return the tangent point.

AIAPI void(* AIMeshVertexIteratorSuite::GetUV)(AIMeshVertexIterator vertex, AIReal *u, AIReal *v)

Retrieves the (U,V) coordinates of a vertex.

(Note that this function does not return an error code.)

Parameters:

	vertex	The vertex iterator object.
	u	[out] A buffer in which to return the U coordinate.
	v	[out] A buffer in which to return the V coordinate.

AIAPI AIBoolean(* AIMeshVertexIteratorSuite::IsEqual)(AIMeshVertexIterator vertex1, AIMeshVertexIterator vertex2)

Reports whether two vertex iterator objects reference the same vertex.

(Note that this function returns a boolean value, not an error code.)

Parameters:

	vertex1	The first iterator object.
	vertex2	The second iterator object.

Returns:: True if the iterators are equal.

AIAPI AIBoolean(* AIMeshVertexIteratorSuite::IsNode)(AIMeshVertexIterator vertex)

Reports whether a vertex iterator identifies a node.

(Note that this function returns a boolean value, not an error code.)

Parameters:

vertex

The vertex iterator object.

Returns:: True if the current vertex is a node.

AIAPI AIBoolean(* AIMeshVertexIteratorSuite::IsOnBoundary)(AIMeshVertexIterator vertex)

Reports whether a vertex is on the edge of the mesh.

(Note that this function returns a boolean value, not an error code.)

Parameters:

vertex

The vertex iterator object.

Returns:: True if the vertex is on the edge.

AIAPI void(* AIMeshVertexIteratorSuite::Next)(AIMeshVertexIterator vertex)

Advances a vertex iterator, so that it contains the next vertex in the mesh.

Use with an iterator obtained from AIMeshSuite::GetStartVertex(). Repeated calls guarantee that every element is visited once and only once. The order of traversal is undefined. (Note that this function does not return an error code.)

Parameters:

vertex

The vertex iterator object.

See also:: Prev(), AtEnd()

AIAPI void(* AIMeshVertexIteratorSuite::NextI)(AIMeshVertexIterator vertex)

Advances a vertex iterator, so that it contains the next vertex in the mesh, increasing along the I axis.

(Note that this function does not return an error code.)

Parameters:

vertex

The vertex iterator object.

See also:: PrevI(), AtEnd()

AIAPI void(* AIMeshVertexIteratorSuite::NextJ)(AIMeshVertexIterator vertex)

Advances a vertex iterator, so that it contains the next vertex in the mesh, increasing along the J axis.

(Note that this function does not return an error code.)

Parameters:

vertex

The vertex iterator object.

See also:: PrevJ(), AtEnd()

AIAPI void(* AIMeshVertexIteratorSuite::Prev)(AIMeshVertexIterator vertex)

Backs up a vertex iterator, so that it contains the previous vertex in the mesh.

(Note that this function does not return an error code.)

Parameters:

vertex

The vertex iterator object.

See also:: Next(), AtEnd()

AIAPI void(* AIMeshVertexIteratorSuite::PrevI)(AIMeshVertexIterator vertex)

Backs up a vertex iterator, so that it contains the previous vertex in the mesh, decreasing along the I axis.

(Note that this function does not return an error code.)

Parameters:

vertex

The vertex iterator object.

See also:: NextI(), AtEnd()

AIAPI void(* AIMeshVertexIteratorSuite::PrevJ)(AIMeshVertexIterator vertex)

Backs up a vertex iterator, so that it contains the previous vertex in the mesh, decreasing along the J axis.

(Note that this function does not return an error code.)

Parameters:

vertex

The vertex iterator object.

See also:: NextJ(), AtEnd()

AIAPI ai::int32(* AIMeshVertexIteratorSuite::Release)(AIMeshVertexIterator vertex)

Decrements the reference count of a vertex iterator object, and frees the associated memory when the count reaches 0.

(Note that this function returns an numeric value, not an error code.)

Parameters:

vertex

The vertex iterator object.

Returns:: The current reference count.

AIAPI AIErr(* AIMeshVertexIteratorSuite::SetColor)(AIMeshVertexIterator vertex, AIColor *c)

Sets the color of a node.

Parameters:

	vertex	The vertex iterator object, for which the current vertex is a node.
	c	A pointer to the new color.

AIAPI AIErr(* AIMeshVertexIteratorSuite::SetOpacity)(AIMeshVertexIterator vertex, AIReal o)

Sets the opacity of a node.

Parameters:

	vertex	The vertex iterator object, for which the current vertex is a node.
	o	The opacity value (between 0.0 and 1.0).

AIAPI AIErr(* AIMeshVertexIteratorSuite::SetPoint)(AIMeshVertexIterator vertex, AIRealPoint *point)

Sets the position of the ends of all segments attached to a vertex.

Parameters:

	vertex	The vertex iterator object.
	point	A pointer to the new endpoint.

AIAPI AIErr(* AIMeshVertexIteratorSuite::SetSmooth)(AIMeshVertexIterator vertex, ai::int32 i, AIBoolean smooth)

Sets the smoothing state of a segment identified by index position around a connected vertex.

When smoothing is on, adjusting the tangent similarly adjusts that of the opposite segment.

Parameters:

	vertex	The vertex iterator object.
	i	The 0-based index of the segment.
	smooth	True to turn smoothing on, false to turn it off.

AIAPI AIErr(* AIMeshVertexIteratorSuite::SetTangent)(AIMeshVertexIterator vertex, ai::int32 i, AIRealPoint *point)

Sets the second point of the bezier control polygon of a segment identified by index position around a connected vertex.

Parameters:

	vertex	The vertex iterator object.
	i	The 0-based index of the segment.
	point	A pointer to the new tangent point.

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

AIMesh.h

AIMeshVertexIteratorSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIMeshVertexIteratorSuite Struct Reference
[API Suite List]