Skip to main content

Stitch

Stitch

This file contains stitch functionality, you can create stitch, delete stitch etc...

BwApiStitchCreate

Create a new stitch between two edges.

Python

BwApi.StitchCreate(garmentId, side1, side2)

C++

BwApiStitchCreate(garmentId, side1, side2, newStitchId);

C#

BwApi.StitchCreate(garmentId, side1, side2);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

side1

1st side of the stitch.

In

side2

2nd side of the stitch.

Out

newStitchId

The newly created stitch ID.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchCreateEx

Create a new stitch with support for internal point.

Python

BwApi.StitchCreateEx(garmentId, side1, side2)

C++

BwApiStitchCreateEx(garmentId, side1, side2, newStitchId);

C#

BwApi.StitchCreateEx(garmentId, side1, side2);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

side1

1st side of the stitch.

In

side2

2nd side of the stitch.

Out

newStitchId

The newly created stitch ID.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchMultiCreateEx

Create a new multi stitch with support for internal point.

Python

BwApi.StitchMultiCreateEx(garmentId, side1, side2, addSymStitches)

C++

BwApiStitchMultiCreateEx(garmentId, side1, side2, addSymStitches, newStitchIds);

C#

BwApi.StitchMultiCreateEx(garmentId, side1, side2, addSymStitches);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

side1

1st side of the stitch.

In

side2

2nd side of the stitch.

In

addSymStitches

Use symmetric stitch creation

Out

newStitchIds

The newly created stitch IDs.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchDelete

Delete a stitch.

Python

BwApi.StitchDelete(garmentId, stitchId)

C++

BwApiStitchDelete(garmentId, stitchId);

C#

BwApi.StitchDelete(garmentId, stitchId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

stitchId

The stitch ID to delete.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchIds

Get all stitch IDs for the current garment.

Python

BwApi.StitchIds(garmentId)

C++

BwApiStitchIds(garmentId, stitchIds);

C#

BwApi.StitchIds(garmentId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

Out

stitchIds

Array of int containing the stitch IDs.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchSidesGet

Get a stitch's side parameters.

Python

BwApi.StitchSidesGet(garmentId, stitchId)

C++

BwApiStitchSidesGet(garmentId, stitchId, side1, side2);

C#

BwApi.StitchSidesGet(garmentId, stitchId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

stitchId

the stitch ID.

Out

side1

The 1st side of the stitch (see BwApiStitchSide).

Out

side2

The 2nd side of the stitch (see BwApiStitchSide).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchSidesSet

Set a stitch's side parameters.

Python

BwApi.StitchSidesSet(garmentId, stitchId, side1, side2)

C++

BwApiStitchSidesSet(garmentId, stitchId, side1, side2);

C#

BwApi.StitchSidesSet(garmentId, stitchId, side1, side2);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

stitchId

The stitch ID.

In

side1

The 1st side of the stitch (see BwApiStitchSide).

In

side2

The 2nd side of the stitch (see BwApiStitchSide).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchSidesGetEx

Get a stitch's side parameters with support for internal point.

Python

BwApi.StitchSidesGetEx(garmentId, stitchId)

C++

BwApiStitchSidesGetEx(garmentId, stitchId, side1, side2);

C#

BwApi.StitchSidesGetEx(garmentId, stitchId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

stitchId

The stitch ID.

Out

side1

The 1st side of the stitch (see BwApiStitchSideEx).

Out

side2

The 2nd side of the stitch (see BwApiStitchSideEx).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchSidesSetEx

Set a stitch's side parameters with support for internal point.

Python

BwApi.StitchSidesSetEx(garmentId, stitchId)

C++

BwApiStitchSidesSetEx(garmentId, stitchId, side1, side2);

C#

BwApi.StitchSidesSetEx(garmentId, stitchId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

stitchId

The stitch ID.

Out

side1

The 1st side of the stitch (see BwApiStitchSideEx).

Out

side2

The 2nd side of the stitch (see BwApiStitchSideEx).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiStitchesGet

Get all the stitch IDs from two BwApiStitchSide.

Python

BwApi.StitchesGet(garmentId, side1, side2)

C++

BwApiStitchesGet(garmentId, side1, side2, stitchIds);

C#

BwApi.StitchesGet(garmentId, side1, side2);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

side1

The 1st side of the stitch (see BwApiStitchSide).

In

side2

The 2nd side of the stitch (see BwApiStitchSide).

Out

stitchIds

The stitch IDs.

Returns: Error/success code (see BwApiErrorCodes enum).

Note: The markers have no affect on the output.

---

BwApiStitchesGetEx

Get all the stitch IDs from two BwApiStitchSideEx.

Python

BwApi.StitchesGetEx(garmentId, side1, side2)

C++

BwApiStitchesGetEx(garmentId, side1, side2, stitchIds);

C#

BwApi.StitchesGetEx(garmentId, side1, side2);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

side1

The 1st side of the stitch (see BwApiStitchSideEx).

In

side2

The 2nd side of the stitch (see BwApiStitchSideEx).

Out

stitchIds

The stitch IDs.

Returns: Error/success code (see BwApiErrorCodes enum).

Note: The markers have no affect on the output.

---

Did this answer your question?