AIMeshSelectionSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to create and manipulate mesh selections, which identify a subset of the vertices and segments of a mesh. More...

#include <AIMesh.h>

List of all members.

Public Attributes
AIAPI ai::int32(*	AddRef )(AIMeshSelection selection)
	Increments the reference count of a mesh selection.
AIAPI ai::int32(*	Release )(AIMeshSelection selection)
	Decrements the reference count of a mesh selection, and frees the associated memory when the count reaches 0.
AIAPI AIErr(*	Copy )(AIMeshSelection selection, AIMeshSelection from)
	Copies the contents of a mesh selection into another, existing selection object.
AIAPI AIErr(*	Clone )(AIMeshSelection selection, AIMeshSelection *clone)
	Duplicates a mesh selection, creating a new selection object.
AIAPI AIBoolean(*	IsEmpty )(AIMeshSelection selection)
	Reports whether a mesh selection does not contain any vertices, segments or patches.
AIAPI AIBoolean(*	IsFull )(AIMeshSelection selection)
	Reports whether a mesh selection contains every vertex, segment, and patch.
AIAPI AIBoolean(*	IsEqual )(AIMeshSelection selection1, AIMeshSelection selection2)
	Reports whether two mesh selection objects reference the same selection set.
AIAPI AIBoolean(*	Contains )(AIMeshSelection selection1, AIMeshSelection selection2)
	Reports whether a mesh selection contains all of the objects that are in another selection.
AIAPI AIBoolean(*	ContainsVertex )(AIMeshSelection selection, AIMeshVertexIterator vertex)
	Reports whether a mesh selection contains a specific vertex.
AIAPI AIBoolean(*	ContainsSegment )(AIMeshSelection selection, AIMeshSegmentIterator segment)
	Reports whether a mesh selection contains a specific segment.
AIAPI AIBoolean(*	RendersControl )(AIMeshSelection selection, AIMeshSegmentIterator segment)
	Reports whether the reshaping control of a segment would be visible in a selection.
AIAPI AIErr(*	Intersect )(AIMeshSelection selection1, AIMeshSelection selection2)
	Modifies a selection to be the intersection of itself and another selection.
AIAPI AIErr(*	Union )(AIMeshSelection selection1, AIMeshSelection selection2)
	Modifies a selection to be the union of itself and another selection.
AIAPI AIErr(*	Invert )(AIMeshSelection selection1, AIMeshSelection selection2)
	Modifies a selection to invert the selection state of parts identified by another selection.
AIAPI AIErr(*	SelectPatch )(AIMeshSelection selection, AIMeshPatchIterator patch, AIBoolean select)
	Adds a patch to or removes it from a selection.
AIAPI AIErr(*	SelectVertex )(AIMeshSelection selection, AIMeshVertexIterator vertex, AIBoolean select)
	Adds a vertex to or removes it from a selection.
AIAPI AIErr(*	SelectSegment )(AIMeshSelection selection, AIMeshSegmentIterator segment, AIBoolean select)
	Adds a segment to or removes it from a selection.
AIAPI AIErr(*	Transform )(AIMeshSelection selection, AIRealMatrix *matrix)
	Transforms the points of a mesh selection by a transformation matrix.
AIAPI AIErr(*	MapPoints )(AIMeshSelection selection, AIMeshPointMap f, void *userData)
	Transforms the points of a mesh selection according to a developer-defined mapping function.
AIAPI AIErr(*	MapColors )(AIMeshSelection selection, AIMeshColorMap f, void *userData)
	Transforms the colors of a gradient mesh selection according to a developer-defined mapping function.
AIAPI void(*	QueryColors )(AIMeshSelection selection, AIMeshColorQuery f, void *userData)
	Passes the colors of a gradient mesh selection to a developer-defined query function.
AIAPI void(*	BoundPieces )(AIMeshSelection selection, AIRealMatrix matrix, ai::int32 variant, AIRealRect bounds)
	Computes the bounds of the selected pieces of a mesh.

