AILiveEffect.h Go to the documentation of this file. /************************************************************************* * * ADOBE CONFIDENTIAL * * Copyright 1986 Adobe * * All Rights Reserved. * * NOTICE: Adobe permits you to use, modify, and distribute this file in * accordance with the terms of the Adobe license agreement accompanying * it. If you have received this file from a source other than Adobe, * then your use, modification, or distribution of it requires the prior * written permission of Adobe. * **************************************************************************/ #ifndef __AILiveEffect__ #define __AILiveEffect__ /******************************************************************************* ** ** Imports ** **/ #ifndef __AITypes__ #include "AITypes.h" #endif #ifndef __AIArt__ #include "AIArt.h" #endif #ifndef __AIDict__ #include "AIDictionary.h" #endif #ifndef __AIFilter__ #include "AIFilter.h" #endif #ifndef __AIMenu__ #include "AIMenu.h" #endif #ifndef __AIPlugin__ #include "AIPlugin.h" #endif #ifndef __AIXMLElement__ #include "AIXMLElement.h" #endif #include "AIHeaderBegin.h" /******************************************************************************* ** ** Constants ** **/ #define kAILiveEffectSuite "AI Live Effect Suite" #define kAILiveEffectSuiteVersion AIAPI_VERSION(7) #define kAILiveEffectVersion kAILiveEffectSuiteVersion #define kCallerAILiveEffect "AI Live Effect" #define kAILiveEffectParamsExpandBeforeKey "Adobe Effect Expand Before Version" #define kAILiveEffectParamsWriteAlternateVersionMajorKey "Adobe Effect Expand Write Alternate Version Major" #define kAILiveEffectParamsWriteAlternateVersionMinorKey "Adobe Effect Expand Write Alternate Version Minor" // These are the effect messages. #define kSelectorAIEditLiveEffectParameters "AI Live Effect Edit Parameters" #define kSelectorAIGoLiveEffect "AI Live Effect Go Live" #define kSelectorAILiveEffectInterpolate "AI Live Effect Interpolate Parameters" #define kSelectorAILiveEffectInputType "AI Live Effect Input Type" #define kSelectorAILiveEffectConverColorSpace "AI Live Effect Convert Color Space" #define kSelectorAILiveEffectScaleParameters "AI Live Effect Scale Parameters" #define kSelectorAILiveEffectHandleMerge "AI Live Effect Handle Merge" #define kSelectorAILiveEffectGetSVGFilter "AI Live Effect Get SVG Filter" #define kSelectorAILiveEffectAdjustColors "AI Live Effect Adjust Colors" #define kSelectorAILiveEffectIsCompatible "AI Live Effect Is Compatible" #define kSelectorAILiveEffectDocScaleConvertParameters "AI Live Effect Doc Scale Convert Parameters" #define kDisplayStringKey "DisplayString" #define kExtraStringKey "ExtraString" #define kFillStyleKey "FillStyle" #define kTransformedFillStyleKey "TransformedFillStyle" #define kFillStyleMatrixKey "FillStyleMatrix" #define kEvenOddKey "UseEvenOdd" #define kStrokeStyleKey "StrokeStyle" #define kTransformedStrokeStyleKey "TransformedStrokeStyle" #define kStrokeStyleMatrixKey "StrokeStyleMatrix" #define kScaleFactorKey "ScaleFactorString" /******************************************************************************* ** ** Types ** **/ typedef struct _t_AILiveEffectOpaque* AILiveEffectHandle; typedef struct _t_AILiveEffectParamContext* AILiveEffectParamContext; struct AddLiveEffectMenuData { char *category; char *title; ai::int32 options; }; typedef AIDictionaryRef AILiveEffectParameters; typedef ConstAIDictionaryRef ConstAILiveEffectParameters; enum AIStyleFilterFlags { kNoFlags = 0, kPreEffectFilter = 0x1, kPostEffectFilter = 0x2, kStrokeFilter = 0x3, kFillFilter = 0x4, kFilterTypeMask = 0x0ffff, kSpecialGroupPreFilter = 1 << 16, kHasScalableParams = 1 << 17, kUsesAutoRasterize = 1 << 18, kCanGenerateSVGFilter = 1 << 19, kHandlesAdjustColorsMsg = 1 << 20, kHandlesIsCompatibleMsg = 1 << 21, /*Parameters can be converted during Document Scale Conversion*/ kHasDocScaleConvertibleParams = 1 << 22 }; enum AIStyleFilterPreferredInputArtType { kInputArtDynamic = 0, kGroupInputArt = 1 << ((ai::int32) kGroupArt - 1), kPathInputArt = 1 << ((ai::int32) kPathArt - 1), kCompoundPathInputArt = 1 << ((ai::int32) kCompoundPathArt - 1), kTextInputArtUnsupported = 1 << ((ai::int32) kTextArtUnsupported - 1), kTextPathInputArtUnsupported= 1 << ((ai::int32) kTextPathArtUnsupported - 1), kTextRunInputArtUnsupported = 1 << ((ai::int32) kTextRunArtUnsupported - 1), kPlacedInputArt = 1 << ((ai::int32) kPlacedArt - 1), kMysteryPathInputArt = 1 << ((ai::int32) kMysteryPathArt - 1), kRasterInputArt = 1 << ((ai::int32) kRasterArt - 1), kPluginInputArt = 1 << ((ai::int32) kPluginArt - 1), kMeshInputArt = 1 << ((ai::int32) kMeshArt - 1), kTextFrameInputArt = 1 << ((ai::int32) kTextFrameArt - 1), kSymbolInputArt = 1 << ((ai::int32) kSymbolArt - 1), kForeignInputArt = 1 << ((ai::int32) kForeignArt - 1), kLegacyTextInputArt = 1 << ((ai::int32) kLegacyTextArt - 1), kChartInputArt = 1 << ((ai::int32) kChartArt - 1), kAnyInputArt = 0xFFFF, kAnyInputArtButPluginArt = kAnyInputArt & ~kPluginInputArt, // Special values that don't correspond to regular art types should be in the high half word // When set, convert strokes to outlines before sending to effect kOutlinedStrokeInputArt = 0x10000, /* (Because it would destroy them by rasterizing, for example, or by splitting a single path into multiple non-intersecting paths, or by turning it into a plug-in group, like the brush filter). This flag is on for "Not OK" instead of on for "OK" because destroying clipping paths is an exceptional condition and we don't want to require normal filters to explicitly say they're OK. */ kNoClipMasksInputArt = 0x20000 }; enum AILiveEffectMergeAction { kAppendLiveEffectToStyle, kReplaceFillWithLiveEffect, kReplaceStrokeWithLiveEffect, kSendHandleMergeMessage = 0x10000 }; struct AILiveEffectData { SPPluginRef self; const char* name; char *title; ai::int32 majorVersion; ai::int32 minorVersion; ai::int32 prefersAsInput; ai::int32 styleFilterFlags; }; // // The contents of Live Effect messages. // struct AILiveEffectGoMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AILiveEffectParameters instanceInfo; AIArtHandle art; }; struct AILiveEffectEditParamMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AILiveEffectParamContext context; AIBoolean allowPreview; AIBoolean isNewInstance; }; struct AILiveEffectInterpParamMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters startParams; AILiveEffectParameters endParams; AILiveEffectParameters outParams; AIReal percent; }; struct AILiveEffectInputTypeMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AIArtHandle inputArt; ai::int32 typeMask; }; struct AILiveEffectConvertColorMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AIColorTag newColorSpace; }; struct AILiveEffectAdjustColorsMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AIAdjustColorFunc adjustColorCallback; AIAdjustPatternHandleFunc adjustPatternHandleCallback; void *clientData; VisitAIColorFlags controlFlags; AIBoolean modifiedSomething; }; struct AILiveEffectScaleParamMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AIReal scaleFactor; AIBoolean scaledParams; }; struct AILiveEffectHandleMergeMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectHandle oldEffect; AIBoolean dontMerge; AIBoolean keepInstanceInfo; AILiveEffectParameters parameters; }; struct AILiveEffectGetSVGFilterMessage { SPMessageData d; AILiveEffectHandle effect; AILiveEffectParameters parameters; AISVGFilterHandle svgFilter; }; struct AILiveEffectIsCompatibleMessage { explicit AILiveEffectIsCompatibleMessage( AILiveEffectHandle thisEffect = 0, AIVersion version = kAIVersion1, ConstAILiveEffectParameters params = 0, AIBoolean compat = false) : effect(thisEffect), appVersion(version), parameters(params), compatible(compat) {} SPMessageData d; AILiveEffectHandle effect; AIVersion appVersion; ConstAILiveEffectParameters parameters; AIBoolean compatible; }; /******************************************************************************* ** ** Suite ** **/ struct AILiveEffectSuite { AIAPI AIErr (*AddLiveEffect) ( AILiveEffectData* effectInfo, AILiveEffectHandle *liveEffectHandle ); AIAPI AIErr (*AddLiveEffectFilterItem) ( AILiveEffectHandle liveEffectHandle, AIFilterHandle filterHandle, AIMenuItemHandle *menuItem, AIMenuGroup *menuGroup ); AIAPI AIErr (*AddLiveEffectMenuItem) ( AILiveEffectHandle liveEffectHandle, const char* menuName, AddLiveEffectMenuData *menuData, AIMenuItemHandle *menuItem, AIMenuGroup *menuGroup ); AIAPI AIErr (*ExecuteLiveEffect) ( AILiveEffectHandle effect, AILiveEffectParameters parameters, AIArtHandle art ); AIAPI AIErr (*EditParameters) ( AILiveEffectParamContext context, AIBoolean enablePreview ); AIAPI AIErr (*UpdateParameters) ( AILiveEffectParamContext context ); AIAPI AIErr (*InterpolateEffectParameters) ( AILiveEffectHandle effect, AILiveEffectParameters startParams, AILiveEffectParameters endParams, AIReal percent, AILiveEffectParameters resultParams ); AIAPI AIErr (*CountLiveEffects) ( ai::int32* count ); AIAPI AIErr (*GetNthLiveEffect) ( ai::int32 n, AILiveEffectHandle* effect ); AIAPI AIErr (*GetLiveEffectName) ( AILiveEffectHandle effect, const char** name ); AIAPI AIErr (*GetLiveEffectTitle) ( AILiveEffectHandle effect, const char** name ); AIAPI AIErr (*GetLiveEffectVersion) ( AILiveEffectHandle effect, ai::int32* major, ai::int32* minor ); AIAPI AIErr (*GetInputPreference) ( AILiveEffectHandle effect, ai::int32* inputPreference ); AIAPI AIErr (*GetStyleFilterFlags) ( AILiveEffectHandle effect, ai::int32* styleFilterFlags ); AIAPI AIErr (*MergeLiveEffectIntoSelection) ( AILiveEffectHandle effect, AILiveEffectMergeAction action ); AIAPI AIErr (*NewArtStyleByMergingLiveEffect) ( AIArtStyleHandle artStyle, AILiveEffectHandle effect, AILiveEffectParameters params, AILiveEffectMergeAction action, AIArtStyleHandle *newArtStyle ); AIAPI AIMenuItemHandle (*GetMenuItem) ( AILiveEffectParamContext context ); AIAPI AIErr (*CreateLiveEffectParameters) ( AILiveEffectParameters* params ); AIAPI AIErr (*GetLiveEffectAppVersion) ( AILiveEffectHandle effect, AIVersion* appVersionRGB, AIVersion* appVersionCMYK ); AIAPI AIErr (*SetLiveEffectAppVersion) ( AILiveEffectHandle effect, AIVersion appVersionRGB, AIVersion appVersionCMYK ); /* Searches for a given live effect and returns its Handle. If no live effect corresponding to the name exists then nullptr is returned. @param liveEffectName name of live effect to search for @param outLiveEffect[out] the live effect whose name is same as the input name. */ AIAPI AIErr (*GetLiveEffectHandleByName) (const char* liveEffectName, AILiveEffectHandle* outLiveEffect); }; #include "AIHeaderEnd.h" #endif

Copyright © 2014 Adobe Systems Incorporated. All rights reserved. Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks