~ubuntu-branches/ubuntu/maverick/gimp/maverick-updates

<td> The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0 = BEZIER_MOVE). Note all points are returned in pixel resolution.

184

</td>

185

</tr>

186

<tr>

187

<td>

188

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

189

<td> The type of the path. Currently only one type (1 = Bezier) is supported.

190

</td>

191

</tr>

192

</tbody>

193

</table></div>

194

</div>

195

<hr>

196

197

198

<a name="gimp-path-get-current"></a>gimp_path_get_current ()</h3>

199

<a class="indexterm" name="id2592372"></a><pre class="programlisting">gchar* gimp_path_get_current (gint32 image_ID);</pre>

200

<p>

201

The name of the current path. Error if no paths.

202

</p>

203

<p>

204

The name of the current path. Error if no paths.</p>

205

<p>

206

207

</p>

208

209

210

<tbody>

211

<tr>

212

<td>

213

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

214

<td> The ID of the image to get the current path from.

215

</td>

216

</tr>

217

<tr>

218

<td>

219

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

220

<td> The name of the current path.

221

</td>

222

</tr>

223

</tbody>

224

</table></div>

225

</div>

226

<hr>

227

228

229

<a name="gimp-path-set-current"></a>gimp_path_set_current ()</h3>

230

<a class="indexterm" name="id2592446"></a><pre class="programlisting">gboolean gimp_path_set_current (gint32 image_ID,

231

const gchar *name);</pre>

232

<p>

233

Sets the current path associated with the passed image.

234

</p>

235

<p>

236

Sets a named path as the current path.</p>

237

<p>

238

239

</p>

240

241

242

<tbody>

243

<tr>

244

<td>

245

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

246

<td> The ID of the image in which a path will become current.

247

</td>

248

</tr>

249

<tr>

250

<td>

251

252

<td> The name of the path to make current.

253

</td>

254

</tr>

255

<tr>

256

<td>

257

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

258

<td> TRUE on success.

259

</td>

260

</tr>

261

</tbody>

262

</table></div>

263

</div>

264

<hr>

265

266

267

<a name="gimp-path-set-points"></a>gimp_path_set_points ()</h3>

268

<a class="indexterm" name="id2599478"></a><pre class="programlisting">gboolean gimp_path_set_points (gint32 image_ID,

269

const gchar *name,

270

gint ptype,

271

gint num_path_points,

272

const gdouble *points_pairs);</pre>

273

<p>

274

Set the points associated with the named path.

275

</p>

276

<p>

277

Set the points associated with the named path.</p>

278

<p>

279

280

</p>

281

282

283

<tbody>

284

<tr>

285

<td>

286

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

287

<td> The ID of the image to set the paths in.

288

</td>

289

</tr>

290

<tr>

291

<td>

292

293

<td> The name of the path to create. If it exists then a unique name will be created - query the list of paths if you want to make sure that the name of the path you create is unique. This will be set as the current path.

294

</td>

295

</tr>

296

<tr>

297

<td>

298

<span class="term"><em class="parameter"><code>ptype</code></em> :</span></td>

299

<td> The type of the path. Currently only one type (1 = Bezier) is supported.

300

</td>

301

</tr>

302

<tr>

303

<td>

304

<span class="term"><em class="parameter"><code>num_path_points</code></em> :</span></td>

305

<td> The number of elements in the array, i.e. the number of points in the path * 3. Each point is made up of (x, y, type) of floats. Currently only the creation of bezier curves is allowed. The type parameter must be set to (1) to indicate a BEZIER type curve. Note that for BEZIER curves, points must be given in the following order: ACCACCAC... If the path is not closed the last control point is missed off. Points consist of three control points (control/anchor/control) so for a curve that is not closed there must be at least two points passed (2 x,y pairs). If (num_path_points/3) % 3 = 0 then the path is assumed to be closed and the points are ACCACCACCACC.

306

</td>

307

</tr>

308

<tr>

309

<td>

310

<span class="term"><em class="parameter"><code>points_pairs</code></em> :</span></td>

311

<td> The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependant on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0= BEZIER_MOVE). Note all points are returned in pixel resolution.

312

</td>

313

</tr>

314

<tr>

315

<td>

316

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

317

<td> TRUE on success.

318

</td>

319

</tr>

320

</tbody>

321

</table></div>

322

</div>

