AILiveEffectAdjustColorsMessage Struct Reference

Sent with kSelectorAILiveEffectAdjustColors to allow another plug-in that does color manipulations to extract and/or modify any private color data that the effect plug-in has stored in its parameter dictionary, including colors contained indirectly in art objects, art styles or symbol references. More...

#include <AILiveEffect.h>

List of all members.

Public Attributes
SPMessageData	d
	The message data.
AILiveEffectHandle	effect
	The effect object.
AILiveEffectParameters	parameters
	The current parameter block for the effect.
AIAdjustColorFunc	adjustColorCallback
	A callback function to adjust colors, supplied by a plug-in other than the one that manages the effect.
AIAdjustPatternHandleFunc	adjustPatternHandleCallback
	A callback function to adjust patterns, supplied by a plug-in other than the one that manages the effect.
void *	clientData
	Developer-defined private data to pass to the callback.
VisitAIColorFlags	controlFlags
	A logical OR of bit-flag constants that controls which colors are passed to the callback.
AIBoolean	modifiedSomething
	[out] Set to true if the handler modified any colors.

Detailed Description

Sent with kSelectorAILiveEffectAdjustColors to allow another plug-in that does color manipulations to extract and/or modify any private color data that the effect plug-in has stored in its parameter dictionary, including colors contained indirectly in art objects, art styles or symbol references.

This parameter block contains only private color information for an effect. Normal fill and stroke colors (that is, those which are stored under kFillStyleKey or kStrokeStyleKey) are adjusted without consulting the effect.

The color-adjustment callback is supplied by a plug-in other than the one that manages the effect. The initial request is generally initiated by AIPathStyleSuite::AdjustObjectAIColors(), and the effect that receives this message has been encountered while processing that request.

If the parameter dictionary contains private AIColor values, they should be passed directly to the color-adjustment callback.

If the parameter dictionary contains art objects that contain meaningful colors, those objects should be passed to AIPathStyleSuite::AdjustObjectAIColors(), along with this callback function, client data, and control flags.

If the parameter dictionary contains symbol handles or brush pattern handles that contain meaningful colors, the symbol patterns or brush patterns should be passed to the pattern-adjustment callback. These could be, for example, symbols mapped to surfaces by the 3D effect. Other symbols can be ignored; for example, symbols that define 3D bevel shapes.