AILiveEffectEditParamMessage Struct Reference

Sent when the user chooses a your registered effect from the Effects menu, or when the user later edits the effect using the appearance palette. More...

#include <AILiveEffect.h>

List of all members.

Public Attributes
SPMessageData	d
	The message data.
AILiveEffectHandle	effect
	The effect object.
AILiveEffectParameters	parameters
	[in, out] A set of parameters that the plug-in may have stored from an earlier invocation.
AILiveEffectParamContext	context
	The parameter context, passed to various functions.
AIBoolean	allowPreview
	True if preview is enabled.
AIBoolean	isNewInstance
	True if this is the first time this effect is being applied by this plug-in, false if the effect is being modified (from the Appearance panel, for example).

---

Detailed Description

Sent when the user chooses a your registered effect from the Effects menu, or when the user later edits the effect using the appearance palette.

The plug-in can ignore the selector if it does not require user input; otherwise, it should collect parameter values from the user, typically using a modal dialog. If previews are enabled, it can then update the artwork using AILiveEffectSuite::UpdateParameters() to preview the results. The plug-in must call AILiveEffectSuite::UpdateParameters() after it finishes collecting user input and updating values.

---

Member Data Documentation

AIBoolean AILiveEffectEditParamMessage::allowPreview

True if preview is enabled.

If it is, the plug-in can call AILiveEffectSuite::UpdateParameters after modifying the parameters, to update the associated artwork. The plug-in receives a Go message after updating parameters.

AILiveEffectParamContext AILiveEffectEditParamMessage::context

The parameter context, passed to various functions.

SPMessageData AILiveEffectEditParamMessage::d

The message data.

AILiveEffectHandle AILiveEffectEditParamMessage::effect

The effect object.

AIBoolean AILiveEffectEditParamMessage::isNewInstance

True if this is the first time this effect is being applied by this plug-in, false if the effect is being modified (from the Appearance panel, for example).

AILiveEffectParameters AILiveEffectEditParamMessage::parameters

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

Modify values if desired.

---

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

• AILiveEffect.h