AIDrawArt.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIColor.h"
#include "AIColorConversion.h"
#include "AIRaster.h"
#include "AIAGMTypes.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIDrawArtGWorld
	Information needed for drawing into a GWorld in Mac OS. More...
struct	AIDrawArtAGMPort
	Information needed for drawing into an AGM port. More...
struct	AIDrawArtAGMPortV6
	Information needed for drawing into an AGM version 6 port. More...
union	AIDrawArtOutputUnion
	The possible output targets for drawing art. More...
struct	AIDrawArtData
	Drawing data, defines an art object to be drawn, the object it is to be drawn into, and parameters affecting how it is to be drawn. More...
struct	AIDrawColorData
	Structure defining a color to draw the object, it is to be drawn into and parameters affecting how it is to be drawn. More...
struct	AIDrawArtSuite
	These functions draw Illustrator artwork to an output port (drawing surface). More...
Defines
#define	kAIDrawArtSuite "AI Draw Art Suite"
#define	kAIDrawArtSuiteVersion11 AIAPI_VERSION(11)
#define	kAIDrawArtSuiteVersion kAIDrawArtSuiteVersion11
#define	kAIDrawArtVersion kAIDrawArtSuiteVersion
#define	kUnknownDrawArtErr 'DHUH'
#define	KUnknownDrawArtOutputTypeErr 'DOUT'
#define	kBadDrawArtPreviewMatrixErr 'DMTX'
#define	kDrawArtInterruptedErr 'DITR'
Typedefs
typedef ai::uint32	AIDrawArtFlags
	See `AIDrawArtFlagsValue` for possible values.
typedef ai::int32	AIDrawArtOutputType
	See `AIDrawArtOutputTypeValue` for possible values.
typedef ai::int32	AIDrawColorStyle
	See AIDrawColorStyleValue for possible values.
typedef ai::int32	AIDrawColorOptions
	See AIDrawColorOptionsValue for possible values.
Enumerations
enum	AIDrawArtFlagBitPos { kAIDrawArtPreviewBit = 0, kAIDrawArtPreviewImagesBit = 1, kAIDrawArtPreviewDimmedImagesBit = 2, kAIDrawArtPreviewPatternsBit = 3, kAIDrawArtSelectObjectsBit = 4, kAIDrawArtShowGuidesBit = 5, kAIDrawArtIgnoreArtTransformBit = 6, kAIDrawArtPreviewCropBit = 7, kAIDrawArtPreviewInterrupt = 8, kAIDrawArtPreviewContinue = 9, kAIDrawArtIgnoreDashedLines = 10, kAIDrawArtDontColorCalibration = 11, kAIDrawArtIsolate = 12, kAIDrawArtIgnoreTopLevelTransparency = 13, kAIDrawArtSimulateColoredPaper = 14, kAIDrawArtIgnoreOverprint = 15, kAIDrawArtPlayEPS = 16, kAIDrawArtFastColorTransform = 17, kAIDrawArtDontCachePatterns = 18, kAIDrawArtIgnoreTopLevelInvisibility = 19, kAIDrawArtKnockoutAlreadyOn = 20, kAIDrawArtRunInBackground = 21, kAIDrawArtPreviewCannotContinue = 22, kAIDrawArtClipOnly = 23, kAIDrawArtOPP = 24, kAISuppressWhiteOP = 25 }
	Flag bits for `AIDrawArtFlags`. More...
