AIPluginGroup.h Go to the documentation of this file. #ifndef __AIPluginGroup__ #define __AIPluginGroup__ /* * Name: AIPluginGroup.h * Purpose: Adobe Illustrator Plugin Group Suite. * * ADOBE SYSTEMS INCORPORATED * Copyright 1995-2007 Adobe Systems Incorporated. * 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. * */ /******************************************************************************* ** ** Imports ** **/ #ifndef __AITypes__ #include "AITypes.h" #endif #ifndef __AIPlugin__ #include "AIPlugin.h" #endif #ifndef __AIArt__ #include "AIArt.h" #endif #ifndef __AIPathStyle__ #include "AIPathStyle.h" #endif #ifndef __AIArtStyle__ #include "AIArtStyle.h" #endif #include "AIHeaderBegin.h" /******************************************************************************* ** ** Constants ** **/ #define kAIPluginGroupSuite "AI Plugin Group Suite" #define kAIPluginGroupSuiteVersion6 AIAPI_VERSION(6) #define kAIPluginGroupSuiteVersion kAIPluginGroupSuiteVersion6 #define kAIPluginGroupVersion kAIPluginGroupSuiteVersion // These are the AI 6 style plug-in class messages. // They are only needed temporarily until Joe T's prototype plug-ins are updated // <<THESE WILL BE REMOVED>> #define kSelectorAINotifyObject "AI Notify Plugin Object" #define kSelectorAIUpdateObject "AI Update Plugin Object" // These are the AI 7 style plug-in group messages (split into caller and request) // <<PLEASE REMOVE THIS COMMENT WITH THE AI6 DEFINES>> #define kCallerAIPluginGroup "AI Plugin Group" #define kSelectorAINotifyEdits "AI Notify Edits" #define kSelectorAIUpdateArt "AI Update" #define kSelectorAICanShowContents "AI Show Contents" #define kSelectorAIInterpolateData "AI Interpolate Data" #define kSelectorAIReplaceSymbol "AI Art Replace Symbol" #define kSelectorAIDisallowsArtTypeQuery "AI Plugin Group Disallow Art Type" #define kSelectorAIPerformCustomHitTest "AI Plugin Group Perform Custom Hit Test" #define kSelectorAICollectPaintStyles "AI Plugin Group Collect Paint Styles" #define kSelectorAIApplyPaintStyles "AI Plugin Group Apply Paint Styles" #define kSelectorAIAdjustColors "AI Plugin Group Adjust Colors" #define kSelectorAIShowContents "AI Plugin Group Show Contents" #define kSelectorAIPluginArtDocScaleChange "AI Plugin Group Adjust New Document Scale" enum AIPluginGroupOptions { kPluginGroupWantsOverlapUpdateOption = (1<<1), kPluginGroupWantsAutoTranslateOption = (1<<2), kPluginGroupWantsAutoUScaleOption = (1<<3), kPluginGroupWantsAutoTransformOption = (1<<4), kPluginGroupDoEditFillHitOption = (1<<5), kPluginGroupKeepWhenEmptyOption = (1<<6), kPluginGroupIsFillLike = (1<<7), kPluginGroupIsStrokeLike = (1<<8), kPluginGroupDoNotTarget = (1<<9), kPluginGroupAlwaysSmartTarget = (1<<10), kPluginGroupDoNotSmartTarget = (1<<11), kPluginGroupCanBeClipping = (1<<12), kPluginGroupAlwaysShowContents = (1<<13), kPluginGroupAskToShowContents = (1<<14), kPluginGroupDisableBlends = (1<<15), kPluginGroupBlendAsPluginGroup = (1<<16), kPluginGroupRestrictsArtTypes = (1<<17), kPluginGroupForceFillHitOnClosedPaths = (1<<18), kPluginGroupForceFillHitOnAllPaths = (1<<19), kPluginGroupManagesPaintStyles = (1<<20), kPluginGroupPermitsGroupCmds = (1<<21) }; // These are the errors returned by calls to AIPluginGroup suite functions (other than the AIArt standards). #define kUnknownPluginGroupErr 'GRP?' #define kAttachedPluginGroupErr 'GRP!' #define kTooMuchDataPluginGroupErr 'FULL' #define kPluginStoreLimit ( 32 * 1024 ) #define kRefusePluginGroupReply 'RFSE' #define kCheckPluginGroupReply 'CHEK' #define kWantsAfterMsgPluginGroupReply 'AFTR' #define kDidSymbolReplacement 'dsRP' #define kMarkValidPluginGroupReply 'VALD' #define kDontCarePluginGroupReply 'MOOT' #define kDestroyPluginGroupReply 'TRSH' #define kCustomHitPluginGroupReply 'CHIT' #define kSkipEditGroupReply 'skpE' typedef const char *AIOperationTime; // the times themselves #define kCheckOperationTime "AI Check Operation Time" #define kBeforeOperationTime "AI Before Operation Time" #define kAfterOperationTime "AI After Operation Time" #define kDuringOperationTime "AI During Operation Time" typedef const char *AIOperationCode; // the codes themselves #define kReadOperationCode "AI Read Operation Code" #define kWriteOperationCode "AI Write Operation Code" #define kAttachOperationCode "AI Attach Operation Code" #define kExpandOperationCode "AI Expand Operation Code" #define kOrderingOperationCode "AI Ordering Operation Code" #define kTransformOperationCode "AI Transform Operation Code" #define kGeometryOperationCode "AI Geometry Operation Code" #define kTopologyOperationCode "AI Topology Operation Code" #define kDeleteOperationCode "AI Delete Operation Code" #define kAttributeOperationCode "AI Attribute Operation Code" #define kStyleOperationCode "AI Style Operation Code" #define kChangeOperationCode "AI Change Operation Code" // enum AIChangeOperationSubcodes { kPluginSyncArtOpCode = 'PLUG' }; enum AIOrderingOperationSubcodes { kSendToBackOpCode = 'BACK', kSendToFrontOpCode = 'FRNT', kSendBackwardOpCode = 'DOWN', kSendForwardOpCode = 'UPWD', kReverseGroupOpCode = 'RVRS', kSendInternalOpCode = 'SINT', kReorderOutCode = 'MVOT', kReorderIntoOpCode = 'MVIN' }; enum AITransformOperationSubcodes { kTranslationOpCode = 'MOVE', kRotationOpCode = 'ROTA', kUniformScaleOpCode = 'USCA', kNonUniformScaleOpCode = 'NSCA', kShearOpCode = 'SHER', kReflectionOpCode = 'REFL', kMixedTransformOpCode = 'MTFM' }; enum AIGeometryOperationSubcodes { kMiscPathChangeOpCode = 'GEOM', kMovePointsOpCode = 'MPTS', kAdjustControlsOpCode = 'ADJC', kAddPointsOpCode = '+PTS', kRemovePointsOpCode = '-PTS', kReverseSegmentsOpCode = 'RVRS', kOpenCloseOpCode = 'OPCL', kSwapSymbolsOpCode = 'SWSM' }; enum AITopologyOperationSubcodes { kScissorOpCode = 'SCIZ', kPasteBelowOpCode = 'PBEL', kPasteIntoOpCode = 'PINT', kPasteAboveOpCode = 'PABV', kTransformCopyOpCode = 'TCOP', kTypePathChangeOpCode = 'TYCH', kReplaceOneOpCode = 'REP1', kReplaceByManyOpCode = 'REPM', kDuplicateInsideOpCode = 'DUPi', kDuplicateOutsideOpCode = 'DUPo', kMakeGroupOpCode = 'GRUP', kReleaseGroupOpCode = 'UNGP', kExpandInsideOpCode = 'ExpI' }; enum AIStyleOperationSubcodes { kPathStyleOpCode = 'PATH', kTextStyleOpCode = 'ATET', kArtStyleOpCode = 'ARTS' }; enum AIAttributeOperationSubcodes { kHideOpCode = 'HIDE', kShowOpCode = 'SHOW', kLockOpCode = 'LOCK', kUnlockOpCode = 'UNLK', kSetNameOpCode = 'NAME' }; /******************************************************************************* ** ** Types ** **/ typedef struct _t_AIClassOpaque *AIPluginGroupHandle; typedef void *AIInterruptData; typedef ASErr (*AIInterruptProc)( AIArtHandle art, AIInterruptData data ); union StyleUnion { AIPathStyle *path_s; AIArtStyleHandle art_s; }; union StyleMapUnion { AIPathStyleMap *path_s_map; }; struct AIPluginGroupMessage { SPMessageData d; AIPluginGroupHandle entry; AIArtHandle art; AIOperationTime time; AIOperationCode code; // Editing parameters AIArtHandle preEditArt; AIArtHandle postEditArt; AIErr subCode; AIRealMatrix matrix; StyleUnion style; StyleMapUnion styleMap; AIInterruptProc proc; AIInterruptData data; // ----New fields added in AI10----- int steps; AIReal t; // Editing parameter AIPatternHandle toSymbol; // ----New fields added in AI12---- ai::int32 transformFlags; AIReal transformLineScale; AIArtHandle destinationArt; AIPaintOrder insertionOrder; AIVersion aiVersion; AIReal relativeScaleFactor; }; struct AIReplaceSymbolMessageData { SPMessageData d; AIPluginGroupHandle entry; AIArtHandle art; AIPatternHandle targetSymbol; AIPatternHandle replacementSymbol; }; struct AIPluginArtTypeMessageData { SPMessageData d; AIPluginGroupHandle entry; short artType; }; // Function pointers used for callbacks when storing custom hit data typedef AIAPI void (*AICustomHitDataDeleteFunc)(void*); struct AIPluginGroupCustomHitTestData { SPMessageData d; AIPluginGroupHandle entry; AIArtHandle art; AIRealPoint location; struct { void* inData; void* outData; AICustomHitDataDeleteFunc deleteFunc; } CustomHitData; }; typedef AIAPI ASErr (*AIProcessArtStyleFunc)(const AIArtStyleHandle artStyle, AIArtHandle gradientContext, ai::int32 usage, void *callbackData ); typedef AIAPI ASErr (*AIProcessPathStyleFunc)(const AIPathStyle *pathStyle, const AIPathStyleMap *psMap, AIArtHandle gradientContext, ai::int32 usage, void *callbackData ); #define kIterationCanQuitReply 'DONE' struct AIPluginGroupCollectPaintStylesData { SPMessageData d; AIPluginGroupHandle entry; AIArtHandle pluginArt; AIBoolean selectedOnly; void* callbackData; AIProcessArtStyleFunc artStyleCallback; AIProcessPathStyleFunc pathStyleCallback; }; struct AIPluginGroupApplyPaintStylesData { SPMessageData d; AIPluginGroupHandle entry; AIArtHandle pluginArt; AIBoolean applyStyleTransform; AIPathStyle pathStyle; AIPathStyleMap pathStyleMap; AIRealMatrix matrix; ai::int32 transformFlags; AIReal transformLineScale; }; typedef AIErr (*AIAdjustArtStyleFunc) ( AIArtStyleHandle oldArtStyle, AIArtStyleHandle *newArtStyle, void *userData ); struct AIPluginGroupAdjustColorsData { SPMessageData d; AIPluginGroupHandle entry; AIArtHandle pluginArt; // IN AIBoolean selectedOnly; AIBoolean adjustFills; AIBoolean adjustStrokes; void* callbackData; AIAdjustColorFunc adjustColorCallback; AIBoolean modifiedSomething; AIAdjustPatternHandleFunc adjustPatternHandleCallback; AIAdjustArtStyleFunc adjustArtStyleCallback; }; /*** Descriptive information for a new plug-in group. See \c #AIPluginGroupSuite::AddAIPluginGroup().*/ struct AIAddPluginGroupData { ai::int32 major; ai::int32 minor; const char *desc; }; /******************************************************************************* ** ** Suite ** **/ struct AIPluginGroupSuite { AIAPI AIErr (*AddAIPluginGroup) ( SPPluginRef self, const char *name, AIAddPluginGroupData *data, ai::int32 options, AIPluginGroupHandle *entry ); AIAPI AIErr (*UseAIPluginGroup) ( AIArtHandle art, AIPluginGroupHandle entry ); AIAPI AIErr (*GetAIPluginGroupName) ( AIPluginGroupHandle entry, char **name ); AIAPI AIErr (*GetAIPluginGroupVersion) ( AIPluginGroupHandle entry, ai::int32 *major, ai::int32 *minor ); AIAPI AIErr (*GetAIPluginGroupDescription) ( AIPluginGroupHandle entry, char **desc ); AIAPI AIErr (*GetAIPluginGroupOptions) ( AIPluginGroupHandle entry, ai::int32 *options ); AIAPI AIErr (*GetAIPluginGroupPlugin) ( AIPluginGroupHandle entry, SPPluginRef *plugin ); AIAPI AIErr (*CountAIPluginGroups) ( ai::int32 *count ); AIAPI AIErr (*GetNthAIPluginGroup) ( ai::int32 index, AIPluginGroupHandle *entry ); AIAPI AIErr (*GetPluginArtName) ( AIArtHandle art, char **name ); AIAPI AIErr (*SetPluginArtName) ( AIArtHandle art, char *name ); AIAPI AIErr (*GetPluginArtVersion) ( AIArtHandle art, ai::int32 *major, ai::int32 *minor ); AIAPI AIErr (*SetPluginArtVersion) ( AIArtHandle art, ai::int32 major, ai::int32 minor ); AIAPI AIErr (*GetPluginArtPluginGroup) ( AIArtHandle art, AIPluginGroupHandle *entry ); AIAPI AIErr (*SetPluginArtPluginGroup) ( AIArtHandle art ); AIAPI AIErr (*GetPluginArtEditArt) ( AIArtHandle art, AIArtHandle *editArt ); AIAPI AIErr (*SetPluginArtEditArt) ( AIArtHandle art, AIArtHandle editArt ); AIAPI AIErr (*GetPluginArtResultArt) ( AIArtHandle art, AIArtHandle *resultArt ); AIAPI AIErr (*SetPluginArtResultArt) ( AIArtHandle art, AIArtHandle resultArt ); AIAPI AIErr (*GetPluginArtDataCount) ( AIArtHandle art, size_t *count ); AIAPI AIErr (*SetPluginArtDataCount) ( AIArtHandle art, size_t count ); AIAPI AIErr (*GetPluginArtDataRange) ( AIArtHandle art, void *data, size_t index, size_t count ); AIAPI AIErr (*SetPluginArtDataRange) ( AIArtHandle art, void *data, size_t index, size_t count ); AIAPI AIErr (*MarkPluginArtDirty) ( AIArtHandle art ); AIAPI AIErr (*MarkPluginArtClean) ( AIArtHandle art ); // New for AI10: clipping attribute for plug-in group objects AIAPI AIErr (*GetPluginArtClipping) ( AIArtHandle art, AIBoolean *clipping ); AIAPI AIErr (*SetPluginArtClipping) ( AIArtHandle art, AIBoolean clipping ); AIAPI AIErr (*GetAIPluginGroupDefaultName) ( AIPluginGroupHandle entry, char** name ); AIAPI AIErr (*SetAIPluginGroupDefaultName) ( AIPluginGroupHandle entry, const char* name ); AIAPI AIErr (*GetAIPluginGroupAppVersion) ( AIPluginGroupHandle entry, AIVersion* appVersion ); AIAPI AIErr (*SetAIPluginGroupAppVersion) ( AIPluginGroupHandle entry, AIVersion appVersion ); // New for AI12: AIAPI AIErr (*MarkPluginArtSilent) ( AIArtHandle art ); AIAPI AIErr (*PluginArtAdjustColors) ( AIArtHandle art, AIAdjustColorFunc adjustColorCallback, void *callbackData, ASBoolean *modifiedSomething, AIBoolean adjustFills, AIBoolean adjustStrokes, AIBoolean selectionOnly ); }; #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