EdgeCreateAsPolyline

Creates a new edge (base size).

Python C++ C# VS Server

Python

BwApi.EdgeCreateAsPolyline(garmentId, shapeId, beforeEdgeId, optimized, points)

C++

BwApiEdgeCreateAsPolyline(garmentId, shapeId, beforeEdgeId, optimized, points);

C#

BwApi.EdgeCreateAsPolyline(garmentId, shapeId, beforeEdgeId, optimized, points);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeCreateAsPolyline",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"beforeEdgeId": "value",
		"optimized": "value",
		"points": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	beforeEdgeId	Place in edge order in which to insert the new edge, -1 for insertion at the end of the edge list
In	optimized	Boolean (1/0) if the creation of the edge should optimized the number of the points
In	points	Array of BwApiPoint that represent the edge's points
Out	newEdgeId	ID of the newly created edge ID

Error/success code (see BwApiErrorCodes enum).

EdgeCreate

Python C++ C# VS Server

Python

BwApi.EdgeCreate()

C++

BwApiEdgeCreate();

C#

BwApi.EdgeCreate();

VS Server

{
	"id": "API processing order number",
	"function": "EdgeCreate",
	"params": {}
}

EdgeCreateAsBezier

Creates a new edge with Bezier points (base size).

Python C++ C# VS Server

Python

BwApi.EdgeCreateAsBezier(garmentId, shapeId, beforeEdgeId, points)

C++

BwApiEdgeCreateAsBezier(garmentId, shapeId, beforeEdgeId, points);

C#

BwApi.EdgeCreateAsBezier(garmentId, shapeId, beforeEdgeId, points);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeCreateAsBezier",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"beforeEdgeId": "value",
		"points": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	beforeEdgeId	Place in edge order in which to insert the new edge, -1 for insertion at the end of the edge list
In	points	Array of BwApiBezierPoint that represents
Out	newEdgeId	ID of the newly created edge ID

Error/success code (see BwApiErrorCodes enum).

EdgeDelete

Delete an edge from a shape.

Python C++ C# VS Server

Python

BwApi.EdgeDelete(garmentId, shapeId, edgeId)

C++

BwApiEdgeDelete(garmentId, shapeId, edgeId);

C#

