AIBeautifulStrokes.h Go to the documentation of this file. #ifndef __AIBeautifulStrokes__ #define __AIBeautifulStrokes__ /* * Date: Started 2009 * Purpose: Adobe Illustrator Beautiful Strokes suite. This suite lets * clients control effects that can be applied to strokes such as * art and pattern brushes, arrowheads, and dash adjustments. * * ADOBE SYSTEMS INCORPORATED * Copyright 2009 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. * */ #include "AITypes.h" #include "AIEntry.h" #include "AILiveEffect.h" #include "AITabletData.h" #include "AIPath.h" #include "AIHeaderBegin.h" /******************************************************************************* ** ** Types ** **/ enum RepeatedArtAdjustment { kStretch, kAddSpace, kAdjustPath, kUnknownRepeatedArtAdjustment = 0xFFFFFFFF, RepeatedArtAdjustment_dummy = 0xFFFFFFFF }; enum RepeatedArtCorner { kNoCorner, kAutoCentered, kAutoBetween, kAutoSliced, kAutoOverlap }; enum StrokeWidthSource { kConstantWidth, kTabletData, kUserProfile, kCenteredProfileMark = 0x0000FF01, kUncenteredProfileMark, kCenteredProfileInterpolation, kUncenteredProfileInterpolation, kUnknownStrokeWidthSource = 0xFFFFFFFF, StrokeWidthSource_dummy = 0xFFFFFFFF }; enum GradientStrokeApplication { kGradientStrokeMask, kGradientStrokeAlong, kGradientStrokeAcross, kGradientStroke_dummy = 0xFFFFFFFF }; enum ArrowTipAlignment { kArrowTipAtEnd, kArrowAttachmentPtAtEnd, kArrowTruncationPtAtEnd, kUnknownArrowAlignment = 0xFFFFFFFF }; typedef ai::uint32 WidthMarkerFlags; // so that the compiler will allow doing bitwise operations // Bit flags that modify and/or report information about width markers, other than their // location (t value) and width. enum WidthMarkerFlagValues { kNoWidthMarkerFlags = 0, // -------- Flags for describing marker types --------- // kIncomingWidthMarker = 0x1, // 0x2 is reserved in case we decide to distinguish between left stroke side and right stroke side incoming widths kOutgoingWidthMarker = 0x4, // 0x8 is reserved in case we decide to distinguish between left stroke side and right stroke side outgoing widths kCornerWidthMarker = 0x10, kCornerLeftWidthMarker = 0x10, kCornerRightWidthMarker = 0x20, kAnchoredWidthMarker = 0x40, // (values from 0x80 to 0x8000 are reserved for future enhancements to saved options) // -------- Flags for describing options to functions that modify profiles --------- // kSpreadWidthChanges = 0x10000, kCopyMarker = 0x20000, kLimitAtNeighbors = 0x40000, kUniformChangeAcrossSpread = 0x80000, kProportionalChangeAcrossSpread = 0x100000 }; typedef ai::uint32 WidthMarkerFlags; typedef AIAPI AIBoolean (*AIGenerateArtProgressProc)(ai::int32 current, ai::int32 total); struct StrokeHitResults { AIBoolean hitSomething; AIBoolean hitWidthMarker; AIBoolean hitCenterline; AIBoolean hitStrokeEdge; AIRealPoint pointOnPath; AIRealPoint snappedPoint; AIReal hitDistance; ai::int16 widthMarkerIndex; AIReal lengthFraction; ai::int16 segIndex; AIReal bezierT; }; enum PathEditType { kClearProfileAnchorsOnly = 0, kClearAnchorsAndResetProfile, kCopyAndResetAnchors, kTranslate1Anchor, kRemove1Anchor, kAdd1Anchor, kAdjustBezier, kTransformSelection, kReversePathDirection, kSplitPath, kApplyStyle }; struct PathEditDescription { PathEditType editType; ai::int16 segIndex; AIArtStyleHandle newStyle; AIPathSegment newAnchor; AIArtHandle sourcePath; }; /******************************************************************************* ** ** Constants ** **/ #define kAIBeautifulStrokesSuite "AI Beautiful Strokes Suite" #define kAIBeautifulStrokesSuiteVersion3 AIAPI_VERSION(3) #define kAIBeautifulStrokesSuiteVersion kAIBeautifulStrokesSuiteVersion3 #define kAIBeautifulStrokesVersion kAIBeautifulStrokesSuiteVersion #define kAIBeautifulStrokesParamsDictKey "kAIBeautifulStrokesParamsDictKey" /******************************************************************************* ** ** Suite ** **/ struct AIBeautifulStrokesSuite { // General parameter management and stroke generation AIAPI AIErr (*GenerateArt)(ConstAILiveEffectParameters effectParams, AIArtHandle inArt, AIArtHandle sourceArt, AIBoolean outputOnTop, AIArtHandle outGroup, AIArtHandle *outArt, AIGenerateArtProgressProc progressProc); AIAPI AIErr (*CreateParamsDict)(AILiveEffectParameters effectParams, AIDictionaryRef &params); AIAPI AIErr (*GetParamsDict)(ConstAILiveEffectParameters effectParams, AIDictionaryRef &params); AIAPI AIBoolean (*Equiv)(ConstAIDictionaryRef params1, ConstAIDictionaryRef params2); AIAPI AIErr (*AccumulateParams)(ConstAILiveEffectParameters effectParams, AIDictionaryRef accumulator); AIAPI AIErr (*ApplyParams)(ConstAIDictionaryRef params, AIDictionaryRef target); AIAPI AIBoolean (*ContainsParams)(ConstAIDictionaryRef paramsDict); AIAPI AIErr (*GetArtStrokeParams)(AIArtHandle art, AIDictionaryRef &paramDict, AIStrokeStyle *strokeStyle, AIBoolean *hasBrush, AIReal *scaleFactor, AIBoolean *canAccept); AIAPI AIErr (*InterpolateParams)(ConstAILiveEffectParameters effectParams1, ConstAILiveEffectParameters effectParams2, AILiveEffectParameters effectParamsOut, AIReal dist); // General brush settings AIAPI AIErr (*SetFlipAcross)(AIDictionaryRef params, AIBoolean flipAcross); AIAPI AIBoolean (*GetFlipAcross)(ConstAIDictionaryRef params); AIAPI AIErr (*SetFlipAlong)(AIDictionaryRef params, AIBoolean flipAlong); AIAPI AIBoolean (*GetFlipAlong)(ConstAIDictionaryRef params); AIAPI AIErr (*SetScale)(AIDictionaryRef params, AIReal scale, const AIReal *mnScale, const AIReal *mxScale); AIAPI AIErr (*GetScale)(ConstAIDictionaryRef params, AIReal &scale, AIReal *mnScale, AIReal *mxScale); AIAPI AIErr (*SetFoldAdjustment)(AIDictionaryRef params, AIBoolean adjust); AIAPI AIBoolean (*GetFoldAdjustment)(ConstAIDictionaryRef params, AIBoolean *mixed); // Art Brushes AIAPI AIErr (*SetArtPaint)(AIDictionaryRef params, AIPatternHandle art); AIAPI AIPatternHandle (*GetArtPaint)(ConstAIDictionaryRef params); AIAPI AIErr (*SetStretch)(AIDictionaryRef params, AIBoolean stretch); AIAPI AIBoolean (*GetStretch)(ConstAIDictionaryRef params); AIAPI AIErr (*SetStartEndSegmentLength)(AIDictionaryRef params, AIReal startSegmentLength, AIReal endSegmentLength); AIAPI AIErr (*GetStartEndSegmentLength)(ConstAIDictionaryRef params, AIReal &startSegmentLength, AIReal &endSegmentLength); // Pattern Brushes AIAPI AIErr (*SetArtPatternPaint)(AIDictionaryRef params, AIPatternHandle beginArt, AIPatternHandle endArt, AIPatternHandle sideArt, AIPatternHandle insideCornerArt, AIPatternHandle outsideCornerArt, RepeatedArtAdjustment adjustment, AIReal spacing, RepeatedArtCorner insideAutoCornerOption, RepeatedArtCorner outsideAutoCornerOption); AIAPI AIErr (*GetArtPatternPaint)(ConstAIDictionaryRef params, AIPatternHandle &beginArt, AIPatternHandle &endArt, AIPatternHandle &sideArt, AIPatternHandle &insideCornerArt, AIPatternHandle &outsideCornerArt, RepeatedArtAdjustment &adjustment, AIReal &spacing, RepeatedArtCorner &insideAutoCornerOption, RepeatedArtCorner &outsideAutoCornerOption); // Dashing AIAPI AIErr (*SetDashAdjustment)(AIDictionaryRef params, AIBoolean adjust); AIAPI AIBoolean (*GetDashAdjustment)(ConstAIDictionaryRef params, AIBoolean *mixed); // Gradient Stroke AIAPI AIErr (*SetGradientStrokeApplication)(AIDictionaryRef params, GradientStrokeApplication application); AIAPI AIErr (*GetGradientStrokeApplication)(ConstAIDictionaryRef params, GradientStrokeApplication &application, AIBoolean *mixed); // Arrowheads AIAPI AIErr (*SetArrowheadOptions)(AIDictionaryRef params, AIPatternHandle *beginSymbol, AIPatternHandle *endSymbol, AIReal beginScale, AIReal endScale, ArrowTipAlignment alignment); AIAPI AIErr (*GetArrowheadOptions)(ConstAIDictionaryRef params, AIPatternHandle *beginSymbol, AIPatternHandle *endSymbol, AIReal *beginScale, AIReal *endScale, ArrowTipAlignment *alignment, AIBoolean *mixedBeginArrows, AIBoolean *mixedEndArrows); // Variable Widths AIAPI AIErr (*SetWidthSource)(AIDictionaryRef params, StrokeWidthSource source); AIAPI StrokeWidthSource (*GetWidthSource)(ConstAIDictionaryRef params); AIAPI AIErr (*SetWidthTabletDataSource)(AIDictionaryRef params, AITabletDataType dataType); AIAPI AIErr (*GetWidthTabletDataSource)(ConstAIDictionaryRef params, AITabletDataType &dataType); AIAPI AIErr (*SetCenteredWidthProfile)(AIDictionaryRef params, AIArrayRef tVals, AIArrayRef widths); AIAPI AIErr (*GetCenteredWidthProfile)(ConstAIDictionaryRef params, AIArrayRef &distances, AIArrayRef &widths); AIAPI AIErr (*SetUncenteredWidthProfile)(AIDictionaryRef params, AIArrayRef tVals, AIArrayRef leftWidths, AIArrayRef rightWidths); AIAPI AIErr (*GetUncenteredWidthProfile)(ConstAIDictionaryRef params, AIArrayRef &tVals, AIArrayRef &leftWidths, AIArrayRef &rightWidths); AIAPI AIErr (*SetWidthProfileDetails)(AIDictionaryRef params, AIArrayRef markerOptions, AIArrayRef incomingLeftSmoothness, AIArrayRef outgoingLeftSmoothness, AIArrayRef incomingRightSmoothness, AIArrayRef outgoingRightSmoothness); AIAPI AIErr (*GetWidthProfileDetails)(ConstAIDictionaryRef params, AIArrayRef &markerOptions, AIArrayRef &incomingLeftSmoothness, AIArrayRef &outgoingLeftSmoothness, AIArrayRef &incomingRightSmoothness, AIArrayRef &outgoingRightSmoothness); AIAPI AIErr (*GetPathAdjustedWidthDistances)(AIArtHandle path, AIArrayRef &adjustedDistances); AIAPI AIErr (*GetWidthsAtDistance)(AIArtHandle path, AIReal &lengthFraction, AIReal tolerance, AIReal *totalWidth, AIReal *leftWidth, AIReal *rightWidth, StrokeWidthSource *widthSource, ai::int16 *markerIndex, WidthMarkerFlags *markerDetails); AIAPI AIErr (*SetCenteredWidthAtDistance)(AIArtHandle path, AIReal lengthFraction, AIReal width, WidthMarkerFlags options); AIAPI AIErr (*SetUncenteredWidthsAtDistance)(AIArtHandle path, AIReal lengthFraction, AIReal leftWidth, AIReal rightWidth, WidthMarkerFlags options); AIAPI AIErr (*SlideWidthMarkerToNewT)(AIArtHandle path, ai::int16 markerIndex, AIReal &newTValue, WidthMarkerFlags options); AIAPI AIErr (*DeleteWidthPoint)(AIArtHandle path, ai::int16 markerIndex); AIAPI AIErr (*AdjustWidthAnchorsBeforePathEdit)(AIArtHandle path, const PathEditDescription &editDescription); AIAPI AIErr (*StrokeHitTest)(AIArtHandle path, const AIRealPoint &cursor, AIReal tolerance, StrokeHitResults *hitResults); }; #include "AIHeaderEnd.h" #endif

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