API: AIPaintStyle.h Source File

00001 #ifndef __AIPaintStyle__
00002 #define __AIPaintStyle__
00003 
00004 /*
00005  *        Name: AIPaintStyle.h
00006  *      Author: Vivek Agrawal
00007  *        Date: 2/22/2016
00008  *     Purpose: AI Paint Style Suite.
00009  *
00010  * ADOBE SYSTEMS INCORPORATED
00011  * Copyright 2015-2016 Adobe Systems Incorporated.
00012  * All rights reserved.
00013  *
00014  * NOTICE:  Adobe permits you to use, modify, and distribute this file 
00015  * in accordance with the terms of the Adobe license agreement 
00016  * accompanying it. If you have received this file from a source other 
00017  * than Adobe, then your use, modification, or distribution of it 
00018  * requires the prior written permission of Adobe.
00019  *
00020  */
00021 
00022 /*******************************************************************************
00023 **
00024 **      Imports
00025 **
00026 **/
00027 
00028 #ifndef __ASTypes__
00029 #include "ASTypes.h"
00030 #endif
00031 
00032 #ifndef __AIColor__
00033 #include "AIColor.h"
00034 #endif
00035 
00036 #ifndef __AIPathStyle__
00037 #include "AIPathStyle.h"
00038 #endif
00039 
00040 #ifndef __AISwatchList__
00041 #include "AISwatchList.h"
00042 #endif
00043 
00044 #include "AIHeaderBegin.h"
00045 
00046 
00047 
00048 /*******************************************************************************
00049  **
00050  **     Constants
00051  **
00052  **/
00053 
00054 #define kAIPaintStyleSuite                      "AI Paint Style Suite"
00055 #define kAIPaintStyleSuiteVersion10     AIAPI_VERSION(10)
00056 
00057 /* Latest version */
00058 #define kAIPaintStyleSuiteVersion       kAIPaintStyleSuiteVersion10
00059 #define kAIPaintStyleVersion            kAIPaintStyleSuiteVersion
00060 
00064 #define kAIPaintStyleModifierCaller           "AI PaintStyle Modifier Caller"
00065 
00070 #define kAIUpdatePathStyleNotifier                                      "AI Update PathStyle Notifier"
00071 
00073 #define kAIPaintStyleFillStrokeChangedNotifier          "AI Paint Style Fill Stroke Changed Notifier"
00074 
00076 #define kAIPaintStyleGradientStopChangedNotifier        "AI Paint Style Gradient Stop Changed Notifier"
00077 
00083 #define kAIPaintStyleSetStrokeWidthSelector                     "AI Paint Style Set Stroke Width Selector"
00084 
00086 typedef struct {
00088         SPMessageData d;
00090         float newStrokeWidth;
00091 } AIStrokeWidthMessage;
00092 
00094 #define kAIPaintStyleIndicatorType                                      "AI Paint Style Indicator Type"
00095 
00096 #define kAIPaintStyleIndicatorSmallType                         "AI Paint Style Indicator Small Type"
00097 
00099 #define kAIPaintStyleColorEditorType                            "AI Paint Style Color Editor Type"
00100 
00102 #define kMinStrokeDashLength            0.01
00103 
00104 
00105 /*******************************************************************************
00106  **
00107  **     Types
00108  **
00109  **/
00110 
00112 typedef struct
00113 {
00115         AIPathStyle     pathStyle;
00119         AIPathStyleMap pathStyleMap;
00120 } AIUpdatePathStyleNotifyData;
00121 
00122 
00124 typedef enum
00125 {
00126         kUnknownSpace = 0,
00127         kGrayscaleSpace,
00128         kRGBSpace,
00129         kHSVSpace,
00130         kCMYKSpace,
00131         kWebSpace,
00132         kTintSpace,
00133         kLabSpace
00134 } ColorSpace;
00135 
00136 
00138 typedef struct
00139 {
00143         AIBoolean showSampleInDocCs;
00144 
00147         AIBoolean allowLabColorModel;
00148  
00152         AIBoolean showColorIndicator;
00155         AIBoolean warningIndicatorsOnRight;
00156 
00167         AIBoolean verifyColors;
00168 } AIColorEditorOptions;
00169 
00172 typedef struct
00173 {
00182         AISwatchListRef         swatchList;
00183 
00184 } AIColorPickerOptions;
00185 
00187 typedef enum
00188 {
00189         kAIColorEditorColorUnknown = 0,
00190         kAIColorEditorColorGray,
00191         kAIColorEditorColorRGB,
00192         kAIColorEditorColorCMYK,
00193         kAIColorEditorColorLab,
00195         kAIColorEditorColorDummy = 0xFFFFFFFF
00196 } AIColorEditorColorSpace;
00197 
00198 
00199 
00201 typedef struct
00202 {
00204         AIColorEditorColorSpace space;
00207         AIReal values[4];
00210         AIBoolean defined[4];
00211 } AIColorEditorColor;
00212 
00214 typedef enum
00215 {
00216         kAIColorEditorReadOnlyDefault = 0
00217 } AIColorEditorReadOnlyOption;
00218 
00219 // New for AI13:
00220 
00225 typedef void* ColorEditorClientData;
00226 
00236 typedef void (*ColorEditorTrackProc)(ColorEditorClientData clientData);
00237 
00239 typedef enum { 
00240         kAIStrokeAlignmentCenter = 0, 
00241         kAIStrokeAlignmentInside = 1, 
00242         kAIStrokeAlignmentOutside = 2 
00243 } AIStrokeAlignmentType;
00244 
00245 /*******************************************************************************
00246  **
00247  **     Suite
00248  **
00249  **/
00250 
00259 typedef struct
00260 {
00264         void ASAPI (*SetStrokeActive)();
00265 
00270         ASBoolean ASAPI (*IsStrokeActive)();
00271 
00275         void ASAPI (*SetFillActive)();
00276 
00281         ASBoolean ASAPI (*IsFillActive)();
00282 
00288         void ASAPI (*SetDefaultFillStroke)();
00289 
00295         int ASAPI (*GetActiveGradientStopIndex)();
00296 
00300         ASErr ASAPI (*GetCurrentGradient)(AIColor *color);
00301 
00306         ASErr ASAPI (*GetCurrentColor)(AIColor *color);
00307 
00309         ASErr ASAPI (*ShowGradientDialog)();
00310 
00312         ASErr ASAPI (*ShowColorDialog)();
00313 
00326         ASErr ASAPI (*SetActiveColor)(AIColor *color, ASBoolean useGradientStop);
00327 
00330         ASErr ASAPI (*BeginActiveColor)();
00331 
00334         ASErr ASAPI (*EndActiveColor)();
00335 
00340         ASBoolean ASAPI (*IsCurrentColorStroke)();
00341 
00353         ASErr ASAPI (*SetAIColor)(AIColor *color, AIColorMap *colorMap, ASBoolean isStroke);
00354 
00358         ASErr ASAPI (*SetCurrentGradient)(AIColor *color);
00359 
00363         ASErr ASAPI (*SetCurrentColor)(AIColor *color);
00364 
00367         ASErr ASAPI (*ToggleColorDialog)();
00368 
00372         void ASAPI (*SwapFillStroke)();
00373 
00379         ASBoolean ASAPI (*DisplayColorPicker)(AIColor *currentColor);
00380 
00390         ASBoolean ASAPI (*DisplayColorPickerWithOptions)(AIColor *currentColor, const AIColorPickerOptions &options );
00391 
00397         AIErr ASAPI (*SetStrokeAlignment)(AIArtHandle art, ai::uint32 strokeAlignment);
00398 
00403         AIErr ASAPI(*SetStrokeAlignmentOnSelection)(ai::uint32 strokeAlignment);
00404 
00410         ai::uint32 ASAPI(*GetStrokeAlignmentFromSelection)();
00411 
00412 } AIPaintStyleSuite;
00413 
00414 
00415 
00416 #include "AIHeaderEnd.h"
00417 
00418 #endif