AIEnvelopeAction.h File Reference

#include "AIActionManager.h"

Go to the source code of this file.

Defines
#define	kAIEnvelopeActionMenuRelease   0
	Release menu item.
#define	kAIEnvelopeActionMenuOptions   1
	Options menu item.
#define	kAIEnvelopeActionMenuExpand   2
	Expand menu item.
#define	kAIEnvelopeActionMenuToggle   3
	Toggle menu item.
#define	kAIEnvelopeActionTypeWarp   0
	Warp operation.
#define	kAIEnvelopeActionTypeMesh   1
	Mesh operation.
#define	kAIEnvelopeActionTypeTopObject   2
	Top-object operation.
#define	kAIEnvelopeMenuAction   "ai_plugin_envelope"
	Runs operations in the Envelope submenu of the Action menu.
#define	kAIEnvelopeMakeAction   "ai_plugin_envelope_make"
	Makes an envelope from the selected objects on the artboard.
#define	kAIEnvelopeResetAction   "ai_plugin_envelope_reset"
	Resets the selected envelopes on the artboard.
Variables
const ActionParamKeyID	kAIEnvelopeMenuItem = 'menu'
	Parameter to kAIEnvelopeMenuAction.
const ActionParamKeyID	kAIEnvelopeAntiAliasRaster = 'aars'
	Options parameter to kAIEnvelopeMenuAction.
const ActionParamKeyID	kAIEnvelopePreserveRasterShape = 'alph'
	Options parameter.
const ActionParamKeyID	kAIEnvelopeFidelity = 'fidt'
	Options parameter to kAIEnvelopeMenuAction.
const ActionParamKeyID	kAIEnvelopeDistortAppearance = 'app.'
	Options parameter to kAIEnvelopeMenuAction.
const ActionParamKeyID	kAIEnvelopeDistortPatterns = 'patt'
	Options parameter to kAIEnvelopeMenuAction.
const ActionParamKeyID	kAIEnvelopeDistortGradients = 'grad'
	Options parameter to kAIEnvelopeMenuAction.
const ActionParamKeyID	kAIEnvelopeMakeType = 'type'
	Parameter to kAIEnvelopeMakeAction.
const ActionParamKeyID	kAIEnvelopeNumRows = 'rows'
	Parameter to kAIEnvelopeMakeAction, for mesh type: Number of rows in mesh.
const ActionParamKeyID	kAIEnvelopeNumCols = 'cols'
	Parameter to kAIEnvelopeMakeAction, for mesh type: Number of columns in mesh.
const ActionParamKeyID	kAIEnvelopeWarpStyle = 'warp'
	Parameter to kAIEnvelopeMakeAction, for warp type: Warp style, see AIWarpStyle in AIEnvelope.h.
const ActionParamKeyID	kAIEnvelopeBend = 'bend'
	Parameter to kAIEnvelopeMakeAction, for warp type: Bend amount, a percentage value in the range [-100..100].
const ActionParamKeyID	kAIEnvelopeHorizDistort = 'horz'
	Parameter to kAIEnvelopeMakeAction, for warp type: Horizontal distortion amount, a percentage value in the range [-100..100].
const ActionParamKeyID	kAIEnvelopeVertDistort = 'vert'
	Parameter to kAIEnvelopeMakeAction, for warp type: Vertical distortion amount, a percentage value in the range [-100..100].
const ActionParamKeyID	kAIEnvelopeRotate90 = 'rot.'
	Parameter to kAIEnvelopeMakeAction, for warp type: 0 to apply horizontally, 1 to apply bend vertically.
const ActionParamKeyID	kAIEnvelopeResetType = 'type'
	Parameter to kAIEnvelopeResetAction.
const ActionParamKeyID	kAIEnvelopeMaintainShape = 'shap'
	Parameter to kAIEnvelopeResetAction, for mesh type: When true, maintain the envelope shape.

---

Define Documentation

#define kAIEnvelopeActionMenuExpand   2

Expand menu item.

#define kAIEnvelopeActionMenuOptions   1

Options menu item.

#define kAIEnvelopeActionMenuRelease   0

Release menu item.

#define kAIEnvelopeActionMenuToggle   3

Toggle menu item.

#define kAIEnvelopeActionTypeMesh   1

Mesh operation.