BwApi.EdgeDelete(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Edge ID to delete

Error/success code (see BwApiErrorCodes enum).

EdgePointsSetAsPolyline

Set an edge's points (base size).

Python C++ C# VS Server

Python

BwApi.EdgePointsSetAsPolyline(garmentId, shapeId, edgeId, optimized)

C++

BwApiEdgePointsSetAsPolyline(garmentId, shapeId, edgeId, optimized);

C#

BwApi.EdgePointsSetAsPolyline(garmentId, shapeId, edgeId, optimized);

VS Server

{
	"id": "API processing order number",
	"function": "EdgePointsSetAsPolyline",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"optimized": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	optimized	Boolean (1/0) if the creation of the edge should optimized the number of the points
Out	points	Array of BwApiPoint that represents the edge's points

Error/success code (see BwApiErrorCodes enum).

EdgePointsSet

Python C++ C# VS Server

Python

BwApi.EdgePointsSet()

C++

BwApiEdgePointsSet();

C#

BwApi.EdgePointsSet();

VS Server

{
	"id": "API processing order number",
	"function": "EdgePointsSet",
	"params": {}
}

EdgePointsSetAsBezier

Set an edge's points as Bezier (base size).

Python C++ C# VS Server

Python

BwApi.EdgePointsSetAsBezier(garmentId, shapeId, edgeId)

C++

BwApiEdgePointsSetAsBezier(garmentId, shapeId, edgeId);

C#

BwApi.EdgePointsSetAsBezier(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
Out	points	Array of BwApiBezierPoint that represents the edge's points

Error/success code (see BwApiErrorCodes enum).

EdgePointsGet

Get an edge's points (current size).

Python C++ C# VS Server

Python

BwApi.EdgePointsGet(garmentId, shapeId, edgeId, points)

C++

BwApiEdgePointsGet(garmentId, shapeId, edgeId, points);

C#

BwApi.EdgePointsGet(garmentId, shapeId, edgeId, points);

VS Server

{
	"id": "API processing order number",
	"function": "EdgePointsGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"points": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	points	Array of BwApiPoint that represents the edge's points

Error/success code (see BwApiErrorCodes enum).

EdgePointsGetAsBezier

Get an edge's points as Bezier (current size).

Python C++ C# VS Server

Python

BwApi.EdgePointsGetAsBezier(garmentId, shapeId, edgeId, points)

C++

BwApiEdgePointsGetAsBezier(garmentId, shapeId, edgeId, points);

C#

BwApi.EdgePointsGetAsBezier(garmentId, shapeId, edgeId, points);

VS Server

{
	"id": "API processing order number",
	"function": "EdgePointsGetAsBezier",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"points": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	points	Array of BwApiBezierPoint that represents the edge's points

Error/success code (see BwApiErrorCodes enum).

EdgeMaterialIdGet

Get an edge's material ID.

Python C++ C# VS Server

Python

BwApi.EdgeMaterialIdGet(garmentId, shapeId, edgeId)

C++

BwApiEdgeMaterialIdGet(garmentId, shapeId, edgeId);

C#

BwApi.EdgeMaterialIdGet(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
Out	materialId	Get the assigned material (seam/edge assignable trim) ID

Error/success code (see BwApiErrorCodes enum).

Each edge can have a material (seam/edge assignable trim) assigned to it. Use this function to get the edge material ID.

EdgeMaterialIdSet

Set an edge's material ID.

Python C++ C# VS Server

Python

BwApi.EdgeMaterialIdSet(garmentId, shapeId, edgeId, materialId)

C++

BwApiEdgeMaterialIdSet(garmentId, shapeId, edgeId, materialId);

C#

BwApi.EdgeMaterialIdSet(garmentId, shapeId, edgeId, materialId);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeMaterialIdSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"materialId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	materialId	Assign material (seam) ID to this edge

Error/success code (see BwApiErrorCodes enum).

Each edge can have a material (seam) assign to it. Use this function to set the material (seam) ID.

Set material id as -1 will clear the material from the edge.

EdgeSeamAllowanceGet

Get an edge's seam allowance.

Python C++ C# VS Server

Python

BwApi.EdgeSeamAllowanceGet(garmentId, shapeId, edgeId)

C++

BwApiEdgeSeamAllowanceGet(garmentId, shapeId, edgeId);

C#

BwApi.EdgeSeamAllowanceGet(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
Out	seamAllowance	Get edge's seam allowance

Error/success code (see BwApiErrorCodes enum).

EdgeSeamAllowanceSet

Set an edge's seam allowance.

Python C++ C# VS Server

Python

BwApi.EdgeSeamAllowanceSet(garmentId, shapeId, edgeId, seamAllowance)

C++

BwApiEdgeSeamAllowanceSet(garmentId, shapeId, edgeId, seamAllowance);

C#

BwApi.EdgeSeamAllowanceSet(garmentId, shapeId, edgeId, seamAllowance);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeSeamAllowanceSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"seamAllowance": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	seamAllowance	Set edge's seam allowance

Error/success code (see BwApiErrorCodes enum).

EdgeLengthGet

Get an edge's length.

Python C++ C# VS Server

Python

BwApi.EdgeLengthGet(garmentId, shapeId, edgeId, sizeId)

C++

BwApiEdgeLengthGet(garmentId, shapeId, edgeId, sizeId);

C#

BwApi.EdgeLengthGet(garmentId, shapeId, edgeId, sizeId);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeLengthGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"sizeId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	sizeId	Size of the garment
Out	length	Get edge's length (see BwApiEdgePuffyProperties)

Error/success code (see BwApiErrorCodes enum).

EdgeMirroredIdGet

Get an edge's mirrored ID.

Python C++ C# VS Server

Python

BwApi.EdgeMirroredIdGet(garmentId, shapeId, edgeId)

C++

BwApiEdgeMirroredIdGet(garmentId, shapeId, edgeId);

C#

BwApi.EdgeMirroredIdGet(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
Out	mirroredEdgeId	Mirrored edge ID

Error/success code (see BwApiErrorCodes enum).

This function only relevant for inner symmetry shapes.

EdgeMarkerGet

Get an approximate edge's marker from a given point.

Python C++ C# VS Server

Python

BwApi.EdgeMarkerGet(garmentId, shapeId, edgeId, point)

C++

BwApiEdgeMarkerGet(garmentId, shapeId, edgeId, point);

C#

BwApi.EdgeMarkerGet(garmentId, shapeId, edgeId, point);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeMarkerGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"point": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	point	The point to approximate from
Out	marker	Marker size (From 0% to 100%)

Error/success code (see BwApiErrorCodes enum).

The marker size is from the start point of the edge.

Tolerance is 1 cm.

EdgeNameGet

Get an edge's name.

Python C++ C# VS Server

Python

BwApi.EdgeNameGet(garmentId, shapeId, edgeId)

C++

BwApiEdgeNameGet(garmentId, shapeId, edgeId);

C#

BwApi.EdgeNameGet(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
Out	edgeName	Get the edge's name

Error/success code (see BwApiErrorCodes enum).

EdgeNameSet

Set an edge's name.

Python C++ C# VS Server

Python

BwApi.EdgeNameSet(garmentId, shapeId, edgeId, edgeName)

C++

BwApiEdgeNameSet(garmentId, shapeId, edgeId, edgeName);

C#

BwApi.EdgeNameSet(garmentId, shapeId, edgeId, edgeName);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeNameSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"edgeName": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	edgeName	Set the edge's name

Error/success code (see BwApiErrorCodes enum).

EdgeTextureOffsetGet

Get the texture offset for a given edge.

Python C++ C# VS Server

Python

BwApi.EdgeTextureOffsetGet(garmentId, shapeId, edgeId, materialId)

C++

BwApiEdgeTextureOffsetGet(garmentId, shapeId, edgeId, materialId);

C#

BwApi.EdgeTextureOffsetGet(garmentId, shapeId, edgeId, materialId);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeTextureOffsetGet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"materialId": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	materialId	Existing material ID on the shape (this can also be group item in case the texture of the shape is group material)
Out	offset	Get edge's offset

Error/success code (see BwApiErrorCodes enum).

The offset is value from 0 to the length of the seam texture (Not the edge length).

This function works the same for back fabrics as for front fabrics.

EdgeTextureOffsetSet

Set the texture offset for a given edge.

Python C++ C# VS Server

Python

BwApi.EdgeTextureOffsetSet(garmentId, shapeId, edgeId, materialId, offset)

C++

BwApiEdgeTextureOffsetSet(garmentId, shapeId, edgeId, materialId, offset);

C#

BwApi.EdgeTextureOffsetSet(garmentId, shapeId, edgeId, materialId, offset);

VS Server

{
	"id": "API processing order number",
	"function": "EdgeTextureOffsetSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"materialId": "value",
		"offset": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	materialId	Existing material ID on the shape (this can also be group item in case the texture of the shape is group material)
In	offset	Edge's offset

Error/success code (see BwApiErrorCodes enum).

The offset is value from 0 to the length of the seam texture (Not the edge length).

This function works the same for back fabrics as for front fabrics.

EdgePropertiesGet

Get an edge's properties.

Python C++ C# VS Server

Python

BwApi.EdgePropertiesGet(garmentId, shapeId, edgeId)

C++

BwApiEdgePropertiesGet(garmentId, shapeId, edgeId);

C#

BwApi.EdgePropertiesGet(garmentId, shapeId, edgeId);

VS Server

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

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
Out	edgeProperties	JSON object as string that represents an edge object (see Schema/edge_properties.json schema)

Error/success code (see BwApiErrorCodes enum).

EdgePropertiesSet

Set an edge's properties.

Python C++ C# VS Server

Python

BwApi.EdgePropertiesSet(garmentId, shapeId, edgeId, edgeProperties)

C++

BwApiEdgePropertiesSet(garmentId, shapeId, edgeId, edgeProperties);

C#

BwApi.EdgePropertiesSet(garmentId, shapeId, edgeId, edgeProperties);

VS Server

{
	"id": "API processing order number",
	"function": "EdgePropertiesSet",
	"params": {
		"garmentId": "value",
		"shapeId": "value",
		"edgeId": "value",
		"edgeProperties": "value"
	}
}

Parameters

Param	Variable	Description
In	garmentId	Existing garment ID
In	shapeId	Existing shape ID
In	edgeId	Existing edge ID
In	edgeProperties	JSON object as string that represents an edge object (see Schema/edge_properties.json schema)

Error/success code (see BwApiErrorCodes enum).