AIPluginGroupMessage Struct Reference

Sent with the kSelectorAINotifyEdits, kSelectorAIUpdateArt, kSelectorAICanShowContents and kSelectorAIInterpolateData notifications. More...

#include <AIPluginGroup.h>

List of all members.

Public Attributes
SPMessageData	d
	The message data.
AIPluginGroupHandle	entry
	The plug-in group object.
AIArtHandle	art
	The plug-in group art object.
AIOperationTime	time
	For kSelectorAINotifyEdits and kSelectorAIInterpolateData messages, the stage of the operation (check if allowed, before, during, after).
AIOperationCode	code
	For kSelectorAINotifyEdits, the specific operation being performed.
AIArtHandle	preEditArt
	For kSelectorAINotifyEdits, the descendant of the edit art group that is about to be edited.
AIArtHandle	postEditArt
	For kSelectorAINotifyEdits, the object what will be in the edit group when the operation completes.
AIErr	subCode
	For some operation codes, a subcodes that further describes the operation being performed.
AIRealMatrix	matrix
	For kSelectorAINotifyEdits, supplied if code is kTransformOperationCode or subCode is kTransformCopyOpCode.
StyleUnion	style
	For kSelectorAINotifyEdits, supplied if code is kStyleOperationCode.
StyleMapUnion	styleMap
	For kSelectorAINotifyEdits, supplied if code is kStyleOperationCode.
AIInterruptProc	proc
	For kSelectorAIUpdateArt and kSelectorAIInterpolateData, A callback that allows you to interrupt lengthy processing.
AIInterruptData	data
	For kSelectorAIUpdateArt and kSelectorAIInterpolateData.
int	steps
	For kSelectorAIInterpolateData.
AIReal	t
	For kSelectorAIInterpolateData.
AIPatternHandle	toSymbol
	For kSelectorAINotifyEdits, supplied if code is kGeometryOperationCode and subCode is kSwapSymbolsOpCode.
ai::int32	transformFlags
	For kSelectorAINotifyEdits, supplied if code is kTransformOperationCode or subCode is kTransformCopyOpCode.
AIReal	transformLineScale
	For kSelectorAINotifyEdits, supplied if code is kTransformOperationCode or subCode is kTransformCopyOpCode.
AIArtHandle	destinationArt
	For reordering, duplicating, and pasting operations, the preposition object in the paint order, for relative placement of the new object.
AIPaintOrder	insertionOrder
	For kSelectorAINotifyEdits, supplied for reordering, duplicating and pasting operations.
AIVersion	aiVersion
	For kSelectorAINotifyEdits, supplied if code is kReadOperationCode kWriteOperationCode.

---

Detailed Description

Sent with the kSelectorAINotifyEdits, kSelectorAIUpdateArt, kSelectorAICanShowContents and kSelectorAIInterpolateData notifications.

The kSelectorAINotifyEdits notifies of edits in the edit group. In this case the time and code members provide more information about the stage of the editing operation and the operation being performed. Additional members provide information about what is being edited, how it is being edited and the replacement art that will be the edited result.
Process this information and return one of these error codes to control how the operation proceeds:
kRefusePluginGroupReply
kWantsAfterMsgPluginGroupReply
kMarkValidPluginGroupReply
kDontCarePluginGroupReply
kDestroyPluginGroupReply

The kSelectorAIUpdateArt message is sent to request that the plug-in group manager rebuild the result group in response to edits in the edit group. In this case the only the proc and data fields are used.

---

Member Data Documentation

AIVersion AIPluginGroupMessage::aiVersion

For kSelectorAINotifyEdits, supplied if code is kReadOperationCode kWriteOperationCode.

The version of the Illustrator file being read from or written to. For other operations, the value is 0.

AIArtHandle AIPluginGroupMessage::art

The plug-in group art object.

AIOperationCode AIPluginGroupMessage::code

For kSelectorAINotifyEdits, the specific operation being performed.

SPMessageData AIPluginGroupMessage::d

The message data.

AIInterruptData AIPluginGroupMessage::data

For kSelectorAIUpdateArt and kSelectorAIInterpolateData.

