Dart
This file contains the line functionality you can create / delete / get /update darts
BwApiDartCreate
Create a new dart.
Python
BwApi.DartCreate(garmentId, dartCreationProperties)
C++
BwApiDartCreate(garmentId, dartCreationProperties, dartId);
C#
BwApi.DartCreate(garmentId, dartCreationProperties);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | dartCreationProperties | JSON object as string that represents a dart object (see dart_creation_properties.json schema). |
Out | dartId | New dart ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiDartGet
Get a dart's properties.
Python
BwApi.DartGet(garmentId, dartId)
C++
BwApiDartGet(garmentId, dartId, dartProperties);
C#
BwApi.DartGet(garmentId, dartId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | dartId | Existing dart ID. |
Out | dartProperties | JSON object as string that represents a dart object (see dart_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiDartUpdate
Update a dart's properties.
Python
BwApi.DartUpdate(garmentId, dartId, dartProperties)
C++
BwApiDartUpdate(garmentId, dartId, dartProperties);
C#
BwApi.DartUpdate(garmentId, dartId, dartProperties);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | dartId | Existing dart ID. |
In | dartProperties | JSON object as string that represents a dart object (see dart_properties.json schema). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiDartDelete
Delete a dart but keeps the edges and stitches.
Python
BwApi.DartDelete(garmentId, dartId)
C++
BwApiDartDelete(garmentId, dartId);
C#
BwApi.DartDelete(garmentId, dartId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | dartId | Existing dart ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiDartIds
Returns a list of all darts in the given shape.
Python
BwApi.DartIds(garmentId, shapeId)
C++
BwApiDartIds(garmentId, shapeId, dartIds);
C#
BwApi.DartIds(garmentId, shapeId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
Out | dartIds | Array containing all the dart IDs of the shape. |
Returns: Error/success code (see BwApiErrorCodes enum).
---