Adobe 65011817 Extended User Guide - Page 46

dom.addNewStar

Page 46 highlights

Last updated 12/8/2009 EXTENDING FIREWORKS 42 The Document object Arguments controlPointFirst, mainpoint, and controlPointLast Points that specify the x,y coordinates of the preceding control point, the main point, and the following control point of the Bezier path (see "Point data type" on page 8). bCopyAttrs If bCopyAttrs is false, the path's stroke and fill are copied directly from the document's current stroke and fill settings. If it is true, the path's fill is set to None, and the brush is set to something other than None. Returns Nothing. Description Adds a new path that consists of a single Bezier point. The path uses the default fill, stroke, and so on, and is added on the current frame and layer. The point is selected after it is added. Example The following command adds a new path that consists of a single Bezier point at the specified coordinates and copies the path's stroke and fill from the document's current stroke and fill settings: fw.getDocumentDOM().addNewSinglePointPath({x:150, y:63}, {x:150, y:63}, {x:150, y:63}, false); dom.addNewStar() Availability Fireworks 3 Usage dom.AddNewStar(numSides, spikiness, bIsStar, centerPoint, outsidePoint) Arguments numSides An integer that specifies the number of sides of the new path. spikiness A floating-point value that controls the regularity of the star or polygon. Pass -1 to have Fireworks calculate a good value, or pass a value between 0 and 1 for manual control. bIsStar If bIsStar is true, a star with the specified number of points is created. If it is false, a regular polygon with the specified number of sides is created. centerPoint Specifies the center point of the star or polygon (see "Point data type" on page 8). outsidePoint Specifies a point on the radius of the star or polygon. Returns Nothing. Description Adds a new star- or polygon-shaped path. Example The following command adds a five-sided star:

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336

42
EXTENDING FIREWORKS
The Document object
Las
t
up
d
a
ted
12/8/2009
Arguments
controlPointFirst
,
mainpoint
, and
controlPointLast
Points that specify the x,y coordinates of the preceding
control point, the main point, and the following control point of the Bezier path (see “
Point data type
” on page
8).
bCopyAttrs
If bCopyAttrs is
false
, the path’s stroke and fill are copied directly from the document’s current stroke
and fill settings. If it is
true
, the path’s fill is set to None, and the brush is set to something other than None.
Returns
Nothing.
Description
Adds a new path that consists of a single Bezier point. The path uses the default fill, stroke, and so on, and is added on
the current frame and layer. The point is selected after it is added.
Example
The following command adds a new path that consists of a single Bezier point at the specified coordinates and copies
the path’s stroke and fill from the document’s current stroke and fill settings:
fw.getDocumentDOM().addNewSinglePointPath({x:150, y:63}, {x:150, y:63}, {x:150, y:63},
false);
dom.addNewStar()
Availability
Fireworks 3
Usage
dom.AddNewStar(
numSides, spikiness, bIsStar, centerPoint, outsidePoint
)
Arguments
numSides
An integer that specifies the number of sides of the new path.
spikiness
A floating-point value that controls the regularity of the star or polygon. Pass
-1
to have Fireworks
calculate a good value, or pass a value between 0 and 1 for manual control.
bIsStar
If
bIsStar
is
true
, a star with the specified number of points is created. If it is
false
, a regular polygon with
the specified number of sides is created.
centerPoint
Specifies the center point of the star or polygon (see “
Point data type
” on page
8).
outsidePoint
Specifies a point on the radius of the star or polygon.
Returns
Nothing.
Description
Adds a new star- or polygon-shaped path.
Example
The following command adds a five-sided star: