Adobe 23102480 Scripting Guide - Page 66

Photoshop CS3

Adobe Photoshop CS3

Scripting Guide

Scripting Photoshop CS3

66

Note:

Look up the following classes in the

Adobe Photoshop CS3 JavaScript Scripting Reference

, or in the

ExtendScript Object Model Viewer to see if you understand how you used them in this script:

●

SolidColor

●

ArtLayer

. Notice that the

LayerKind.TEXT

value of the kind property uses the

LayerKind

constant. Constants are always depicted in upper case letters in Photoshop CS3 JavaScripts.

Applying a Wave Filter

In this section we’ll apply a wave filter to the word

Hello

in our document. This entails the following steps:

●

Set the document width and height to pixels and then rasterize the text object in the Text Layer.

Note:

Because text is a vector graphic and cannot apply a wave filter to vector graphics, we must first

convert the image to a bitmap. Rasterizing converts mathematically defined vector artwork to

pixels. For more information on rasterizing, refer to Photoshop CS3 Help.

●

Select the area of the layer to which we want to apply the wave filter.

Note:

See

Defining the Area of a Selection Object

in order to understand the code within the script

that accomplishes this task.

●

Apply a wave filter to the selection.

Note:

The wave is a truncated sine curve.

Defining the Area of a Selection Object

To define the area of a selection object, we create an array of coordinates, or points specified in pixels

within the document. The array indicates the coordinates that define the outside corners of a rectangular

area that begins at the top left corner of the document and extends half way across the document.

Note:

You can define any number of points for a selected area. The number of coordinates determines the

shape of the selection. The last coordinate defined must be the same as the first so that the area is a

closed selection path.

Note:

See

‘Photoshop CS3 Object Model’ on page 9

for information on selection objects and other

Photoshop CS3 objects.

The array values in order are:

●

Upper left corner of the selection:

0,0

●

0

indicates the left-most column in the document.

●

0

indicates the top row in the document.

●

Upper right corner of the selection:

theDocWidthInPixels / 2, 0

●

theDocWidthInPixels / 2

indicates the column in the middle of the document; that is, the

column whose coordinate is the total number of columns in the document divided by 2.

Note:

The value of

theDocWidthInPixels

is the total number of pixels that defines the document’s

horizontal dimension. Columns are arranged horizontally.

●

0

indicates the top row in the document.

●

Lower right corner:

theDocWidthInPixels / 2, theDocHeightInPixels

●

theDocWidthInPixels / 2

indicates the middle of the document.

Section	Page
Contents	3
Introduction	5
About this manual	5
Conventions in this guide	5
Photoshop CS3 Scripting Basics	7
Scripting Overview	7
Why use scripts instead of actions?	7
Scripting Support in Photoshop CS3	8
JavaScript Support	8
Executing other scripts	9
Startup Scripts	9
Executing JavaScripts from AS or VBS	9
Photoshop CS3 Object Model	9
Containment Hierarchy	10
Application and Document Classes	10
Layer Classes	11
Layer Comp Class	11
Channel Class	11
Selection Class	11
History State Class	12
Document Info Class	12
Path Item, Sub Path Item, and Path Point Classes	12
Preferences Class	12
Notifier Class	12
Count Item Class	12
Color Sampler Class	12
Measurement Scale Class	12
The Containment Hierarchy and the Photoshop CS3 User Interface	12
Additional Objects	14
Constants	14
Creating a Sample Hello World Script	15
Creating and Running an AppleScript	15
Creating and Running a VBScript	16
Creating and Running a JavaScript	17
Scripting Photoshop CS3	19
Viewing Photoshop CS3 Objects, Commands, and Methods	19
Viewing Photoshop CS3’s AppleScript Dictionary	19
Viewing Photoshop CS3’s Type Library (VBS)	20
Targeting and Referencing the Application Object	20
Creating New Objects in a Script	21
Setting the Active Object	23
Setting the Active Document	24
Setting the Active Layer	25
Setting the Active Channels	25
Opening a Document	26
Opening a File with Default File Format	26
Specifying File Formats to Open	27
Saving a Document	29
Setting Application Preferences	30
Allowing or Preventing Dialogs	31
Working with the Photoshop CS3 Object Model	31
Using the Application Object	31
Using the Document Object	32
Manipulating a Document Object	32
Working with Layer Objects	34
Creating an ArtLayer Object	34
Creating a Layer Set Object	35
Referencing ArtLayer Objects	36
Working with Layer Set Objects	37
Linking Layer Objects	38
AS	38
VBS	38
JS	38
Applying Styles to Layers	38
Using the Text Item Object	39
Determining a Layer’s Kind	40
Adding and Manipulating Text in a Text Item Object	40
Working with Selection Objects	41
Creating and Defining a Selection	41
Stroking the Selection Border	42
Inverting Selections	43
Expanding, Contracting, and Feathering Selections	43
Filling a Selection	43
Loading and Storing Selections	44
Working with Channel Objects	45
Changing Channel Types	45
Using the Document Info Object	46
Using History State Objects	46
Using Notifier Objects	47
Using the PathItem Object	48
Working with Color Objects	50
Solid Color Classes	51
Using Hex Values for RGB Color	51
Getting and Converting Colors	51
Comparing Colors	52
Getting a Web Safe Color	52
Working with Filters	53
AS	53
VBS	53
JS	53
Other Filters	53
Understanding Clipboard Interaction	54
Using the Copy and Paste commands	54
Using the Copy Merged Command/Method	55
Working with Units	55
Unit Values	56
Special Unit Value Types	56
AppleScript Unit Considerations	56
Using Unit Values in Calculations	57
Unit Value Usage	57
Setting Ruler and Type Units in a Script	59
Sample Workflow Automation JavaScripts	59
Advanced Scripting	60
Working with Document Preferences	60
Applying Color to a Text Item	63
Applying a Wave Filter	66
Defining the Area of a Selection Object	66
Applying a MotionBlur Filter	69
Action Manager	72
The ScriptListener Plug-In	72
Installing ScriptListener	72
Action Manager Scripting Objects	73
Recording a Script using ScriptListener	73
Using the Action Manager from JavaScript	74
Using the Action Manager from a VBS Script	75
Running JavaScript-based Action Manager code from VBScript	78
Running JavaScript-based Action Manager code from AppleScript	78
Using ScriptListener to find event IDs and class IDs	79

Adobe 23102480 Scripting Guide - Page 66

Applying a Wave Filter, Defining the Area of a Selection Object

Page 66 highlights