323

<hr>

324

325

326

<a name="gimp-path-stroke-current"></a>gimp_path_stroke_current ()</h3>

327

<a class="indexterm" name="id2599634"></a><pre class="programlisting">gboolean gimp_path_stroke_current (gint32 image_ID);</pre>

328

<p>

329

Stroke the current path in the passed image.

330

</p>

331

<p>

332

Stroke the current path in the passed image.</p>

333

<p>

334

335

</p>

336

337

338

<tbody>

339

<tr>

340

<td>

341

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

342

<td> The ID of the image which contains the path to stroke.

343

</td>

344

</tr>

345

<tr>

346

<td>

347

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

348

<td> TRUE on success.

349

</td>

350

</tr>

351

</tbody>

352

</table></div>

353

</div>

354

<hr>

355

356

357

<a name="gimp-path-get-point-at-dist"></a>gimp_path_get_point_at_dist ()</h3>

358

<a class="indexterm" name="id2599708"></a><pre class="programlisting">gint gimp_path_get_point_at_dist (gint32 image_ID,

359

gdouble distance,

360

gint *y_point,

361

gdouble *slope);</pre>

362

<p>

363

Get point on a path at a specified distance along the path.

364

</p>

365

<p>

366

This will return the x,y position of a point at a given distance

367

along the bezier curve. The distance will be obtained by first

368

digitizing the curve internally and then walking along the curve.

369

For a closed curve the start of the path is the first point on the

370

path that was created. This might not be obvious. Note the current

371

path is used.</p>

372

<p>

373

374

</p>

375

376

377

<tbody>

378

<tr>

379

<td>

380

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

381

<td> The ID of the image the paths belongs to.

382

</td>

383

</tr>

384

<tr>

385

<td>

386

<span class="term"><em class="parameter"><code>distance</code></em> :</span></td>

387

<td> The distance along the path.

388

</td>

389

</tr>

390

<tr>

391

<td>

392

<span class="term"><em class="parameter"><code>y_point</code></em> :</span></td>

393

<td> The y position of the point.

394

</td>

395

</tr>

396

<tr>

397

<td>

398

<span class="term"><em class="parameter"><code>slope</code></em> :</span></td>

399

<td> The slope (dy / dx) at the specified point.

400

</td>

401

</tr>

402

<tr>

403

<td>

404

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

405

<td> The x position of the point.

406

</td>

407

</tr>

408

</tbody>

409

</table></div>

410

</div>

411

<hr>

412

413

414

<a name="gimp-path-get-tattoo"></a>gimp_path_get_tattoo ()</h3>

415

<a class="indexterm" name="id2599850"></a><pre class="programlisting">gint gimp_path_get_tattoo (gint32 image_ID,

416

const gchar *name);</pre>

417

<p>

418

Returns the tattoo associated with the name path.

419

</p>

420

<p>

421

This procedure returns the tattoo associated with the specified

422

path. A tattoo is a unique and permanent identifier attached to a

423

path that can be used to uniquely identify a path within an image

424

even between sessions.</p>

425

<p>

426

427

</p>

428

429

430

<tbody>

431

<tr>

432

<td>

433

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

434

<td> The image.

435

</td>

436

</tr>

437

<tr>

438

<td>

439

440

<td> The name of the path whose tattoo should be obtained.

441

</td>

442

</tr>

443

<tr>

444

<td>

445

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

446

<td> The tattoo associated with the named path.

447

</td>

448

</tr>

449

</tbody>

450

</table></div>

451

</div>

452

<hr>

453

454

455

<a name="gimp-get-path-by-tattoo"></a>gimp_get_path_by_tattoo ()</h3>

456

<a class="indexterm" name="id2599949"></a><pre class="programlisting">gchar* gimp_get_path_by_tattoo (gint32 image_ID,

457

gint tattoo);</pre>

458

<p>

459

Return the name of the path with the given tattoo.

460

</p>

461

<p>

462

The procedure returns the name of the path in the specified image

463

which has the passed tattoo. The tattoos are unique within the image

464

and will be preserved across sessions and through renaming of the

465

path. An error is returned if no path with the specified tattoo can

466

be found.</p>

467

<p>

468

469

</p>

470

471

472

<tbody>

473

<tr>

474

<td>

475

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

476

<td> The image.

477

</td>

478

</tr>

479

<tr>

