Zipper
This file contains the zipper functionality you can modify an existing zipper.
BwApiZipperCreate
Create a new zipper and assign it to the given elements.
Python
BwApi.ZipperCreate(garmentId, materialId, leftConnectedElements, rightConnectedElements)
C++
BwApiZipperCreate(garmentId, materialId, leftConnectedElements, rightConnectedElements, zipperId);
C#
BwApi.ZipperCreate(garmentId, materialId, leftConnectedElements, rightConnectedElements);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | materialId | Existing material ID. |
In | leftConnectedElements | Assign the left side of the zipper to this element. |
In | rightConnectedElements | Assign the right side of the zipper to this element. |
Out | zipperId | The ID of the new zipper. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Zipper assignment is manual
---
BwApiZipperDelete
Delete a zipper.
Python
BwApi.ZipperDelete(garmentId, zipperId)
C++
BwApiZipperDelete(garmentId, zipperId);
C#
BwApi.ZipperDelete(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | The ID of the zipper to delete. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperZippedRateGet
Get the zipped percentage rate of an exiting zipper
Python
BwApi.ZipperZippedRateGet(garmentId, zipperId)
C++
BwApiZipperZippedRateGet(garmentId, zipperId, zippedRate);
C#
BwApi.ZipperZippedRateGet(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Out | zippedRate | The zipped rate of a zipper of value between 0 and 100. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperZippedRateSet
Set the zipped percentage rate of an exiting zipper.
Python
BwApi.ZipperZippedRateSet(garmentId, zipperId, zippedRate)
C++
BwApiZipperZippedRateSet(garmentId, zipperId, zippedRate);
C#
BwApi.ZipperZippedRateSet(garmentId, zipperId, zippedRate);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
In | zippedRate | The zipped rate of a zipper of value between 0 and 100. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperWidthGet
Get a zipper's width.
Python
BwApi.ZipperWidthGet(garmentId, zipperId)
C++
BwApiZipperWidthGet(garmentId, zipperId, width);
C#
BwApi.ZipperWidthGet(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Out | width | The width of a zipper in cm. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperWidthSet
Set a zipper's width.
Python
BwApi.ZipperWidthSet(garmentId, zipperId, width)
C++
BwApiZipperWidthSet(garmentId, zipperId, width);
C#
BwApi.ZipperWidthSet(garmentId, zipperId, width);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
In | width | The zipped rate of a zipper in cm. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperDirectionInvert
Invert a zipper's direction (zipper / puller direction).
Python
BwApi.ZipperDirectionInvert(garmentId, zipperId)
C++
BwApiZipperDirectionInvert(garmentId, zipperId);
C#
BwApi.ZipperDirectionInvert(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperPositionInvert
Invert a zipper's position (On which side the stopper/puller is located).
Python
BwApi.ZipperPositionInvert(garmentId, zipperId)
C++
BwApiZipperPositionInvert(garmentId, zipperId);
C#
BwApi.ZipperPositionInvert(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperInsideGet
Check if the zipper is set to inside(0) or outside(1).
Python
BwApi.ZipperInsideGet(garmentId, zipperId)
C++
BwApiZipperInsideGet(garmentId, zipperId, outside);
C#
BwApi.ZipperInsideGet(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Out | outside | Boolean (1/0) if the given zipper ID is inside or not (0-inside , 1-outside). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperInsideSet
Set the zipper to inside(0) or outside(1).
Python
BwApi.ZipperInsideSet(garmentId, zipperId, inside)
C++
BwApiZipperInsideSet(garmentId, zipperId, inside);
C#
BwApi.ZipperInsideSet(garmentId, zipperId, inside);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
In | inside | 0 - zipper is inside, 1 - zipper is outside. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperLength
Get a zipper's length.
Python
BwApi.ZipperLength(garmentId, sizeId, zipperId)
C++
BwApiZipperLength(garmentId, sizeId, zipperId, length);
C#
BwApi.ZipperLength(garmentId, sizeId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | sizeId | Size of the garment. |
In | zipperId | Existing zipper ID. |
Out | length | The length of a zipper in cm. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperConnectedElementsSet
Set the connected elements of a zipper.
Python
BwApi.ZipperConnectedElementsSet(garmentId, zipperId, leftConnectedElements, rightConnectedElements)
C++
BwApiZipperConnectedElementsSet(garmentId, zipperId, leftConnectedElements, rightConnectedElements);
C#
BwApi.ZipperConnectedElementsSet(garmentId, zipperId, leftConnectedElements, rightConnectedElements);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
In | leftConnectedElements | The connected elements of the left side on the zipper. |
In | rightConnectedElements | The connected elements of the right side on the zipper. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperConnectedElements
Get a zipper's connected elements.
Python
BwApi.ZipperConnectedElements(garmentId, zipperId)
C++
BwApiZipperConnectedElements(garmentId, zipperId, leftConnectedElements, rightConnectedElements);
C#
BwApi.ZipperConnectedElements(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Out | leftConnectedElements | The connected elements of the left side on the zipper. |
Out | rightConnectedElements | The connected elements of the right side on the zipper. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperOneEdge
Check if a zipper is one edge side or not.
Python
BwApi.ZipperOneEdge(garmentId, zipperId)
C++
BwApiZipperOneEdge(garmentId, zipperId, oneSide);
C#
BwApi.ZipperOneEdge(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Out | oneSide | Boolean (1/0) if the given zipper ID is one edge side or not. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiZipperMaterialIdGet
Get the group material ID assigned to the zipper.
Python
BwApi.ZipperMaterialIdGet(garmentId, zipperId)
C++
BwApiZipperMaterialIdGet(garmentId, zipperId, materialId);
C#
BwApi.ZipperMaterialIdGet(garmentId, zipperId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
Out | materialId | Get the assigned material ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The material is from the current colorway.
---
BwApiZipperMaterialIdSet
Assign a group material ID to a zipper.
Python
BwApi.ZipperMaterialIdSet(garmentId, zipperId, materialId)
C++
BwApiZipperMaterialIdSet(garmentId, zipperId, materialId);
C#
BwApi.ZipperMaterialIdSet(garmentId, zipperId, materialId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | zipperId | Existing zipper ID. |
In | materialId | Material ID to assign. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: The material is from the current colorway.
---