RelateCreate
Create a new relate between two edges.
Python C++ C# VS Server
Python
BwApi.RelateCreate(garmentId, side1, side2, autoRelateOtherEdges)
C++
BwApiRelateCreate(garmentId, side1, side2, autoRelateOtherEdges);
C#
BwApi.RelateCreate(garmentId, side1, side2, autoRelateOtherEdges);
VS Server
{
"id": "API processing order number",
"function": "RelateCreate",
"params": {
"garmentId": "value",
"side1": "value",
"side2": "value",
"autoRelateOtherEdges": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | side1 | 1st side of the relate stitch |
In | side2 | 2nd side of the relate stitch |
In | autoRelateOtherEdges | Automatically relate other edges of the shape if both shape have same number of edges (1/0) |
Out | newRelateIds | Array of all generated relate edges |
Error/success code (see BwApiErrorCodes enum).
RelateCreateEx
Create a new relate with support for internal point.
Python C++ C# VS Server
Python
BwApi.RelateCreateEx(garmentId, side1, side2, autoRelateOtherEdges)
C++
BwApiRelateCreateEx(garmentId, side1, side2, autoRelateOtherEdges);
C#
BwApi.RelateCreateEx(garmentId, side1, side2, autoRelateOtherEdges);
VS Server
{
"id": "API processing order number",
"function": "RelateCreateEx",
"params": {
"garmentId": "value",
"side1": "value",
"side2": "value",
"autoRelateOtherEdges": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | side1 | 1st side of the relate stitch |
In | side2 | 2nd side of the relate stitch |
In | autoRelateOtherEdges | Automatically relate other edges of the shape if both shape have same number of edges (1/0) |
Out | newRelateIds | Array of all generated relate edges |
Error/success code (see BwApiErrorCodes enum).
RelateMultiCreateEx
Create a new multi relate with support for internal point.
Python C++ C# VS Server
Python
BwApi.RelateMultiCreateEx(garmentId, side1, side2, autoRelateOtherEdges, includeSym)
C++
BwApiRelateMultiCreateEx(garmentId, side1, side2, autoRelateOtherEdges, includeSym);
C#
BwApi.RelateMultiCreateEx(garmentId, side1, side2, autoRelateOtherEdges, includeSym);
VS Server
{
"id": "API processing order number",
"function": "RelateMultiCreateEx",
"params": {
"garmentId": "value",
"side1": "value",
"side2": "value",
"autoRelateOtherEdges": "value",
"includeSym": "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 | autoRelateOtherEdges | Automatically relate other edges of the shape if both shape have same number of edges (1/0) |
In | includeSym | Include symmetry |
Out | newRelateIds | The newly created stitch IDs |
Error/success code (see BwApiErrorCodes enum).
RelateIds
Get all relate IDs for the current garment.
Python C++ C# VS Server
Python
BwApi.RelateIds(garmentId)
C++
BwApiRelateIds(garmentId);
C#
BwApi.RelateIds(garmentId);
VS Server
{
"id": "API processing order number",
"function": "RelateIds",
"params": {
"garmentId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
Out | relateIds | Array of int containing the relate IDs |
Error/success code (see BwApiErrorCodes enum).
RelateDelete
Delete a relate.
Python C++ C# VS Server
Python
BwApi.RelateDelete(garmentId, relateId)
C++
BwApiRelateDelete(garmentId, relateId);
C#
BwApi.RelateDelete(garmentId, relateId);
VS Server
{
"id": "API processing order number",
"function": "RelateDelete",
"params": {
"garmentId": "value",
"relateId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | relateId | The relate ID to delete |
Error/success code (see BwApiErrorCodes enum).
RelateSidesGet
Get a relate's side parameters.
Python C++ C# VS Server
Python
BwApi.RelateSidesGet(garmentId, relateId)
C++
BwApiRelateSidesGet(garmentId, relateId);
C#
BwApi.RelateSidesGet(garmentId, relateId);
VS Server
{
"id": "API processing order number",
"function": "RelateSidesGet",
"params": {
"garmentId": "value",
"relateId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | relateId | The relate 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).
RelateSidesGetEx
Get a relate's side parameters with support for internal point.
Python C++ C# VS Server
Python
BwApi.RelateSidesGetEx(garmentId, relateId)
C++
BwApiRelateSidesGetEx(garmentId, relateId);
C#
BwApi.RelateSidesGetEx(garmentId, relateId);
VS Server
{
"id": "API processing order number",
"function": "RelateSidesGetEx",
"params": {
"garmentId": "value",
"relateId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | relateId | The relate ID |
Out | side1 | The 1st side of the relate (see BwApiStitchSideEx) |
Out | side2 | The 2nd side of the relate (see BwApiStitchSideEx) |
Error/success code (see BwApiErrorCodes enum).
RelatesGet
Get all the relate IDs from two BwApiStitchSide.
Python C++ C# VS Server
Python
BwApi.RelatesGet(garmentId, side1, side2)
C++
BwApiRelatesGet(garmentId, side1, side2);
C#
BwApi.RelatesGet(garmentId, side1, side2);
VS Server
{
"id": "API processing order number",
"function": "RelatesGet",
"params": {
"garmentId": "value",
"side1": "value",
"side2": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | side1 | The 1st side of the relate (see BwApiStitchSide) |
In | side2 | The 2nd side of the relate (see BwApiStitchSide) |
Out | relateIds | The relates IDs |
Error/success code (see BwApiErrorCodes enum).
Markers have no effect on the output.
RelatesGetEx
Get all the relates IDs from two BwApiStitchSideEx.
Python C++ C# VS Server
Python
BwApi.RelatesGetEx(garmentId, side1, side2)
C++
BwApiRelatesGetEx(garmentId, side1, side2);
C#
BwApi.RelatesGetEx(garmentId, side1, side2);
VS Server
{
"id": "API processing order number",
"function": "RelatesGetEx",
"params": {
"garmentId": "value",
"side1": "value",
"side2": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | side1 | The 1st side of the relate (see BwApiStitchSideEx) |
In | side2 | The 2nd side of the relate (see BwApiStitchSideEx) |
Out | relateIds | The relates IDs |
Error/success code (see BwApiErrorCodes enum).
Markers have no effect on the output.