Detailed Description

This suite provides functions that allow you to create and manipulate mesh selections, which identify a subset of the vertices and segments of a mesh.

You can create any number of selections for a mesh, using AIMeshSuite::NewSelection().

There is one special selection associated with a mesh object that identifies the subset of vertices and segments the user has selected. This is the visible selection. You can obtain this selection with AIMeshSuite::GetSelection(). Making a change to the contents of this selection affects what is displayed as selected in the document window.

Selections are reference counted. When you get a selection its initial reference count is 1, so you do not typically need to call AddRef().You must call Release() to decrement the count of a selection when you are no longer using it. Failure to release selections causes memory leaks.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIMeshSelectionSuite and kAIMeshSelectionVersion.

Member Data Documentation

AIAPI ai::int32(* AIMeshSelectionSuite::AddRef)(AIMeshSelection selection)

Increments the reference count of a mesh selection.

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

Parameters:

selection

The selection.

Returns:: The current reference count.

AIAPI void(* AIMeshSelectionSuite::BoundPieces)(AIMeshSelection selection, AIRealMatrix *matrix, ai::int32 variant, AIRealRect *bounds)

Computes the bounds of the selected pieces of a mesh.

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

Parameters:

	selection	The mesh selection object.
	matrix	A pointer to a transformation matrix to apply to the selection before calculating its bounds. If this argument is `NULL` the identity matrix will be used.
	variant	How the bounds are computed, a `AIMeshSelectionBoundsVariant` value.
	bounds	[out] A buffer in which to return the bounding box.

AIAPI AIErr(* AIMeshSelectionSuite::Clone)(AIMeshSelection selection, AIMeshSelection *clone)

Duplicates a mesh selection, creating a new selection object.

Parameters:

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

AIAPI AIBoolean(* AIMeshSelectionSuite::Contains)(AIMeshSelection selection1, AIMeshSelection selection2)

Reports whether a mesh selection contains all of the objects that are in another selection.

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

Parameters:

	selection1	The first mesh selection object.
	selection2	The second mesh selection object.

Returns:: True if the second selection is a subset of the first.

AIAPI AIBoolean(* AIMeshSelectionSuite::ContainsSegment)(AIMeshSelection selection, AIMeshSegmentIterator segment)

Reports whether a mesh selection contains a specific segment.

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

Parameters:

	selection	The mesh selection object.
	segment	The segment.

Returns:: True if the segment is in the selection.

AIAPI AIBoolean(* AIMeshSelectionSuite::ContainsVertex)(AIMeshSelection selection, AIMeshVertexIterator vertex)

Reports whether a mesh selection contains a specific vertex.

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

Parameters:

	selection	The mesh selection object.
	vertex	The vertex.

Returns:: True if the vertex is in the selection.

AIAPI AIErr(* AIMeshSelectionSuite::Copy)(AIMeshSelection selection, AIMeshSelection from)

Copies the contents of a mesh selection into another, existing selection object.

Parameters:

	selection	The destination selection object.
	from	The source selection object.

AIAPI AIErr(* AIMeshSelectionSuite::Intersect)(AIMeshSelection selection1, AIMeshSelection selection2)

Modifies a selection to be the intersection of itself and another selection.

Parameters:

	selection1	The first mesh selection object, which is modified.
	selection2	The second mesh selection object.

AIAPI AIErr(* AIMeshSelectionSuite::Invert)(AIMeshSelection selection1, AIMeshSelection selection2)

Modifies a selection to invert the selection state of parts identified by another selection.

Parameters:

	selection1	The first mesh selection object, which is modified.
	selection2	The second mesh selection object, which identifies the parts to toggle.

AIAPI AIBoolean(* AIMeshSelectionSuite::IsEmpty)(AIMeshSelection selection)

Reports whether a mesh selection does not contain any vertices, segments or patches.

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

Parameters:

selection

The mesh selection object.

Returns:: True if the selection is empty.

