GuidelineCreate
Create a new guideline.
Python C++ C# VS Server
Python
BwApi.GuidelineCreate(garmentId, guidelineProperties)
C++
BwApiGuidelineCreate(garmentId, guidelineProperties);
C#
BwApi.GuidelineCreate(garmentId, guidelineProperties);
VS Server
{
"id": "API processing order number",
"function": "GuidelineCreate",
"params": {
"garmentId": "value",
"guidelineProperties": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | guidelineProperties | JSON object as string that represents a guideline object (see Schema/guideline_properties.json schema) |
Out | guidelineId | Existing shape ID |
Error/success code (see BwApiErrorCodes enum).
GuidelineDelete
Delete a guideline.
Python C++ C# VS Server
Python
BwApi.GuidelineDelete(garmentId, guidelineId)
C++
BwApiGuidelineDelete(garmentId, guidelineId);
C#
BwApi.GuidelineDelete(garmentId, guidelineId);
VS Server
{
"id": "API processing order number",
"function": "GuidelineDelete",
"params": {
"garmentId": "value",
"guidelineId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | guidelineId | Existing guideline ID |
Error/success code (see BwApiErrorCodes enum).
GuidelinePropertiesGet
Get a guideline's properties.
Python C++ C# VS Server
Python
BwApi.GuidelinePropertiesGet(garmentId, guidelineId)
C++
BwApiGuidelinePropertiesGet(garmentId, guidelineId);
C#
BwApi.GuidelinePropertiesGet(garmentId, guidelineId);
VS Server
{
"id": "API processing order number",
"function": "GuidelinePropertiesGet",
"params": {
"garmentId": "value",
"guidelineId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | guidelineId | Existing guideline ID |
Out | guidelineProperties | JSON object as string that represents a guideline object (see Schema/guideline_properties.json schema) |
Error/success code (see BwApiErrorCodes enum).