#define kAIEnvelopeActionTypeTopObject   2

Top-object operation.

#define kAIEnvelopeActionTypeWarp   0

Warp operation.

---

Variable Documentation

const ActionParamKeyID kAIEnvelopeAntiAliasRaster = 'aars'

Options parameter to kAIEnvelopeMenuAction.

When true, anti-alias is used to smooth rasters that are distorted in envelopes.

const ActionParamKeyID kAIEnvelopeBend = 'bend'

Parameter to kAIEnvelopeMakeAction, for warp type: Bend amount, a percentage value in the range [-100..100].

const ActionParamKeyID kAIEnvelopeDistortAppearance = 'app.'

Options parameter to kAIEnvelopeMenuAction.

When true, 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.

const ActionParamKeyID kAIEnvelopeDistortGradients = 'grad'

Options parameter to kAIEnvelopeMenuAction.

When true, expand and distort gradient fill.

const ActionParamKeyID kAIEnvelopeDistortPatterns = 'patt'

Options parameter to kAIEnvelopeMenuAction.

When true,expand and distort pattern fill.

const ActionParamKeyID kAIEnvelopeFidelity = 'fidt'

Options parameter to kAIEnvelopeMenuAction.

The fidelity value controls how closely the deformed object fits into the envelope region. Higher values add more points to the distorted paths, and take longerto calculate. An integer in the range [0..100]

const ActionParamKeyID kAIEnvelopeHorizDistort = 'horz'

Parameter to kAIEnvelopeMakeAction, for warp type: Horizontal distortion amount, a percentage value in the range [-100..100].

const ActionParamKeyID kAIEnvelopeMaintainShape = 'shap'

Parameter to kAIEnvelopeResetAction, for mesh type: When true, maintain the envelope shape.

const ActionParamKeyID kAIEnvelopeMakeType = 'type'

Parameter to kAIEnvelopeMakeAction.

How to make an envelope from selected objects on the artboard.

• Make with Warp: kAIEnvelopeActionTypeWarp
• Make with Mesh: kAIEnvelopeActionTypeMesh
• Make with Top Object: kAIEnvelopeActionTypeTopObject

const ActionParamKeyID kAIEnvelopeMenuItem = 'menu'

Parameter to kAIEnvelopeMenuAction.

The menu item to run.

• Release: kAIEnvelopeActionMenuRelease, replace the envelope with art objects for the contents (in their original state) and the mesh.
• Options: kAIEnvelopeActionMenuOptions, select distortion parameters.
• Expand: kAIEnvelopeActionMenuExpand, replace the envelope with the art objects for the contents, in their distorted state.
• Edit Contents/Envelope: kAIEnvelopeActionMenuToggle, toggle between editing the contained art and editing the shape of a warp or mesh.

const ActionParamKeyID kAIEnvelopeNumCols = 'cols'

Parameter to kAIEnvelopeMakeAction, for mesh type: Number of columns in mesh.

const ActionParamKeyID kAIEnvelopeNumRows = 'rows'

Parameter to kAIEnvelopeMakeAction, for mesh type: Number of rows in mesh.

const ActionParamKeyID kAIEnvelopePreserveRasterShape = 'alph'

Options parameter.

How to preserve raster shapes when they are distorted by non-rectangular envelopes. Can be 0 or 1.

• When 0, use a clipping mask on the raster.
• When 1, apply an alpha channel (transparency) to the raster.

const ActionParamKeyID kAIEnvelopeResetType = 'type'

Parameter to kAIEnvelopeResetAction.

How to reset the envelope:

• Reset with Warp: kAIEnvelopeActionTypeWarp
• Reset with Mesh: kAIEnvelopeActionTypeMesh

const ActionParamKeyID kAIEnvelopeRotate90 = 'rot.'

Parameter to kAIEnvelopeMakeAction, for warp type: 0 to apply horizontally, 1 to apply bend vertically.

const ActionParamKeyID kAIEnvelopeVertDistort = 'vert'

Parameter to kAIEnvelopeMakeAction, for warp type: Vertical distortion amount, a percentage value in the range [-100..100].

const ActionParamKeyID kAIEnvelopeWarpStyle = 'warp'

Parameter to kAIEnvelopeMakeAction, for warp type: Warp style, see AIWarpStyle in AIEnvelope.h.