480

<td>

481

<span class="term"><em class="parameter"><code>tattoo</code></em> :</span></td>

482

<td> The tattoo of the required path.

483

</td>

484

</tr>

485

<tr>

486

<td>

487

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

488

<td> The name of the path with the specified tattoo.

489

</td>

490

</tr>

491

</tbody>

492

</table></div>

493

</div>

494

<hr>

495

496

497

<a name="gimp-path-delete"></a>gimp_path_delete ()</h3>

498

<a class="indexterm" name="id2600050"></a><pre class="programlisting">gboolean gimp_path_delete (gint32 image_ID,

499

const gchar *name);</pre>

500

<p>

501

Delete the named path associated with the passed image.

502

</p>

503

<p>

504

Delete the named path.</p>

505

<p>

506

507

</p>

508

509

510

<tbody>

511

<tr>

512

<td>

513

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

514

<td> The ID of the image to delete the path from.

515

</td>

516

</tr>

517

<tr>

518

<td>

519

520

<td> The name of the path to delete.

521

</td>

522

</tr>

523

<tr>

524

<td>

525

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

526

<td> TRUE on success.

527

</td>

528

</tr>

529

</tbody>

530

</table></div>

531

</div>

532

<hr>

533

534

535

<a name="gimp-path-get-locked"></a>gimp_path_get_locked ()</h3>

536

<a class="indexterm" name="id2600145"></a><pre class="programlisting">gint gimp_path_get_locked (gint32 image_ID,

537

const gchar *name);</pre>

538

<p>

539

Returns the locked status associated with the named path.

540

</p>

541

<p>

542

This procedure returns the lock status associated with the specified

543

path. A path can be \"locked\" which means that the transformation

544

tool operations will also apply to the path.</p>

545

<p>

546

547

</p>

548

549

550

<tbody>

551

<tr>

552

<td>

553

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

554

<td> The image.

555

</td>

556

</tr>

557

<tr>

558

<td>

559

560

<td> The name of the path whose locked status should be obtained.

561

</td>

562

</tr>

563

<tr>

564

<td>

565

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

566

<td> The lock status associated with the name path. 0 is returned if the path is not locked. 1 is returned if the path is locked.

567

</td>

568

</tr>

569

</tbody>

570

</table></div>

571

</div>

572

<hr>

573

574

575

<a name="gimp-path-set-locked"></a>gimp_path_set_locked ()</h3>

576

<a class="indexterm" name="id2593171"></a><pre class="programlisting">gboolean gimp_path_set_locked (gint32 image_ID,

577

const gchar *name,

578

gint lockstatus);</pre>

579

<p>

580

Set the locked status associated with the named path.

581

</p>

582

<p>

583

This procedure sets the lock status associated with the specified

584

path. A path can be \"locked\" which means that the transformation

585

tool operations will also apply to the path.</p>

586

<p>

587

588

</p>

589

590

591

<tbody>

592

<tr>

593

<td>

594

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

595

<td> The image.

596

</td>

597

</tr>

598

<tr>

599

<td>

600

601

<td> the name of the path whose locked status should be set.

602

</td>

603

</tr>

604

<tr>

605

<td>

606

<span class="term"><em class="parameter"><code>lockstatus</code></em> :</span></td>

607

<td> The lock status associated with the name path. 0 if the path is not locked. 1 if the path is to be locked.

608

</td>

609

</tr>

610

<tr>

611

<td>

612

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

613

<td> TRUE on success.

614

</td>

615

</tr>

616

</tbody>

617

</table></div>

618

</div>

619

<hr>

620

621

622

<a name="gimp-path-set-tattoo"></a>gimp_path_set_tattoo ()</h3>

623

<a class="indexterm" name="id2593292"></a><pre class="programlisting">gboolean gimp_path_set_tattoo (gint32 image_ID,

624

const gchar *name,

625

gint tattovalue);</pre>

626

<p>

627

Sets the tattoo associated with the named path.

628

</p>

629

<p>

630

This procedure sets the tattoo associated with the specified path. A

631

tattoo is a unique and permenant identifier attached to a path that

632

can be used to uniquely identify a path within an image even between

633

sessions. Note that the value passed to this function must have been

634

obtained from a previous call to path_get_tattoo.</p>

635

<p>

636

637

</p>

638

639

640

<tbody>

641

<tr>

