AILiveEffectGoMessage Struct Reference

Sent when the user chooses your registered effect from the Effects menu, after the Edit parameters message that allows you to collect parameter values from the user. More...

#include <AILiveEffect.h>

List of all members.

Public Attributes
SPMessageData	d
	The message data.
AILiveEffectHandle	effect
	The effect object.
AILiveEffectParameters	parameters
	The current parameters block, as returned from the Edit parameters message.
AILiveEffectParameters	instanceInfo
	[in, out] A set of parameters that the plug-in may have stored from an earlier invocation on this object.
AIArtHandle	art
	[in, out] The art object to be edited with this effect.

---

Detailed Description

Sent when the user chooses your registered effect from the Effects menu, after the Edit parameters message that allows you to collect parameter values from the user.

Also sent when the effect needs to be run in response to user edits to the objects. The plug-in should respond by running its effect on the supplied art object using the supplied parameters.

---

Member Data Documentation

AIArtHandle AILiveEffectGoMessage::art

[in, out] The art object to be edited with this effect.

You must not modify any ancestor objects, nor modify the document artwork tree. The plug-in is responsible for proper deletion of objects in source art that it removes. You can set this to NULL if the effect does not return any art; in this case, Illustrator disposes of the input art.

SPMessageData AILiveEffectGoMessage::d

The message data.

AILiveEffectHandle AILiveEffectGoMessage::effect

The effect object.

AILiveEffectParameters AILiveEffectGoMessage::instanceInfo

[in, out] A set of parameters that the plug-in may have stored from an earlier invocation on this object.

AILiveEffectParameters AILiveEffectGoMessage::parameters

The current parameters block, as returned from the Edit parameters message.

---

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

• AILiveEffect.h