AIGeometrySuite Struct Reference
[API Suite List]

This suite provides an iteration mechanism for collecting information about the art objects in the various kinds of artwork trees. More...

#include <AIGeometry.h>

List of all members.

Public Attributes
ASAPI AIErr(*	GeometryIterate )(AIArtHandle art, AIGeometryOrganizationProcs *organizationProcs, AIGeometryConstructionProcs *constructionProcs, AIGeometryPaintingProcs *paintingProcs, AIGeometryStateProcs *stateProcs, AIGeometryUserData userData, ai::int32 skipArtTypes)
	Supplies information to developer-defined callback procedures, calling the procedures iteratively for each member of an artwork tree whose root is a specified art object.

---

Detailed Description

This suite provides an iteration mechanism for collecting information about the art objects in the various kinds of artwork trees.

It allows you to define a set of callback procedures to work with various aspects of artwork, including the placement, style, and color attributes. The GeometryIterate() function enumerates the contents of an artwork subtree to a set of callback functions that receive various kinds of information about each object. You need supply only the callbacks of interest to your plug-in.

All of the object information passed to the callbacks is public information that can be accessed directly through SDK functions. You can also define and pass arbitrary data to the callbacks, to use together with the object data.

All callbacks should return 0 to continue processing the next artwork element, or nonzero to halt processing. This allows you to prune the traversal of the artwork tree.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIGeometrySuite and kAIGeometryVersion.

---

Member Data Documentation

ASAPI AIErr(* AIGeometrySuite::GeometryIterate)(AIArtHandle art, AIGeometryOrganizationProcs *organizationProcs, AIGeometryConstructionProcs *constructionProcs, AIGeometryPaintingProcs *paintingProcs, AIGeometryStateProcs *stateProcs, AIGeometryUserData userData, ai::int32 skipArtTypes)

Supplies information to developer-defined callback procedures, calling the procedures iteratively for each member of an artwork tree whose root is a specified art object.

Parameters:

	art	The root art object.
	organizationProcs	For each object in the tree, calls the start and the end procedure associated the type before and after enumerating the object.
	constructionProcs	Contains pointers to callbacks that receive a geometric description of each leaf art object.
	paintingProcs	Contains pointers to callbacks that receive information about how each leaf object is painted.
	stateProcs	Contains pointers to callbacks that receive additional parameters to the painting operations.
	userData	Developer-defined data to be passed to callbacks.
	skipArtTypes	A logical OR of AIArtUserAttr values for art objects to skip during iteration. As an example, pass kArtHidden | kArtLocked to skip hidden and locked arts Pass 0 to skip no arts.

---

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

• AIGeometry.h