642

<td>

643

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

644

<td> The image.

645

</td>

646

</tr>

647

<tr>

648

<td>

649

650

<td> the name of the path whose tattoo should be set.

651

</td>

652

</tr>

653

<tr>

654

<td>

655

<span class="term"><em class="parameter"><code>tattovalue</code></em> :</span></td>

656

<td> The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.

657

</td>

658

</tr>

659

<tr>

660

<td>

661

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

662

<td> TRUE on success.

663

</td>

664

</tr>

665

</tbody>

666

</table></div>

667

</div>

668

<hr>

669

670

671

<a name="gimp-path-to-selection"></a>gimp_path_to_selection ()</h3>

672

<a class="indexterm" name="id2593416"></a><pre class="programlisting">gboolean gimp_path_to_selection (gint32 image_ID,

673

const gchar *name,

674

<a href="libgimp-gimpenums.html#GimpChannelOps">GimpChannelOps</a> op,

675

gboolean antialias,

676

gboolean feather,

677

gdouble feather_radius_x,

678

gdouble feather_radius_y);</pre>

679

<p>

680

Transforms the active path into a selection

681

</p>

682

<p>

683

This procedure renders the desired path into the current selection.</p>

684

<p>

685

686

</p>

687

688

689

<tbody>

690

<tr>

691

<td>

692

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

693

<td> The image.

694

</td>

695

</tr>

696

<tr>

697

<td>

698

699

<td> The name of the path which should be made into selection.

700

</td>

701

</tr>

702

<tr>

703

<td>

704

705

<td> The desired operation with current selection.

706

</td>

707

</tr>

708

<tr>

709

<td>

710

<span class="term"><em class="parameter"><code>antialias</code></em> :</span></td>

711

<td> Antialias selection.

712

</td>

713

</tr>

714

<tr>

715

<td>

716

<span class="term"><em class="parameter"><code>feather</code></em> :</span></td>

717

<td> Feather selection.

718

</td>

719

</tr>

720

<tr>

721

<td>

722

<span class="term"><em class="parameter"><code>feather_radius_x</code></em> :</span></td>

723

<td> Feather radius x.

724

</td>

725

</tr>

726

<tr>

727

<td>

728

<span class="term"><em class="parameter"><code>feather_radius_y</code></em> :</span></td>

729

<td> Feather radius y.

730

</td>

731

</tr>

732

<tr>

733

<td>

734

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

735

<td> TRUE on success.

736

</td>

737

</tr>

738

</tbody>

739

</table></div>

740

</div>

741

<hr>

742

743

744

<a name="gimp-path-import"></a>gimp_path_import ()</h3>

745

<a class="indexterm" name="id2593620"></a><pre class="programlisting">gboolean gimp_path_import (gint32 image_ID,

746

const gchar *filename,

747

gboolean merge,

748

gboolean scale);</pre>

749

<p>

750

Import paths from an SVG file.

751

</p>

752

<p>

753

This procedure imports paths from an SVG file. This is a temporary

754

solution until the new vectors PDB API is in place. Don't rely on

755

this function being available in future GIMP releases.</p>

756

<p>

757

758

</p>

759

760

761

<tbody>

762

<tr>

763

<td>

764

<span class="term"><em class="parameter"><code>image_ID</code></em> :</span></td>

765

<td> The image.

766

</td>

767

</tr>

768

<tr>

769

<td>

770

<span class="term"><em class="parameter"><code>filename</code></em> :</span></td>

771

<td> The name of the SVG file to import.

772

</td>

773

</tr>

774

<tr>

775

<td>

776

<span class="term"><em class="parameter"><code>merge</code></em> :</span></td>

777

<td> Merge paths into a single vectors object.

778

</td>

779

</tr>

780

<tr>

781

<td>

782

<span class="term"><em class="parameter"><code>scale</code></em> :</span></td>

783

<td> Scale the SVG to image dimensions.

784

</td>

785

</tr>

786

<tr>

787

<td>

788

<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

789

<td> TRUE on success.

790

</td>

791

</tr>

792

</tbody>

793

</table></div>

794

</div>

795

</div>

796

</div>

797

798

799

<td align="right"><a accesskey="n" href="libgimp-gimppixelfetcher.html"><b>gimppixelfetcher >></b></a></td>

800

</tr></table>

801

</body>

802

</html>

Older »