AIEnvelope.h File Reference

#include "AIArt.h"
#include "AIDictionary.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIEnvelopeOptions
	Envelope deformation options that control how art is deformed. More...
struct	AIEnvelopeSuite
	This suite provides functions to create and manage envelopes, which allow you to apply a set of deformations to a set of source art objects. More...
Defines
#define	kAIEnvelopeSuite   "AI Envelope Suite"
#define	kAIEnvelopeSuiteVersion4   AIAPI_VERSION(4)
#define	kAIEnvelopeSuiteVersion   kAIEnvelopeSuiteVersion4
#define	kAIEnvelopeVersion   kAIEnvelopeSuiteVersion
#define	kDeformExpandAppearance   (1 << 0)
	Envelope options bit flag.
#define	kDeformExpandPatternFills   (1 << 1)
	Envelope options bit flag.
#define	kDeformExpandLinearGradients   (1 << 2)
	Envelope options bit flag.
#define	kDeformExpandText   (1 << 3)
	Options bit flag for AIEnvelopeSuite::DeformArt().
#define	kDeformOpacityMasks   (1 << 4)
	Options bit flag for AIEnvelopeSuite::DeformArt().
#define	kDeformExpandPluginGroups   (1 << 5)
	Options bit flag for AIEnvelopeSuite::DeformArt().
#define	kDeformExpandSymbols   (1 << 6)
	Options bit flag for AIEnvelopeSuite::DeformArt().
#define	kDeformAll   (0x0000FFFF)
	Options bit flag for AIEnvelopeSuite::DeformArt().
#define	kDeformNonAARaster   (1 << 16)
	Envelope options bit flag.
#define	kDeformRasterMakeClip   (1 << 17)
	Envelope options bit flag.
#define	kAIDeformMeshKey   "DeformMesh"
	Dictionary key for mesh value AIEnvelopeSuite::DeformArt().
#define	kAIDeformFidelityKey   "DeformFidelity"
	Dictionary key for fidelity value in AIEnvelopeSuite::DeformArt().
#define	kAIDeformOptionsKey   "DeformOptions"
	Dictionary key for options value in AIEnvelopeSuite::DeformArt().
Typedefs
typedef AIAPI AIBoolean(*	AIDeformProgressProc )(ai::int32 current, ai::int32 total)
	Callback for progress reports during a call to AIEnvelopeSuite::DeformArt().
Enumerations
enum	AIWarpStyle {   kWarpStyleArc = 1, kWarpStyleArcLower, kWarpStyleArcUpper, kWarpStyleArch,   kWarpStyleBulge, kWarpStyleShellLower, kWarpStyleShellUpper, kWarpStyleFlag,   kWarpStyleWave, kWarpStyleFish, kWarpStyleRise, kWarpStyleFisheye,   kWarpStyleInflate, kWarpStyleSqueeze, kWarpStyleTwist }
	Predefined warp styles for AIEnvelopeSuite::WarpEnvelope(). More...
enum	AIEnvelopeType { kEnvelopeWarp = 1, kEnvelopeMesh, kEnvelopeObject }
	Envelope types; see AIEnvelopeSuite::GetEnvelopeType(). More...

---

Detailed Description

---

Define Documentation

#define kAIEnvelopeSuite   "AI Envelope Suite"

#define kAIEnvelopeSuiteVersion   kAIEnvelopeSuiteVersion4

#define kAIEnvelopeSuiteVersion4   AIAPI_VERSION(4)

#define kAIEnvelopeVersion   kAIEnvelopeSuiteVersion

#define kDeformAll   (0x0000FFFF)

Options bit flag for AIEnvelopeSuite::DeformArt().

Sets all flags except kDeformNonAARaster and kDeformRasterMakeClip.

#define kDeformExpandAppearance   (1 << 0)

Envelope options bit flag.

When set, expand and distort the appearance of an object (such as applied effects or styles) and not just the object's underlying geometry. When false, the appearance is applied after the envelope distorts the underlying geometry.

#define kDeformExpandLinearGradients   (1 << 2)

Envelope options bit flag.

When set, expand and distort gradient fill.

#define kDeformExpandPatternFills   (1 << 1)

Envelope options bit flag.

When set, expand and distort pattern fill.

#define kDeformExpandPluginGroups   (1 << 5)

Options bit flag for AIEnvelopeSuite::DeformArt().

When set, expand and deform plug-in groups. (Envelopes do this automatically, regardless of flag value.)

#define kDeformExpandSymbols   (1 << 6)

Options bit flag for AIEnvelopeSuite::DeformArt().

When set, expand and deform symbols. (Envelopes do this automatically, regardless of flag value.)

#define kDeformExpandText   (1 << 3)

Options bit flag for AIEnvelopeSuite::DeformArt().

When set, expand and deform text. (Envelopes do this automatically, regardless of flag value.)

#define kDeformNonAARaster   (1 << 16)

Envelope options bit flag.

When set, anti-alias is not used to smooth raster images that are distorted in envelopes.

#define kDeformOpacityMasks   (1 << 4)

Options bit flag for AIEnvelopeSuite::DeformArt().

When set, deform objects in any opacity masks associated with the source art (as created with the Transparency palette). (Envelopes do this automatically, regardless of flag value.)

#define kDeformRasterMakeClip   (1 << 17)

Envelope options bit flag.

How to preserve raster shapes when they are distorted by non-rectangular envelopes.

• When set, apply an alpha channel (transparency) to the raster image.
• When clear, use a clipping mask on the raster image.

---

Typedef Documentation

typedef AIAPI AIBoolean(* AIDeformProgressProc)(ai::int32 current, ai::int32 total)

Callback for progress reports during a call to AIEnvelopeSuite::DeformArt().

Parameters:

	current	The current progress, a value between 0 and total.
	total	A value at which the operation is complete.

Returns:

False if user cancels the operation, otherwise true.

---

Enumeration Type Documentation

enum AIEnvelopeType

Envelope types; see AIEnvelopeSuite::GetEnvelopeType().

Enumerator:

kEnvelopeWarp
kEnvelopeMesh
kEnvelopeObject

enum AIWarpStyle

Predefined warp styles for AIEnvelopeSuite::WarpEnvelope().

Enumerator:

kWarpStyleArc
kWarpStyleArcLower
kWarpStyleArcUpper
kWarpStyleArch
kWarpStyleBulge
kWarpStyleShellLower
kWarpStyleShellUpper
kWarpStyleFlag
kWarpStyleWave
kWarpStyleFish
kWarpStyleRise
kWarpStyleFisheye
kWarpStyleInflate
kWarpStyleSqueeze
kWarpStyleTwist