AITool.h Go to the documentation of this file. #pragma once /* * Name: AITool.h * Author: * Date: * Purpose: Adobe Illustrator Tool Suite. * * ADOBE SYSTEMS INCORPORATED * Copyright 1986-2017 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 ** **/ #include "AITypes.h" #include "AIArt.h" #include "AIEvent.h" #include "AIFixedMath.h" #include "AIPlugin.h" #include "AIToolNames.h" #include "ASHelp.h" #include "AIColor.h" #ifndef FLT_MAX #include <float.h> #endif #include "AIHeaderBegin.h" /******************************************************************************* ** ** Constants ** **/ #define kAIToolSuite "AI Tool Suite" #define kAIToolSuiteVersion19 AIAPI_VERSION(19) #define kAIToolSuiteVersion kAIToolSuiteVersion19 #define kAIToolVersion kAIToolSuiteVersion #define kAIEffectiveToolChangedNotifier "AI Effective Tool Changed Notifier" #define kAIUserToolChangedNotifier "AI User Tool Changed Notifier" #define kAIToolSelectedNotifier "AI Tool Selected Notifier" #define kAIToolDeselectedNotifier "AI Tool Deselected Notifier" #define kAIInvalidateByScrollNotifier "AI Invalidate By Scroll Notifier" #define kAIToolClearStateNotifier "AI Tool Clear State Notifier" #define kAIToolTitleChangedNotifier "AI Tool Title Changed Notifier" #define kAIToolTooltipChangedNotifier "AI Tool Tooltip Changed Notifier" #define kAIToolHelpIDChangedNotifier "AI Tool Help ID Changed Notifier" #define kAIToolIconChangedNotifier "AI Tool Icon Resources Changed Notifier" #define kAIToolChangedNotifier "AI Tool Changed Notifier" #define kAIToolWindowChangedNotifier "AI Tool Window Changed Notifier" #define kAIToolSuspendNotifier "AI Tool Suspend Notifier" #define kAIToolResumeNotifier "AI Tool Resume Notifier" #define kAIToolTabletPointerTypeChangedNotifier "AI Tablet Pointer Type Changed Notifier" #define kAIToolModifiersChangedNotifier "AI Tool Modifiers Changed Notifier" #define kAIToolSuspendedBySpacebarNotifier "AI Tool Suspended by Spacebar Notifier" #define kAIToolResumedBySpacebarNotifier "AI Tool Resumed by Spacebar Notifier" #define kAIToolSuspendedByCmdKeyNotifier "AI Tool Suspended by Cmd Key Notifier" #define kAIToolResumedByCmdKeyNotifier "AI Tool Resumed by Cmd Key Notifier" // Notifiers sent by built-in tools #define kAIEyedropperDragNotifier "AI Eyedropper Drag Notifier" #define kCallerRadialDevice "AI Radial Device" #define kSelectorAIRadialDeviceRotated "Radial Device Rotated" #define kSelectorAIRadialDeviceClicked "Radial Device Clicked" #define kCallerAITool "AI Tool" #define kSelectorAIEditToolOptions "AI Edit Options" #define kSelectorAITrackToolCursor "AI Track Cursor" #define kSelectorAIToolMouseDown "AI Mouse Down" #define kSelectorAIToolMouseDrag "AI Mouse Drag" #define kSelectorAIToolMouseUp "AI Mouse Up" #define kSelectorAISelectTool "AI Select" #define kSelectorAIDeselectTool "AI Deselect" #define kSelectorAIReselectTool "AI Reselect" #define kSelectorAIToolDecreaseDiameter "AI Decrease Diameter" #define kSelectorAIToolIncreaseDiameter "AI Increase Diameter" #define kSelectorAIAlternateSelectionToolQuery "AI Alternate Selection Tool Query" #define kSelectorAIAlternateSelectionToolActivate "AI Alternate Selection Tool Activate" #define kSelectorAIAlternateSelectionToolDeActivate "AI Alternate Selection Tool DeActivate" #define kAcceptAlternateSelectionToolReply 'ASTR' #define kSelectorAIToolDrawDryInk "AI Tool Draw Dry Ink" // Brush tools share these options, so if you add new ones, // make sure they do not overlap with the brush tool options defined in // AIBrushMgr.h, which start at 1L<<16 and go up. enum AIToolOptions { kToolWantsToTrackCursorOption = (1<<0), kToolDoesntWantAutoScrollOption = (1<<1), kToolWantsBufferedDraggingOption = (1<<2), kToolMaintainEditContextOption = (1<<3), kToolIsTextToolOption = (1<<4), kToolWantsToChangeDiameterOption = (1<<5), kToolWantsAlternateSelectionTool = (1<<6), kToolWantsHiddenToolOption = (1<<7), kToolDoesntWantSoftSelectionOption = (1<<8), kToolWantsOSHandleInk = (1<<9), kToolHasAlternateAction = (1<<10), kToolWantsRadialDeviceEvents = (1 << 11), kToolDoesntWantArtStyleExecutionSuspender = (1 << 12), kToolHasItsOwnDragLoop = (1 << 13) }; enum AIToolInfoVariable { kInfoPageX = 0, kInfoPageY, kInfoSizeX, kInfoSizeY, kInfoDistance, kInfoVectorAngle, kInfoScaleX, kInfoScaleY, kInfoZoom, kInfoCornerRoundness, kInfoRotAngle, kInfoShearAngle, kInfoFontAndSize, kInfoTrackOrKern, kInfoRawRotAngle, kInfoDocX, kInfoDocY, kInfoText1, kInfoText2, kInfoText3, kInfoText4, kInfoText5, kInfoText6, kInfoLongText3, kInfoTextX, kInfoTextY, kInfoTextW, kInfoTextH, kInfoNumVars, kInfoBlank, // new in AI 12 kInfoTextUnicode1, kInfoTextUnicode2, kInfoTextUnicode3, kInfoTextUnicode4, kInfoTextUnicode5, kInfoTextUnicode6, kInfoLongTextUnicode1, kInfoLongTextUnicode2, kInfoLongTextUnicode3, // overlayed items. kInfoLongText1 = kInfoFontAndSize, kInfoLongText2 = kInfoTrackOrKern, kInfoEndOfList = -1 // Use this to terminate the infoVars list }; #define kNoTool -2 typedef ai::int16 AIToolType; #define kPluginToolOffset 1000 #define kToolCantTrackCursorErr 'TLTK' //ToolTime for GetToolNullEventInterval. This type is to be deprecated ASAP. // <<LET ME KNOW IF THIS DOESN'T HAPPEN>> typedef double AIToolTime; //Time in Seconds #define kToolTimeDurationSecond ((AIToolTime)1.0) #define kToolTimeDurationMillisecond ((AIToolTime)(kToolTimeDurationSecond/1000)) #define kToolTimeDurationNoWait ((AIToolTime)0.0) #define kToolTimeDurationForever ((AIToolTime)(-1.0)) #define kToolNormalIconDictKey "ToolNormalIconDictKey" #define kToolDarkNormalIconDictKey "ToolDarkNormalIconDictKey" /******************************************************************************* ** ** Types ** **/ typedef struct _t_AIToolOpaque *AIToolHandle; struct AIEffectiveToolChangeData { const char* currentToolName; const char* lastToolName; AIBoolean isToolChangeTemporary; AIToolHandle currentToolHandle; AIToolHandle lastToolHandle; AIToolType currentToolNum; AIToolType lastToolNum; }; struct AIAddToolData { ai::UnicodeString title; ai::UnicodeString tooltip; ai::uint32 normalIconResID = 0; ai::uint32 darkIconResID = 0; AIToolType sameGroupAs = 0; AIToolType sameToolsetAs = 0; /* Specifies the type of the incoming icons enum IconType in AITypes.h*/ ai::IconType iconType = ai::IconType::kPNG; }; typedef struct _AIDataStack *AIDataStackRef; struct AIAddToolDataPrivate { ai::UnicodeString title; ai::UnicodeString tooltip; AIDataStackRef iconResourceDictionary; AIToolType sameGroupAs = 0; AIToolType sameToolsetAs = 0; /* Specifies the type of the incoming icons enum IconType in AITypes.h*/ ai::IconType iconType = ai::IconType::kInvalid; }; typedef ai::int16 AIToolTabletPointerType; enum AIToolTabletPointerTypeValue { kAIToolTabletPointerTypeUnknown = 0, kAIToolTabletPointerTypePen, kAIToolTabletPointerTypeCursor, kAIToolTabletPointerTypeEraser }; typedef ai::int16 AIToolPressure; enum AIToolPressureValue { kAIMaxToolPressure = 255, kAIMinToolPressure = 0, kAINormalToolPressure = 127 }; typedef ai::int16 AIToolAngle; enum AIToolAngleValue { kAIToolAngle0 = 0, kAIToolAngle90 = 90, kAIToolAngleNegative179 = -179, kAIToolAngle180 = 180, kAIToolAngle360 = 360, kAIToolMinBearing = kAIToolAngleNegative179, kAIToolMaxBearing = kAIToolAngle180, kAIToolNormalBearing = kAIToolAngle0, kAIToolMinRotation = kAIToolAngleNegative179, kAIToolMaxRotation = kAIToolAngle180, kAIToolNormalRotation = kAIToolAngle0, kAIToolMinTilt = kAIToolAngle0, kAIToolMaxTilt = kAIToolAngle90, kAIToolNormalTilt = kAIToolMinTilt }; enum AITabletCapabilities { /* X-coordinate in the tablet coordinate space. */ kXCoordinate = 1 << 0, /* Y-coordinate in the tablet coordinate space. */ kYCoordinate = 1 << 1, /* Z-coordinate or the distance of the pen tip from the tablet. */ kZCoordinate = 1 << 2, /* Pressure of pen tip perpendicular to tablet surface. */ kNormalPressure = 1 << 3, /* Pressure of the pen tip along the plane of the tablet surface. */ kTangentPressure = 1 << 4, /* Angle between the axis of pen and the surface of the tablet. */ kAltitudeOrientation = 1 << 5, /* Clockwise rotation of the cursor around the z-axis through a full circular range. */ kAzimuthOrientation = 1 << 6, /* Clockwise rotation of the cursor around its own axis. */ kTwistOrientation = 1 << 7 }; enum AIToolMessageFlags { /*Indicates that it is a simulated Tool Message of InkStrokes*/ kAIToolMsgInkSimulationFlag = 1 << 0, kAIToolMsgModifierKeyPressedDuringInk = 1 << 1, /*Indicates that it is a tool drag over message*/ kAIToolMsgIsDragOver = 1 << 2 }; struct AIEventHistoryData { AIPoint position; AIToolPressure stylusWheel; AIToolAngle tilt; AIToolAngle bearing; AIToolAngle rotation; }; struct AIToolMessage { SPMessageData d; AIToolHandle tool; AIRealPoint cursor; AIToolPressure pressure; AIEvent *event; AIToolPressure stylusWheel; AIToolAngle tilt; AIToolAngle bearing; AIToolAngle rotation; ai::int32 flags; ai::AutoBuffer<AIEventHistoryData> eventHistoryData; }; struct AIRadialDeviceMessage { SPMessageData d; AIToolHandle tool = nullptr; AIReal rotation = 0.0; }; struct AIToolNotifyData { AIToolHandle tool; }; struct AIEyedropperDragNotifyData { AIEvent event; AIBoolean pathStyleChanged; }; struct AIDocumentInkParams { enum PenTipShape { kPenTipShapeCircle, kPenTipShapeRectangle }; PenTipShape fShape; AIColor fColor; AIPoint fSize; ai::AutoBuffer<ai::uint32> fModifiersList; AIReal fRotation; AIBoolean fSupportPressure; AIBoolean fCustomModifierHandling; // Specifying it as true turns off direct ink when a mod key is pressed. enum PressureBasedVariant { kPressuteBasedVariantNone = 1 << 0, kPressuteBasedVariantDia = 1 << 1, kPressuteBasedVariantRoundness = 1 << 2, kPressuteBasedVariantAngle = 1 << 3, }; ai::int32 fPressureBasedVariants; AIDocumentInkParams() :fShape(kPenTipShapeCircle) { fColor.kind = kThreeColor; fColor.c.rgb.red = 0.0f; fColor.c.rgb.green = 0.0f; fColor.c.rgb.blue = 0.0f; fSize.h = 1; fSize.v = 1; fRotation = 0.0f; fSupportPressure = false; fPressureBasedVariants = 0; fCustomModifierHandling = false; } }; struct AIDocumentInkPoint { AIRealPoint fLocation; AIToolPressure fPressure; AIToolPressure fStylusWheel; AIToolAngle fRotation; AIToolPressure fBearing; AIToolPressure fTilt; AIDocumentInkPoint() { fLocation.h = 0.0; fLocation.v = 0; fPressure = 0; fStylusWheel = kAIToolMinRotation; fBearing = kAIToolMinBearing; fRotation = kAIToolMinRotation; fTilt = kAIToolMinTilt; } }; struct AIToolDryInkMessage { SPMessageData d; ai::int32 flags = 0; AIToolHandle tool; AIEvent *event; ai::AutoBuffer<AIDocumentInkPoint> inkStrokes; AIToolDryInkMessage() :tool(0), event(nullptr) {} }; /******************************************************************************* ** ** Suite ** **/ struct AIToolSuite { AIAPI AIErr (*AddTool) ( SPPluginRef self, const char *name, const AIAddToolData &data, ai::int32 options, AIToolHandle *tool ); AIAPI AIErr (*AddToolPrivate) ( SPPluginRef self, const char *name, const AIAddToolDataPrivate &data, ai::int32 options, AIToolHandle *tool ); AIAPI AIErr (*GetToolName) ( AIToolHandle tool, char **name ); AIAPI AIErr (*GetToolOptions) ( AIToolHandle tool, ai::int32 *options ); AIAPI AIErr (*SetToolOptions) ( AIToolHandle tool, ai::int32 options ); AIAPI AIErr (*GetToolPlugin) ( AIToolHandle tool, SPPluginRef *plugin ); AIAPI AIErr (*GetSelectedTool) ( AIToolHandle *tool ); AIAPI AIErr (*SetSelectedTool) ( AIToolHandle tool ); AIAPI AIErr (*CountTools) ( ai::int32 *count ); AIAPI AIErr (*GetNthTool) ( ai::int32 n, AIToolHandle *tool ); AIAPI AIErr (*GetToolHandleFromNumber) ( AIToolType toolNum, AIToolHandle *tool ); AIAPI AIErr (*GetToolNumberFromName) ( const char *name, AIToolType *toolNum ); AIAPI AIErr (*GetToolNumberFromHandle) ( AIToolHandle tool, AIToolType *toolNum ); AIAPI AIErr (*GetToolNameFromNumber) ( AIToolType toolNum, char **name ); AIAPI AIErr (*GetToolTitle) ( AIToolHandle tool, ai::UnicodeString& title ); AIAPI AIErr (*SetToolTitle) ( AIToolHandle tool, ai::UnicodeString title ); AIAPI AIErr (*GetTooltip) ( AIToolHandle tool, ai::UnicodeString& tooltip ); AIAPI AIErr (*SetTooltip) ( AIToolHandle tool, ai::UnicodeString tooltip ); AIAPI AIErr (*SetToolInfoVars) ( AIToolHandle tool, const ai::int32 infoVars[] ); AIAPI AIErr (*SetToolInfoVarValues) ( const ai::int32 *infoVars, void **values ); AIAPI AIErr (*SystemHasPressure) ( AIBoolean *hasPressure ); AIAPI AIErr (*GetToolNullEventInterval) (AIToolHandle tool, AIToolTime *outTime); AIAPI AIErr (*SetToolNullEventInterval) (AIToolHandle tool, AIToolTime inTime); AIAPI AIErr (*SetSoftSelectedTool) ( AIToolHandle tool ); AIAPI AIErr (*IsSoftModeSelection) ( AIBoolean *isSoftMode ); AIAPI AIErr (*GetAlternateSelectionToolName) (AIToolHandle tool, char **name); AIAPI AIErr (*SetAlternateSelectionToolName) (AIToolHandle tool, const char* alternateTool); AIAPI AIErr (*GetCurrentToolName) ( const char **name ); AIAPI AIErr (*GetCurrentToolNumber) ( AIToolType *toolNum ); AIAPI AIErr (*GetCurrentEffectiveTool) ( AIToolHandle *tool ); AIAPI AIErr (*GetCurrentEffectiveToolName) ( const char **name ); AIAPI AIErr (*GetCurrentEffectiveToolNumber) ( AIToolType *toolNum ); AIAPI AIToolType (*GetLastUsedSelectionTool) ( const char **name ); AIAPI AIErr (*SetSelectedToolByName) ( const char *name ); AIAPI AIErr (*SetSelectedToolByNumber) ( AIToolType toolNum ); AIAPI AIErr (*GetTabletHardwareCapabilities) ( ai::int32* hardwareCapabilities ); AIAPI AIErr (*SetToolIcons) (AIToolHandle tool, const char *normalIconResourceName, const char *darkNormalIconResourceName); AIAPI AIErr(*GetToolIcons) (const AIToolHandle tool, char **normalIconResourceName, char **darkNormalIconResourceName); AIAPI AIErr(*SetDocumentInkParams)(const AIToolHandle tool, const AIDocumentInkParams& inDocInkParams); AIAPI AIErr (*GetToolOptionsFromNumber) (AIToolType toolNum, ai::int32 *options); AIAPI AIErr (*GetToolOptionsFromName) (const char *toolName, ai::int32 *options); }; #include "AIHeaderEnd.h"

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