PleatCreate

Creates a new pleat.

Python C++ C# VS Server

Python

BwApi.PleatCreate(garmentId, shapeId, type, edgeId, marker)

C++

BwApiPleatCreate(garmentId, shapeId, type, edgeId, marker);

C#

BwApi.PleatCreate(garmentId, shapeId, type, edgeId, marker);

VS Server

{
	"id": "API processing order number",
	"function": "PleatCreate",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"type": "value",
		"edgeId": "value",
		"marker": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	type	Pleat type (see BwApiPleatType enum)
In	edgeId	The edge ID to add pleat to
In	marker	Marker on the edge (percenteage 0-100)
Out	newPleatId	The newly created pleat ID

Error/success code (see BwApiErrorCodes enum).

PleatDelete

Deletes a pleat.

Python C++ C# VS Server

Python

BwApi.PleatDelete(garmentId, shapeId, pleatId)

C++

BwApiPleatDelete(garmentId, shapeId, pleatId);

C#

BwApi.PleatDelete(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatDelete",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to delete

Error/success code (see BwApiErrorCodes enum).

PleatIds

Gets all the pleat IDs within the specified shape ID.

Python C++ C# VS Server

Python

BwApi.PleatIds(garmentId, shapeId)

C++

BwApiPleatIds(garmentId, shapeId);

C#

BwApi.PleatIds(garmentId, shapeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
Out	pleatIds	Array of integer containing the pleat IDs

Error/success code (see BwApiErrorCodes enum).

PleatTypeGet

Get a pleat's type.

Python C++ C# VS Server

Python

BwApi.PleatTypeGet(garmentId, shapeId, pleatId)

C++

BwApiPleatTypeGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatTypeGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatTypeGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
Out	type	Get the type of the pleat (see BwApiPleatTyp enum)

Error/success code (see BwApiErrorCodes enum).

PleatTypeSet

Set a pleat's type.

Python C++ C# VS Server

Python

BwApi.PleatTypeSet(garmentId, shapeId, pleatId, type)

C++

BwApiPleatTypeSet(garmentId, shapeId, pleatId, type);

C#

BwApi.PleatTypeSet(garmentId, shapeId, pleatId, type);

VS Server

{
	"id": "API processing order number",
	"function": "PleatTypeSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"type": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
In	type	Set the type of the pleat

Error/success code (see BwApiErrorCodes enum).

PleatLocationGet

Get a pleat's location.

Python C++ C# VS Server

Python

BwApi.PleatLocationGet(garmentId, shapeId, pleatId)

C++

BwApiPleatLocationGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatLocationGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatLocationGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
Out	edgeId	Top edge ID for this pleat
Out	marker	Pleat's location on the edge (0-100)

Error/success code (see BwApiErrorCodes enum).

PleatLocationSet

Set a pleat's location.

Python C++ C# VS Server

Python

BwApi.PleatLocationSet(garmentId, shapeId, pleatId, edgeId, marker)

C++

BwApiPleatLocationSet(garmentId, shapeId, pleatId, edgeId, marker);

C#

BwApi.PleatLocationSet(garmentId, shapeId, pleatId, edgeId, marker);

VS Server

{
	"id": "API processing order number",
	"function": "PleatLocationSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"edgeId": "value",
		"marker": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
In	edgeId	Top edge ID for this pleat
In	marker	Pleat's location on the edge (0-100)

Error/success code (see BwApiErrorCodes enum).

PleatVertexPositionGet

Get an open pleat's vertex position, this function will return an error if the pleatId type is knife pleat.

Python C++ C# VS Server

Python

BwApi.PleatVertexPositionGet(garmentId, shapeId, pleatId)

C++

BwApiPleatVertexPositionGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatVertexPositionGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatVertexPositionGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
Out	vertexPos	Pleat's vertex position (see BwApiCoordinatesXY)

Error/success code (see BwApiErrorCodes enum).

PleatVertexPositionSet

Set an open pleat's vertex position. This function will return an error if the pleatId type is knife pleat.

Python C++ C# VS Server

Python

BwApi.PleatVertexPositionSet(garmentId, shapeId, pleatId)

C++

BwApiPleatVertexPositionSet(garmentId, shapeId, pleatId);

C#

BwApi.PleatVertexPositionSet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatVertexPositionSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
Out	vertexPos	Pleat's vertex position (see BwApiCoordinatesXY)

Error/success code (see BwApiErrorCodes enum).

PleatTransformationGet

Get a pleat's transformation (width, depth etc...).

Python C++ C# VS Server

Python

BwApi.PleatTransformationGet(garmentId, shapeId, pleatId)

C++

BwApiPleatTransformationGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatTransformationGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatTransformationGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
Out	transformation	Pleat's transformation (see BwApiPleatTransformation)

Error/success code (see BwApiErrorCodes enum).

PleatTransformationSet

Set a pleat's transformation (width start, width end, depth etc...).

Python C++ C# VS Server

Python

BwApi.PleatTransformationSet(garmentId, shapeId, pleatId, transformation)

C++

BwApiPleatTransformationSet(garmentId, shapeId, pleatId, transformation);

C#

BwApi.PleatTransformationSet(garmentId, shapeId, pleatId, transformation);

VS Server

{
	"id": "API processing order number",
	"function": "PleatTransformationSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"transformation": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
In	transformation	Pleat's transformation (see BwApiPleatTransformation)

Error/success code (see BwApiErrorCodes enum).

Since this function updates all the pleat's transformation properties at once please first call BwApiPleatTransformationGet to get the current values, update the relevant properties and then call BwApiPleatTransformationSet.

PleatStitchLengthGet

Get a pleat's stitch length.

Python C++ C# VS Server

Python

BwApi.PleatStitchLengthGet(garmentId, shapeId, pleatId, stitchLength)

C++

BwApiPleatStitchLengthGet(garmentId, shapeId, pleatId, stitchLength);

C#

BwApi.PleatStitchLengthGet(garmentId, shapeId, pleatId, stitchLength);

VS Server

{
	"id": "API processing order number",
	"function": "PleatStitchLengthGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"stitchLength": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
In	stitchLength	Stitch length

Error/success code (see BwApiErrorCodes enum).

PleatStitchLengthSet

Set a pleat's stitch length.

Python C++ C# VS Server

Python

BwApi.PleatStitchLengthSet(garmentId, shapeId, pleatId, stitchLength)

C++

BwApiPleatStitchLengthSet(garmentId, shapeId, pleatId, stitchLength);

C#

BwApi.PleatStitchLengthSet(garmentId, shapeId, pleatId, stitchLength);

VS Server

{
	"id": "API processing order number",
	"function": "PleatStitchLengthSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"stitchLength": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
In	stitchLength	Stitch length

Error/success code (see BwApiErrorCodes enum).

PleatDartGet

Check if a pleat is a dart(1) (fully stitched) or not(0).

Python C++ C# VS Server

Python

BwApi.PleatDartGet(garmentId, shapeId, pleatId)

C++

BwApiPleatDartGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatDartGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatDartGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to use
Out	dart	1 - pleat is dart, 0 - not dart

Error/success code (see BwApiErrorCodes enum).

PleatDartSet

Set if a pleat is dart(1) (fully stitched) or not(0).

Python C++ C# VS Server

Python

BwApi.PleatDartSet(garmentId, shapeId, pleatId, dart)

C++

BwApiPleatDartSet(garmentId, shapeId, pleatId, dart);

C#

BwApi.PleatDartSet(garmentId, shapeId, pleatId, dart);

VS Server

{
	"id": "API processing order number",
	"function": "PleatDartSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"dart": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to use
In	dart	1 - pleat is dart, 0 - not dart

Error/success code (see BwApiErrorCodes enum).

Only an open pleat can be defined as a dart, calling this function with a knife pleat will return an error.

PleatFlippedGet

Check if a pleat fold direction is flipped(1) or not(0).

Python C++ C# VS Server

Python

BwApi.PleatFlippedGet(garmentId, shapeId, pleatId)

C++

BwApiPleatFlippedGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatFlippedGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatFlippedGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to use
Out	flipped	1 - direction is flipped, 0 - not flipped

Error/success code (see BwApiErrorCodes enum).

PleatFlippedSet

Set if a pleat fold direction is flipped(1) or not(0).

Python C++ C# VS Server

Python

BwApi.PleatFlippedSet(garmentId, shapeId, pleatId, flipped)

C++

BwApiPleatFlippedSet(garmentId, shapeId, pleatId, flipped);

C#

BwApi.PleatFlippedSet(garmentId, shapeId, pleatId, flipped);

VS Server

{
	"id": "API processing order number",
	"function": "PleatFlippedSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"flipped": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to use
In	flipped	1 - pleat is flipped, 0 not flipped

Error/success code (see BwApiErrorCodes enum).

PleatIronedGet

Check if a pleat is ironed(1) or not(0).

Python C++ C# VS Server

Python

BwApi.PleatIronedGet(garmentId, shapeId, pleatId, ironed)

C++

BwApiPleatIronedGet(garmentId, shapeId, pleatId, ironed);

C#

BwApi.PleatIronedGet(garmentId, shapeId, pleatId, ironed);

VS Server

{
	"id": "API processing order number",
	"function": "PleatIronedGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"ironed": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to use
In	ironed	1 - ironed, 0 not ironed

Error/success code (see BwApiErrorCodes enum).

PleatIronedSet

Set if a pleat is ironed(1) or not(0).

Python C++ C# VS Server

Python

BwApi.PleatIronedSet(garmentId, shapeId, pleatId, ironed)

C++

BwApiPleatIronedSet(garmentId, shapeId, pleatId, ironed);

C#

BwApi.PleatIronedSet(garmentId, shapeId, pleatId, ironed);

VS Server

{
	"id": "API processing order number",
	"function": "PleatIronedSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value",
		"ironed": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Pleat ID to use
In	ironed	1 - ironed, 0 not ironed

Error/success code (see BwApiErrorCodes enum).

PleatMirroredIdGet

Get a pleat's mirrored pleat ID.

Python C++ C# VS Server

Python

BwApi.PleatMirroredIdGet(garmentId, shapeId, pleatId)

C++

BwApiPleatMirroredIdGet(garmentId, shapeId, pleatId);

C#

BwApi.PleatMirroredIdGet(garmentId, shapeId, pleatId);

VS Server

{
	"id": "API processing order number",
	"function": "PleatMirroredIdGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"pleatId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	pleatId	Existing pleat ID
Out	mirroredPleatId	Mirrored pleat ID

Error/success code (see BwApiErrorCodes enum).

This function is only relevant for inner symmetry shapes.