GuideLine
This file contains the line functionality you can create / delete / guide line.
BwApiGuidelineCreate
Create a new guideline.
Python
BwApi.GuidelineCreate(garmentId, guidelineProperties)
C++
BwApiGuidelineCreate(garmentId, guidelineProperties, guidelineId);
C#
BwApi.GuidelineCreate(garmentId, guidelineProperties);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | guidelineProperties | JSON object as string that represents a guideline object (see guideline_properties.json schema). |
Out | guidelineId | Existing shape ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiGuidelineDelete
Delete a guideline.
Python
BwApi.GuidelineDelete(garmentId, guidelineId)
C++
BwApiGuidelineDelete(garmentId, guidelineId);
C#
BwApi.GuidelineDelete(garmentId, guidelineId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | guidelineId | Existing guideline ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiGuidelinePropertiesGet
Get a guideline's properties.
Python
BwApi.GuidelinePropertiesGet(garmentId, guidelineId)
C++
BwApiGuidelinePropertiesGet(garmentId, guidelineId, guidelineProperties);
C#
BwApi.GuidelinePropertiesGet(garmentId, guidelineId);
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 guideline_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---