Developer-defined data to pass through to the proc callback.

AIArtHandle AIPluginGroupMessage::destinationArt

For reordering, duplicating, and pasting operations, the preposition object in the paint order, for relative placement of the new object.

See AIArtSuite::NewArt.

AIPluginGroupHandle AIPluginGroupMessage::entry

The plug-in group object.

AIPaintOrder AIPluginGroupMessage::insertionOrder

For kSelectorAINotifyEdits, supplied for reordering, duplicating and pasting operations.

The paint-order placement of the new object, relative to the destinationArt object. Cannot be kPlaceAboveAll or kPlaceBelowAll (because the object must go inside a plug-in group). Never kPlaceDefault (it is translated into a more specific paint order before notification).

AIRealMatrix AIPluginGroupMessage::matrix

For kSelectorAINotifyEdits, supplied if code is kTransformOperationCode or subCode is kTransformCopyOpCode.

The matrix used for the transformation.

AIArtHandle AIPluginGroupMessage::postEditArt

For kSelectorAINotifyEdits, the object what will be in the edit group when the operation completes.

For edits that change attributes but keep the same art object (such as most style operations), the same as preEditArt. At kBeforeOperationTime, the attributes have not yet been modified. If not the same as preEditArt, the object is not in the edit art group until kAfterOperationTime. Transformation, geometry changes or attribute changes have already been performed on the object, but is has not yet been inserted into the artwork.

Note:

You must not dispose of or reorder any artwork objects during a kCheckOperationTime or kBeforeOperationTime notification. Any editing must wait until kAfterOperationTime.

AIArtHandle AIPluginGroupMessage::preEditArt

For kSelectorAINotifyEdits, the descendant of the edit art group that is about to be edited.

AIInterruptProc AIPluginGroupMessage::proc

For kSelectorAIUpdateArt and kSelectorAIInterpolateData, A callback that allows you to interrupt lengthy processing.

int AIPluginGroupMessage::steps

For kSelectorAIInterpolateData.

At kBeforeOperationTime or kAfterOperationTime, the number of steps in the blend.
At kDuringOperationTime, the number of this step (first step is 1).

StyleUnion AIPluginGroupMessage::style

For kSelectorAINotifyEdits, supplied if code is kStyleOperationCode.

The style that was modified.

StyleMapUnion AIPluginGroupMessage::styleMap

For kSelectorAINotifyEdits, supplied if code is kStyleOperationCode.

Indicates which fields of style are valid, if it is a partial style. If NULL, all style fields are valid.

AIErr AIPluginGroupMessage::subCode

For some operation codes, a subcodes that further describes the operation being performed.

See AIOperationCode. Subcodes are four-byte chars like AIErr, that facilitate debugging while still allowing switch statements.

AIReal AIPluginGroupMessage::t

For kSelectorAIInterpolateData.

The distance of this interpolation between the source and destination of the blend. [0..1], where 0 is the source (preEditArt) and 1 is the destination (postEditArt).

AIOperationTime AIPluginGroupMessage::time

For kSelectorAINotifyEdits and kSelectorAIInterpolateData messages, the stage of the operation (check if allowed, before, during, after).

AIPatternHandle AIPluginGroupMessage::toSymbol

For kSelectorAINotifyEdits, supplied if code is kGeometryOperationCode and subCode is kSwapSymbolsOpCode.

In this case, art is a symbol instance in the edit group, and this is the replacement symbol. (If your plug-in group uses symbols in its art dictionary, see also kSelectorAIReplaceSymbol.)

ai::int32 AIPluginGroupMessage::transformFlags

For kSelectorAINotifyEdits, supplied if code is kTransformOperationCode or subCode is kTransformCopyOpCode.

Transformation options, a logical OR of AITransformArtOptions.

AIReal AIPluginGroupMessage::transformLineScale

For kSelectorAINotifyEdits, supplied if code is kTransformOperationCode or subCode is kTransformCopyOpCode.

If transformFlags contains kScaleLines, the factor by which the strokes are scaled.

---

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

• AIPluginGroup.h