AIPathfinder.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIFilter.h"
#include "AIMenu.h"
#include "AIPlugin.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIOptions
	Options that control how pathfinder operations are performed. More...
struct	AIMixParameters
	Mixing parameters for AIParameters. More...
struct	AITrapParameters
	Trapping parameters for AIParameters. More...
struct	AIParameters
	Mixing and trapping parameters for AIPathfinderData::parameters. More...
struct	AIPathfinderData
	Defines how to perform a pathfinder operation. More...
struct	AIPathfinderMessage
	The contents of a Pathfinder message. More...
struct	PathfinderLiveEffectParamsStruct
	For internal use. More...
struct	AIPathfinderSuite
	This suite provides functions that perform operations on paths (art objects of type kPathArt), which apply various effects to selected path art. More...
Defines
#define	kAIPathfinderSuite   "AI Pathfinder Suite"
	Pathfinder suite name.
#define	kAIPathfinderSuiteVersion6   AIAPI_VERSION(6)
	Pathfinder suite version.
#define	kAIPathfinderSuiteVersion   kAIPathfinderSuiteVersion6
	Pathfinder suite name.
#define	kAIPathfinderVersion   kAIPathfinderSuiteVersion
	Pathfinder suite version.
#define	kDefaultPrecision   10.0
	The default value for AIOptions::ipmPrecision.
#define	kRemoveRedundantPointsDefault   0
	The default value for AIOptions::removeRedundantPoints.
#define	kExtractUnpaintedArtworkDefault   0
	The default value for AIOptions::flags kExtractUnpaintedArtwork flag.
#define	kAllowEmptyOutputDefault   0
	The default value for the AIOptions::flags kAllowEmptyOutput flag.
#define	kIgnoreEvenOddFillRuleDefault   0
	The default value for the AIOptions::flags kIgnoreEvenOddFillRule flag.
#define	kSoftRateDefault   0.5
	The default value for AIMixParameters::softRate.
#define	kMixConvertCustomColorsDefault   1
	The default value for AIMixParameters::convertCustomColors.
#define	kTrapThicknessDefault   0.25
	The default value for AITrapParameters::trapThickness.
#define	kHeightWidthAspectRatioDefault   1.0
	The default value for AITrapParameters::heightWidthAspectRatio.
#define	kTrapTintDefault   0.4
	The default value for AITrapParameters::trapTint.
#define	kMaximumTintDefault   1.0
	The default value for AITrapParameters::maximumTint.
#define	kTintToleranceDefault   0.05
	The default value for AITrapParameters::tintTolerance.
#define	kReverseTrapDefault   0
	The default value for AITrapParameters::reverseTrap.
#define	kTrapConvertCustomColorsDefault   0
	The default value for AITrapParameters::convertCustomColors.
#define	pointsPerMicron   (72.0 / 25400.0)
	The number of points in a micron.
Typedefs
typedef double	dbl
	Convenience type definition.
Enumerations
enum	AIOptionsFlagValues {   kExtractUnpaintedArtwork = 0x00001, kAllowEmptyOutput = 0x10000, kIgnoreEvenOddFillRule = 0x20000, kSuppressProgressDialog = 0x40000,   kDeselectResultArts = 0x80000 }
	Flag values for AIOptions::flags. More...
enum	AIShapeMode { kAIShapeModeAdd = 0, kAIShapeModeSubtract, kAIShapeModeIntersect, kAIShapeModeExclude }
	Compound shape modes. More...

---

Detailed Description

---

Define Documentation

#define kAIPathfinderSuite   "AI Pathfinder Suite"

Pathfinder suite name.

#define kAIPathfinderSuiteVersion   kAIPathfinderSuiteVersion6

Pathfinder suite name.

#define kAIPathfinderSuiteVersion6   AIAPI_VERSION(6)

Pathfinder suite version.

#define kAIPathfinderVersion   kAIPathfinderSuiteVersion

Pathfinder suite version.

#define kAllowEmptyOutputDefault   0

The default value for the AIOptions::flags kAllowEmptyOutput flag.

#define kDefaultPrecision   10.0

The default value for AIOptions::ipmPrecision.

Referenced by AIOptions::Init().

#define kExtractUnpaintedArtworkDefault   0

The default value for AIOptions::flags kExtractUnpaintedArtwork flag.

#define kHeightWidthAspectRatioDefault   1.0

The default value for AITrapParameters::heightWidthAspectRatio.

Referenced by AITrapParameters::Init().

#define kIgnoreEvenOddFillRuleDefault   0

The default value for the AIOptions::flags kIgnoreEvenOddFillRule flag.

#define kMaximumTintDefault   1.0

The default value for AITrapParameters::maximumTint.

Referenced by AITrapParameters::Init().

#define kMixConvertCustomColorsDefault   1

The default value for AIMixParameters::convertCustomColors.

Referenced by AIMixParameters::Init().

#define kRemoveRedundantPointsDefault   0

The default value for AIOptions::removeRedundantPoints.

Referenced by AIOptions::Init().

#define kReverseTrapDefault   0

The default value for AITrapParameters::reverseTrap.

Referenced by AITrapParameters::Init().

#define kSoftRateDefault   0.5

The default value for AIMixParameters::softRate.

Referenced by AIMixParameters::Init().

#define kTintToleranceDefault   0.05

The default value for AITrapParameters::tintTolerance.

Referenced by AITrapParameters::Init().

#define kTrapConvertCustomColorsDefault   0

The default value for AITrapParameters::convertCustomColors.

Referenced by AITrapParameters::Init().

#define kTrapThicknessDefault   0.25

The default value for AITrapParameters::trapThickness.

Referenced by AITrapParameters::Init().

#define kTrapTintDefault   0.4

The default value for AITrapParameters::trapTint.

Referenced by AITrapParameters::Init().

#define pointsPerMicron   (72.0 / 25400.0)

The number of points in a micron.

---

Typedef Documentation

typedef double dbl

Convenience type definition.

---

Enumeration Type Documentation

enum AIOptionsFlagValues

Flag values for AIOptions::flags.

Enumerator:

kExtractUnpaintedArtwork	When set, remove unpainted artwork from the result of processing.
kAllowEmptyOutput	When set, these functions can produce empty output: AIPathfinderSuite::DoBackMinusFrontEffect(), AIPathfinderSuite::DoFrontMinusBackEffect(), AIPathfinderSuite::DoIntersectEffect(), AIPathfinderSuite::DoExcludeEffect().
kIgnoreEvenOddFillRule	When set, assume that all paths use the non-zero fill rule rather than the even-odd fill rule.
kSuppressProgressDialog	When set, suppresses the progress report during a pathfinder operation. Available in AI 13 and later.
kDeselectResultArts	When set, result objects are deselected. Available in AI 13 and later.

enum AIShapeMode

Compound shape modes.

These control how objects inside a compound shape group interact with each other. Shapes are drawn from the bottom object up. See AIPathfinderSuite::SetShapeMode().

Enumerator:

kAIShapeModeAdd	Applies the Unite effect to each succeeding object and the previous shape.
kAIShapeModeSubtract	Applies the Back-minus-front effect to each succeeding object and the previous shape.
kAIShapeModeIntersect	Applies the Intersect effect to each succeeding object and the previous shape.
kAIShapeModeExclude	Applies the Exclude effect to each succeeding object and the previous shape.