AIAPI AIBoolean(* AIMeshSelectionSuite::IsEqual)(AIMeshSelection selection1, AIMeshSelection selection2)

Reports whether two mesh selection objects reference the same selection set.

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

Parameters:

	selection1	The first mesh selection object.
	selection2	The second mesh selection object.

Returns:: True if the selections are equal.

AIAPI AIBoolean(* AIMeshSelectionSuite::IsFull)(AIMeshSelection selection)

Reports whether a mesh selection contains every vertex, segment, and patch.

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

Parameters:

selection

The mesh selection object.

Returns:: True if the selection is full.

AIAPI AIErr(* AIMeshSelectionSuite::MapColors)(AIMeshSelection selection, AIMeshColorMap f, void *userData)

Transforms the colors of a gradient mesh selection according to a developer-defined mapping function.

Parameters:

	selection	The mesh selection object.
	f	The color-mapping function.
	userData	Developer-defined data to pass through to the function.

AIAPI AIErr(* AIMeshSelectionSuite::MapPoints)(AIMeshSelection selection, AIMeshPointMap f, void *userData)

Transforms the points of a mesh selection according to a developer-defined mapping function.

Parameters:

	selection	The mesh selection object.
	f	The point-mapping function.
	userData	Developer-defined data to pass through to the function.

AIAPI void(* AIMeshSelectionSuite::QueryColors)(AIMeshSelection selection, AIMeshColorQuery f, void *userData)

Passes the colors of a gradient mesh selection to a developer-defined query function.

Does not modify the mesh colors. (Note that this function does not return an error code.)

Parameters:

	selection	The mesh selection object.
	f	The color-querying function.
	userData	Developer-defined data to pass through to the function.

AIAPI ai::int32(* AIMeshSelectionSuite::Release)(AIMeshSelection selection)

Decrements the reference count of a mesh selection, and frees the associated memory when the count reaches 0.

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

Parameters:

selection

The selection.

Returns:: The current reference count.

AIAPI AIBoolean(* AIMeshSelectionSuite::RendersControl)(AIMeshSelection selection, AIMeshSegmentIterator segment)

Reports whether the reshaping control of a segment would be visible in a selection.

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

Parameters:

	selection	The mesh selection object.
	segment	The segment.

Returns:: True if the reshaping control would be visible.

AIAPI AIErr(* AIMeshSelectionSuite::SelectPatch)(AIMeshSelection selection, AIMeshPatchIterator patch, AIBoolean select)

Adds a patch to or removes it from a selection.

Parameters:

	selection	The mesh selection object.
	patch	The patch.
	select	True to add the patch to the selection, false to deselect it.

AIAPI AIErr(* AIMeshSelectionSuite::SelectSegment)(AIMeshSelection selection, AIMeshSegmentIterator segment, AIBoolean select)

Adds a segment to or removes it from a selection.

Parameters:

	selection	The mesh selection object.
	segment	The segment.
	select	True to add the segment to the selection, false to deselect it.

AIAPI AIErr(* AIMeshSelectionSuite::SelectVertex)(AIMeshSelection selection, AIMeshVertexIterator vertex, AIBoolean select)

Adds a vertex to or removes it from a selection.

Parameters:

	selection	The mesh selection object.
	vertex	The vertex.
	select	True to add the vertex to the selection, false to deselect it.

AIAPI AIErr(* AIMeshSelectionSuite::Transform)(AIMeshSelection selection, AIRealMatrix *matrix)

Transforms the points of a mesh selection by a transformation matrix.

Parameters:

	selection	The mesh selection object.
	matrix	A pointer to the transformation matrix.

AIAPI AIErr(* AIMeshSelectionSuite::Union)(AIMeshSelection selection1, AIMeshSelection selection2)

Modifies a selection to be the union of itself and another selection.

Parameters:

	selection1	The first mesh selection object, which is modified..
	selection2	The second mesh selection object.

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

AIMesh.h

AIMeshSelectionSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIMeshSelectionSuite Struct Reference
[API Suite List]