enum	AIDrawArtFlagsValue { kAIDrawArtPreviewMask = (1 << kAIDrawArtPreviewBit), kAIDrawArtPreviewImagesMask = (1 << kAIDrawArtPreviewImagesBit), kAIDrawArtPreviewDimmedImagesMask = (1 << kAIDrawArtPreviewDimmedImagesBit), kAIDrawArtPreviewImageOrDimImageMask = (kAIDrawArtPreviewImagesMask \| kAIDrawArtPreviewDimmedImagesMask), kAIDrawArtPreviewPatternsMask = (1 << kAIDrawArtPreviewPatternsBit), kAIDrawArtSelectObjectsMask = (1 << kAIDrawArtSelectObjectsBit), kAIDrawArtShowGuidesMask = (1 << kAIDrawArtShowGuidesBit), kAIDrawArtIgnoreArtTransformMask = (1 << kAIDrawArtIgnoreArtTransformBit), kAIDrawArtPreviewCropMask = (1 << kAIDrawArtPreviewCropBit), kAIDrawArtPreviewInterruptMask = (1 << kAIDrawArtPreviewInterrupt), kAIDrawArtPreviewContinueMask = (1 << kAIDrawArtPreviewContinue), kAIDrawArtIgnoreDashedLinesMask = (1 << kAIDrawArtIgnoreDashedLines), kAIDrawArtDontColorCalibrationMask = (1 << kAIDrawArtDontColorCalibration), kAIDrawArtIsolateMask = (1 << kAIDrawArtIsolate), kAIDrawArtIgnoreTopLevelTransparencyMask = (1 << kAIDrawArtIgnoreTopLevelTransparency), kAIDrawArtSimulateColoredPaperMask = (1 << kAIDrawArtSimulateColoredPaper), kAIDrawArtIgnoreOverprintMask = (1 << kAIDrawArtIgnoreOverprint), kAIDrawArtPlayEPSMask = (1 << kAIDrawArtPlayEPS), kAIDrawArtFastColorTransformMask = (1 << kAIDrawArtFastColorTransform), kAIDrawArtDontCachePatternsMask = (1 << kAIDrawArtDontCachePatterns), kAIDrawArtIgnoreTopLevelInvisibilityMask = (1 << kAIDrawArtIgnoreTopLevelInvisibility), kAIDrawArtKnockoutAlreadyOnMask = (1 << kAIDrawArtKnockoutAlreadyOn), kAIDrawArtRunInBackgroundMask = (1 << kAIDrawArtRunInBackground), kAIDrawArtPreviewCannotContinueMask = (1 << kAIDrawArtPreviewCannotContinue), kAIDrawArtClipOnlyMask = (1 << kAIDrawArtClipOnly), kAIDrawArtOPPMask = (1 << kAIDrawArtOPP), kAISuppressWhiteOPMask = (1 << kAISuppressWhiteOP) }
	Flag masks for AIDrawArtFlags. More...
enum	AIDrawArtOutputTypeValue { kAIDrawArtUnknownOutput = 0, kAIDrawArtGWorldOutput = 1, kAIDrawArtAGMPortOutput = 2, kAIDrawArtAGMPortOutputV6 = 3, kAIDrawArtStructuredPortOutput = 4 }
	Values for `AIDrawArtOutputType`, specified in the `type` field of `AIDrawArtData` structure. More...
enum	AIDrawColorStyleValue { kAIDrawColorStyleFill = 0, kAIDrawColorStyleFrame = 1 }
	Values for AIDrawColorStyle. More...
enum	AIDrawColorOptionsValue { kAIDrawArtGradientForceLinear = (1 << 0), kAIDrawColorNoDocCsConversion = (1 << 1) }
	Values for AIDrawColorOptions. More...

Detailed Description

Define Documentation

#define kAIDrawArtSuite "AI Draw Art Suite"

#define kAIDrawArtSuiteVersion kAIDrawArtSuiteVersion11

#define kAIDrawArtSuiteVersion11 AIAPI_VERSION(11)

#define kAIDrawArtVersion kAIDrawArtSuiteVersion

Typedef Documentation

typedef ai::uint32 AIDrawArtFlags

See AIDrawArtFlagsValue for possible values.

typedef ai::int32 AIDrawArtOutputType

See AIDrawArtOutputTypeValue for possible values.

typedef ai::int32 AIDrawColorOptions

See AIDrawColorOptionsValue for possible values.

typedef ai::int32 AIDrawColorStyle

See AIDrawColorStyleValue for possible values.

Enumeration Type Documentation

enum AIDrawArtFlagBitPos

Flag bits for AIDrawArtFlags.

Enumerator:

kAIDrawArtPreviewBit	When set, draws in the preview mode, otherwise draws in the outline mode.
kAIDrawArtPreviewImagesBit	Obsolete.
kAIDrawArtPreviewDimmedImagesBit	When set, draws dimmed images if `kAIDrawArtPreviewBit` is set. Dimmed images have colors shifted towards white.
kAIDrawArtPreviewPatternsBit	Obsolete.
kAIDrawArtSelectObjectsBit	Obsolete.
kAIDrawArtShowGuidesBit	When set, draws guides.
kAIDrawArtIgnoreArtTransformBit	(Not recommended. ) When set, if drawing a single art object of type `kPlacedArt` or `kRasterArt`, the transformation applied to the object is set to identity before drawing. A better way to achieve the same effect is to use `AIDrawArtSuite::DrawThumbnail()`.
kAIDrawArtPreviewCropBit	Obsolete.
kAIDrawArtPreviewInterrupt	When set, a lengthy drawing operation can be interrupted in response to user activity. If previewing is interrupted, `AIDrawArtSuite::DrawArt()` returns `kDrawArtInterruptedErr` and the `interruptedArt` member of the `AIDrawArtData` is set to the object where drawing stopped.
kAIDrawArtPreviewContinue	When set, continues an interrupted drawing operation from the point at which it was stopped.
kAIDrawArtIgnoreDashedLines	(Not recommended. ) When set, ignores dashes on strokes when drawing.
kAIDrawArtDontColorCalibration	Obsolete.
kAIDrawArtIsolate	When set, the artwork is in an isolated transparency group that uses the document color space. A plug-in that draws into a dialog or palette must isolate the artwork to ensure that transparency blending is in the document color space.
kAIDrawArtIgnoreTopLevelTransparency	When set, ignores the transparency aspects (blend mode, opacity, and opacity mask) of the object being drawn. Does not ignore knockout and alpha in shape setting. If the object is an image, does not ignore the opacity of pixels.
kAIDrawArtSimulateColoredPaper	When set, modifies the color as if the image were printed on colored paper. The paper color is specified in the transparency panel of the document setup dialog. In that panel, there are two color swatches that normally define the colors for the transparency grid. The topmost swatch also defines the color that is used when simulating colored paper.
kAIDrawArtIgnoreOverprint	When set, any overprint specification on objects is ignored, so that colors do not overprint.
kAIDrawArtPlayEPS	When set, placed EPS files are drawn by parsing and rendering their PostScript contents instead of drawing their low resolution image proxies. The result is the same as turning off the preference "Use Low Resolution Proxy for Linked EPS".
kAIDrawArtFastColorTransform	When set, color conversion uses a faster but possibly less accurate algorithm. Use for interactive display but not for rasterization.
kAIDrawArtDontCachePatterns	When set, disposes off cached patterns and regenerates them when rendering. Converting patterns into a renderable form for display takes time, so Illustrator normally caches the converted results. However, the results of conversion can depend on current application or document settings, such as color settings and document profile.
kAIDrawArtIgnoreTopLevelInvisibility	When set, draws the specified object regardless of whether it is hidden.
kAIDrawArtKnockoutAlreadyOn	When set, the initial state (that is, the state of the topmost object) for inherited knockout states is assumed to be on, rather than the default state of off. To use this flag, you must start a knockout transparency group before calling `AIDrawArtSuite::DrawArt()`.
kAIDrawArtRunInBackground	Not used.
kAIDrawArtPreviewCannotContinue	When set, does not attempt to continue an interrupted render. Allows for more interruptability.
kAIDrawArtClipOnly	When set, draws the object only if it is a clipping object, in order to establish a clip in the target port. By default, a clipping object passed to AIDrawArtSuite::DrawArt() is not drawn.
kAIDrawArtOPP	When set, draws to OPP port, simulating the appearance of spot colors. As with kAIDrawArtIsolate, this isolates any blending modes from the backdrop. If the objects drawn should not be isolated from one another, and if multiple calls to `AIDrawArtSuite::DrawArt()` are required, use `AIDrawArtSuite::BeginDrawArt()`. The spot plates needed are determined from the artwork that is to be drawn.
kAISuppressWhiteOP	When set, ingnores overprint attribute applied to white objects. This works only for process colors and document model CMYK.

enum AIDrawArtFlagsValue

Flag masks for AIDrawArtFlags.

See AIDrawArtFlagBitPos.

Enumerator:

kAIDrawArtPreviewMask
kAIDrawArtPreviewImagesMask
kAIDrawArtPreviewDimmedImagesMask
kAIDrawArtPreviewImageOrDimImageMask
kAIDrawArtPreviewPatternsMask
kAIDrawArtSelectObjectsMask
kAIDrawArtShowGuidesMask
kAIDrawArtIgnoreArtTransformMask
kAIDrawArtPreviewCropMask
kAIDrawArtPreviewInterruptMask
kAIDrawArtPreviewContinueMask
kAIDrawArtIgnoreDashedLinesMask
kAIDrawArtDontColorCalibrationMask
kAIDrawArtIsolateMask
kAIDrawArtIgnoreTopLevelTransparencyMask
kAIDrawArtSimulateColoredPaperMask
kAIDrawArtIgnoreOverprintMask
kAIDrawArtPlayEPSMask
kAIDrawArtFastColorTransformMask
kAIDrawArtDontCachePatternsMask
kAIDrawArtIgnoreTopLevelInvisibilityMask
kAIDrawArtKnockoutAlreadyOnMask
kAIDrawArtRunInBackgroundMask
kAIDrawArtPreviewCannotContinueMask
kAIDrawArtClipOnlyMask
kAIDrawArtOPPMask
kAISuppressWhiteOPMask

enum AIDrawArtOutputTypeValue

Values for AIDrawArtOutputType, specified in the type field of AIDrawArtData structure.

Indicates the type of port that is specified as output, using an AIDrawArtOutputUnion structure.

Enumerator:

kAIDrawArtUnknownOutput
kAIDrawArtGWorldOutput	Draw destination is a Mac OS GWorld in the `gWorld` member. This type is no longer supported and returns error
kAIDrawArtAGMPortOutput	Draw destination is an `AGMPort*` in the `port` member.
kAIDrawArtAGMPortOutputV6	Draw destination is an `AGMPort*` in the `portV6` member.
kAIDrawArtStructuredPortOutput	Draw destination is an `AIStructuredPort*` in the `structPort` member.