AIMeshHitSuite Struct Reference
[API Suite List]

This suite provides functions that operate on hit objects obtained by AIHitTestSuite functions, when the result of the test is a hit on a mesh object. More...

#include <AIMesh.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	GetPart )(AIHitRef hit)
	Reports the element of a mesh that was hit.
AIAPI void(*	GetUV )(AIHitRef hit, AIReal *u, AIReal *v)
	Retrieves the (u,v) coordinates of a hit on a mesh object.
AIAPI AIErr(*	GetSelection )(AIHitRef hit, AIMeshSelection *selection)
	Constructs a new selection from a hit, which contains the element that was hit.
AIAPI AIErr(*	GetVertex )(AIHitRef hit, AIMeshVertexIterator *vertex)
	If a vertex or tangent was hit, creates an iterator for the vertex.
AIAPI AIErr(*	GetTangentIndex )(AIHitRef hit, ai::int32 *index)
	If a tangent was hit, retrieves the tangent index.
AIAPI AIErr(*	GetSegment )(AIHitRef hit, AIMeshSegmentIterator *segment)
	If a segment was hit, creates an iterator for the segment.
AIAPI AIErr(*	GetPatch )(AIHitRef hit, AIMeshPatchIterator *patch)
	If a patch was hit, creates an iterator for the patch.

---

Detailed Description

This suite provides functions that operate on hit objects obtained by AIHitTestSuite functions, when the result of the test is a hit on a mesh object.

They allow you to identify the part of the mesh object that was hit, and to change the selection or iterate through elements of the mesh based on hit results.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIMeshHitSuite and kAIMeshHitVersion.

---

Member Data Documentation

AIAPI ai::int32(* AIMeshHitSuite::GetPart)(AIHitRef hit)

Reports the element of a mesh that was hit.

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

Parameters:

hit

The hit object.

Returns:

The element that was hit, an AIMeshPart value.

AIAPI AIErr(* AIMeshHitSuite::GetPatch)(AIHitRef hit, AIMeshPatchIterator *patch)

If a patch was hit, creates an iterator for the patch.

Parameters:

	hit	The hit object.
	patch	[out] A buffer in which to return the iterator.

AIAPI AIErr(* AIMeshHitSuite::GetSegment)(AIHitRef hit, AIMeshSegmentIterator *segment)

If a segment was hit, creates an iterator for the segment.

Parameters:

	hit	The hit object.
	segment	[out] A buffer in which to return the iterator.

AIAPI AIErr(* AIMeshHitSuite::GetSelection)(AIHitRef hit, AIMeshSelection *selection)

Constructs a new selection from a hit, which contains the element that was hit.

Parameters:

	hit	The hit object.
	selection	[out] A buffer in which to return the new selection object.

AIAPI AIErr(* AIMeshHitSuite::GetTangentIndex)(AIHitRef hit, ai::int32 *index)

If a tangent was hit, retrieves the tangent index.

Parameters:

	hit	The hit object.
	index	[out] A buffer in which to return the 0-based index.

AIAPI void(* AIMeshHitSuite::GetUV)(AIHitRef hit, AIReal *u, AIReal *v)

Retrieves the (u,v) coordinates of a hit on a mesh object.

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

Parameters:

	hit	The hit object.
	u	[out] A buffer in which to return the U-axis coordinate, in the range [0..M], where M is the number of horizontal patches.
	v	[out] A buffer in which to return the V-axis coordinate, in the range [0..N], where N is the number of vertical patches.

See also:

Mesh Terminology.

AIAPI AIErr(* AIMeshHitSuite::GetVertex)(AIHitRef hit, AIMeshVertexIterator *vertex)

If a vertex or tangent was hit, creates an iterator for the vertex.

Parameters:

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

---

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

• AIMesh.h