Skip to main content

Stitch

StitchCreate StitchCreateEx StitchMultiCreateEx ...

Updated over 2 months ago

StitchCreate

Create a new stitch between two edges.

Python C++ C# VS Server

Python

BwApi.StitchCreate(garmentId, side1, side2)

C++

BwApiStitchCreate(garmentId, side1, side2);

C#

BwApi.StitchCreate(garmentId, side1, side2);

VS Server

{
	"id": "API processing order number",
	"function": "StitchCreate",
	"params": {
		"garmentId": "value",
		"side1": "value",
		"side2": "value"
	}
}    

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

Error/success code (see BwApiErrorCodes enum).

StitchCreateEx

Create a new stitch with support for internal point.

Python C++ C# VS Server

Python

BwApi.StitchCreateEx(garmentId, side1, side2)

C++

BwApiStitchCreateEx(garmentId, side1, side2);

C#

BwApi.StitchCreateEx(garmentId, side1, side2);

VS Server

{
	"id": "API processing order number",
	"function": "StitchCreateEx",
	"params": {
		"garmentId": "value",
		"side1": "value",
		"side2": "value"
	}
}    

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

Error/success code (see BwApiErrorCodes enum).

StitchMultiCreateEx

Create a new multi stitch with support for internal point.

Python C++ C# VS Server

Python

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

C++

BwApiStitchMultiCreateEx(garmentId, side1, side2, addSymStitches);

C#

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

VS Server

{
	"id": "API processing order number",
	"function": "StitchMultiCreateEx",
	"params": {
		"garmentId": "value",
		"side1": "value",
		"side2": "value",
		"addSymStitches": "value"
	}
}    

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

Error/success code (see BwApiErrorCodes enum).

StitchDelete

Delete a stitch.

Python C++ C# VS Server

Python

BwApi.StitchDelete(garmentId, stitchId)

C++

BwApiStitchDelete(garmentId, stitchId);

C#

BwApi.StitchDelete(garmentId, stitchId);

VS Server

{
	"id": "API processing order number",
	"function": "StitchDelete",
	"params": {
		"garmentId": "value",
		"stitchId": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

In

stitchId

The stitch ID to delete

Error/success code (see BwApiErrorCodes enum).

StitchIds

Get all stitch IDs for the current garment.

Python C++ C# VS Server

Python

BwApi.StitchIds(garmentId)

C++

BwApiStitchIds(garmentId);

C#

BwApi.StitchIds(garmentId);

VS Server

{
	"id": "API processing order number",
	"function": "StitchIds",
	"params": {
		"garmentId": "value"
	}
}    

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID

Out

stitchIds

Array of int containing the stitch IDs

Error/success code (see BwApiErrorCodes enum).

StitchSidesGet

Get a stitch's side parameters.

Python C++ C# VS Server

Python

BwApi.StitchSidesGet(garmentId, stitchId)

C++

BwApiStitchSidesGet(garmentId, stitchId);

C#

BwApi.StitchSidesGet(garmentId, stitchId);

VS Server

{
	"id": "API processing order number",
	"function": "StitchSidesGet",
	"params": {
		"garmentId": "value",
		"stitchId": "value"
	}
}    

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)

Error/success code (see BwApiErrorCodes enum).

StitchSidesSet

Set a stitch's side parameters.

Python C++ C# VS Server

Python

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

C++

BwApiStitchSidesSet(garmentId, stitchId, side1, side2);

C#

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

VS Server

{
	"id": "API processing order number",
	"function": "StitchSidesSet",
	"params": {
		"garmentId": "value",
		"stitchId": "value",
		"side1": "value",
		"side2": "value"
	}
}    

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)

Error/success code (see BwApiErrorCodes enum).

StitchSidesGetEx

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

Python C++ C# VS Server

Python

BwApi.StitchSidesGetEx(garmentId, stitchId)

C++

BwApiStitchSidesGetEx(garmentId, stitchId);

C#

BwApi.StitchSidesGetEx(garmentId, stitchId);

VS Server

{
	"id": "API processing order number",
	"function": "StitchSidesGetEx",
	"params": {
		"garmentId": "value",
		"stitchId": "value"
	}
}    

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)

Error/success code (see BwApiErrorCodes enum).

StitchSidesSetEx

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

Python C++ C# VS Server

Python

BwApi.StitchSidesSetEx(garmentId, stitchId)

C++

BwApiStitchSidesSetEx(garmentId, stitchId);

C#

BwApi.StitchSidesSetEx(garmentId, stitchId);

VS Server

{
	"id": "API processing order number",
	"function": "StitchSidesSetEx",
	"params": {
		"garmentId": "value",
		"stitchId": "value"
	}
}    

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)

Error/success code (see BwApiErrorCodes enum).

StitchesGet

Get all the stitch IDs from two BwApiStitchSide.

Python C++ C# VS Server

Python

BwApi.StitchesGet(garmentId, side1, side2)

C++

BwApiStitchesGet(garmentId, side1, side2);

C#

BwApi.StitchesGet(garmentId, side1, side2);

VS Server

{
	"id": "API processing order number",
	"function": "StitchesGet",
	"params": {
		"garmentId": "value",
		"side1": "value",
		"side2": "value"
	}
}    

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

Error/success code (see BwApiErrorCodes enum).

The markers have no affect on the output.

StitchesGetEx

Get all the stitch IDs from two BwApiStitchSideEx.

Python C++ C# VS Server

Python

BwApi.StitchesGetEx(garmentId, side1, side2)

C++

BwApiStitchesGetEx(garmentId, side1, side2);

C#

BwApi.StitchesGetEx(garmentId, side1, side2);

VS Server

{
	"id": "API processing order number",
	"function": "StitchesGetEx",
	"params": {
		"garmentId": "value",
		"side1": "value",
		"side2": "value"
	}
}    

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

Error/success code (see BwApiErrorCodes enum).

The markers have no affect on the output.

Did this answer your question?