AIPathInstallData Struct Reference

Installation data for AIPathInterpolateSuite::InsertInterpolants():. More...

#include <AIPathInterpolate.h>

List of all members.

Public Attributes
AIArtHandle	parent
	The parent art object in the paint order of the current document's art tree.
AIArtHandle	refChild
	The prepositional object if paintOrder is kPlaceBelow or kPlaceAbove, otherwise NULL.
ai::int16	paintOrder
	The paint order position of the new path, relative to the refChild object, an AITypes::AIPaintOrder value.
AIBoolean	endOnBottom
	For default interpolation (when the post-install callback is NULL); ignored otherwise.
void *	clientData
	Developer-defined data to pass to the developer-defined post-install callback.

---

Detailed Description

Installation data for AIPathInterpolateSuite::InsertInterpolants():.

Initialize the parent, paintOrder and refChild to describe where to install the first interpolated path.

• If refChild is non-null, it must be a child of parent, and the paintOrder must be kPlaceBelow or kPlaceAbove.
• If refChild is NULL, paintOrder must be kPlaceInsideOnTop or kPlaceInsideOnBottom.

---

Member Data Documentation

void* AIPathInstallData::clientData

Developer-defined data to pass to the developer-defined post-install callback.

AIBoolean AIPathInstallData::endOnBottom

For default interpolation (when the post-install callback is NULL); ignored otherwise.

• When true, each path is linked as the sibling of the previous one, so that the last created path, the one most like the supplied end path, is on the bottom.
• When false, the previous path becomes the sibling of the next one created, so that the last created path, the one most like the supplied end path, is on the top.

ai::int16 AIPathInstallData::paintOrder

The paint order position of the new path, relative to the refChild object, an AITypes::AIPaintOrder value.

AIArtHandle AIPathInstallData::parent

The parent art object in the paint order of the current document's art tree.

AIArtHandle AIPathInstallData::refChild

The prepositional object if paintOrder is kPlaceBelow or kPlaceAbove, otherwise NULL.

---

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

• AIPathInterpolate.h