Pleat
This file contains the pleat functionality you can create /delete a pleat, set a pleat's transformation etc...
BwApiPleatCreate
Creates a new pleat.
Python
BwApi.PleatCreate(garmentId, shapeId, type, edgeId, marker)
C++
BwApiPleatCreate(garmentId, shapeId, type, edgeId, marker, newPleatId);
C#
BwApi.PleatCreate(garmentId, shapeId, type, edgeId, marker);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | type | Pleat type (see BwApiPleatType enum). |
In | edgeId | The edge ID to add pleat to. |
In | marker | Marker on the edge (percenteage 0-100). |
Out | newPleatId | The newly created pleat ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatDelete
Deletes a pleat.
Python
BwApi.PleatDelete(garmentId, shapeId, pleatId)
C++
BwApiPleatDelete(garmentId, shapeId, pleatId);
C#
BwApi.PleatDelete(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to delete. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatIds
Gets all the pleat IDs within the specified shape ID.
Python
BwApi.PleatIds(garmentId, shapeId)
C++
BwApiPleatIds(garmentId, shapeId, pleatIds);
C#
BwApi.PleatIds(garmentId, shapeId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
Out | pleatIds | Array of integer containing the pleat IDs. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatTypeGet
Get a pleat's type.
Python
BwApi.PleatTypeGet(garmentId, shapeId, pleatId)
C++
BwApiPleatTypeGet(garmentId, shapeId, pleatId, type);
C#
BwApi.PleatTypeGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
Out | type | Get the type of the pleat (see BwApiPleatTyp enum). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatTypeSet
Set a pleat's type.
Python
BwApi.PleatTypeSet(garmentId, shapeId, pleatId, type)
C++
BwApiPleatTypeSet(garmentId, shapeId, pleatId, type);
C#
BwApi.PleatTypeSet(garmentId, shapeId, pleatId, type);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
In | type | Set the type of the pleat. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatLocationGet
Get a pleat's location.
Python
BwApi.PleatLocationGet(garmentId, shapeId, pleatId)
C++
BwApiPleatLocationGet(garmentId, shapeId, pleatId, edgeId, marker);
C#
BwApi.PleatLocationGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
Out | edgeId | Top edge ID for this pleat. |
Out | marker | Pleat's location on the edge (0-100). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatLocationSet
Set a pleat's location.
Python
BwApi.PleatLocationSet(garmentId, shapeId, pleatId, edgeId, marker)
C++
BwApiPleatLocationSet(garmentId, shapeId, pleatId, edgeId, marker);
C#
BwApi.PleatLocationSet(garmentId, shapeId, pleatId, edgeId, marker);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
In | edgeId | Top edge ID for this pleat. |
In | marker | Pleat's location on the edge (0-100). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatVertexPositionGet
Get an open pleat's vertex position, this function will return an error if the pleatId type is knife pleat.
Python
BwApi.PleatVertexPositionGet(garmentId, shapeId, pleatId)
C++
BwApiPleatVertexPositionGet(garmentId, shapeId, pleatId, vertexPos);
C#
BwApi.PleatVertexPositionGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
Out | vertexPos | Pleat's vertex position (see BwApiCoordinatesXY). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatVertexPositionSet
Set an open pleat's vertex position. This function will return an error if the pleatId type is knife pleat.
Python
BwApi.PleatVertexPositionSet(garmentId, shapeId, pleatId)
C++
BwApiPleatVertexPositionSet(garmentId, shapeId, pleatId, vertexPos);
C#
BwApi.PleatVertexPositionSet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
Out | vertexPos | Pleat's vertex position (see BwApiCoordinatesXY). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatTransformationGet
Get a pleat's transformation (width, depth etc...).
Python
BwApi.PleatTransformationGet(garmentId, shapeId, pleatId)
C++
BwApiPleatTransformationGet(garmentId, shapeId, pleatId, transformation);
C#
BwApi.PleatTransformationGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
Out | transformation | Pleat's transformation (see BwApiPleatTransformation). |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatTransformationSet
Set a pleat's transformation (width start, width end, depth etc...).
Python
BwApi.PleatTransformationSet(garmentId, shapeId, pleatId, transformation)
C++
BwApiPleatTransformationSet(garmentId, shapeId, pleatId, transformation);
C#
BwApi.PleatTransformationSet(garmentId, shapeId, pleatId, transformation);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
In | transformation | Pleat's transformation (see BwApiPleatTransformation). |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Since this function updates all the pleat's transformation properties at once please first call BwApiPleatTransformationGet to get the current values, update the relevant properties and then call BwApiPleatTransformationSet.
---
BwApiPleatStitchLengthGet
Get a pleat's stitch length.
Python
BwApi.PleatStitchLengthGet(garmentId, shapeId, pleatId, stitchLength)
C++
BwApiPleatStitchLengthGet(garmentId, shapeId, pleatId, stitchLength);
C#
BwApi.PleatStitchLengthGet(garmentId, shapeId, pleatId, stitchLength);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
In | stitchLength | Stitch length. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatStitchLengthSet
Set a pleat's stitch length.
Python
BwApi.PleatStitchLengthSet(garmentId, shapeId, pleatId, stitchLength)
C++
BwApiPleatStitchLengthSet(garmentId, shapeId, pleatId, stitchLength);
C#
BwApi.PleatStitchLengthSet(garmentId, shapeId, pleatId, stitchLength);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
In | stitchLength | Stitch length. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatDartGet
Check if a pleat is a dart(1) (fully stitched) or not(0).
Python
BwApi.PleatDartGet(garmentId, shapeId, pleatId)
C++
BwApiPleatDartGet(garmentId, shapeId, pleatId, dart);
C#
BwApi.PleatDartGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to use. |
Out | dart | 1 - pleat is dart, 0 - not dart. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatDartSet
Set if a pleat is dart(1) (fully stitched) or not(0).
Python
BwApi.PleatDartSet(garmentId, shapeId, pleatId, dart)
C++
BwApiPleatDartSet(garmentId, shapeId, pleatId, dart);
C#
BwApi.PleatDartSet(garmentId, shapeId, pleatId, dart);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to use. |
In | dart | 1 - pleat is dart, 0 - not dart. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: Only an open pleat can be defined as a dart, calling this function with a knife pleat will return an error.
---
BwApiPleatFlippedGet
Check if a pleat fold direction is flipped(1) or not(0).
Python
BwApi.PleatFlippedGet(garmentId, shapeId, pleatId)
C++
BwApiPleatFlippedGet(garmentId, shapeId, pleatId, flipped);
C#
BwApi.PleatFlippedGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to use. |
Out | flipped | 1 - direction is flipped, 0 - not flipped. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatFlippedSet
Set if a pleat fold direction is flipped(1) or not(0).
Python
BwApi.PleatFlippedSet(garmentId, shapeId, pleatId, flipped)
C++
BwApiPleatFlippedSet(garmentId, shapeId, pleatId, flipped);
C#
BwApi.PleatFlippedSet(garmentId, shapeId, pleatId, flipped);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to use. |
In | flipped | 1 - pleat is flipped, 0 not flipped. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatIronedGet
Check if a pleat is ironed(1) or not(0).
Python
BwApi.PleatIronedGet(garmentId, shapeId, pleatId, ironed)
C++
BwApiPleatIronedGet(garmentId, shapeId, pleatId, ironed);
C#
BwApi.PleatIronedGet(garmentId, shapeId, pleatId, ironed);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to use. |
In | ironed | 1 - ironed, 0 not ironed. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatIronedSet
Set if a pleat is ironed(1) or not(0).
Python
BwApi.PleatIronedSet(garmentId, shapeId, pleatId, ironed)
C++
BwApiPleatIronedSet(garmentId, shapeId, pleatId, ironed);
C#
BwApi.PleatIronedSet(garmentId, shapeId, pleatId, ironed);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Pleat ID to use. |
In | ironed | 1 - ironed, 0 not ironed. |
Returns: Error/success code (see BwApiErrorCodes enum).
---
BwApiPleatMirroredIdGet
Get a pleat's mirrored pleat ID.
Python
BwApi.PleatMirroredIdGet(garmentId, shapeId, pleatId)
C++
BwApiPleatMirroredIdGet(garmentId, shapeId, pleatId, mirroredPleatId);
C#
BwApi.PleatMirroredIdGet(garmentId, shapeId, pleatId);
Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID. |
In | shapeId | Existing shape ID. |
In | pleatId | Existing pleat ID. |
Out | mirroredPleatId | Mirrored pleat ID. |
Returns: Error/success code (see BwApiErrorCodes enum).
Note: This function is only relevant for inner symmetry shapes.
---