Point of Measurements
Point of Measurements or Ruler is how you measure the width or length of a garment. Use the Ruler API to create a ruler, get all ruler IDs in a garment, get a ruler name, get a ruler length, and so on.
For more information about the feature, please visit here.
To learn more about the rest of the API, please refer to Ruler in the repository.
Creating a Ruler
Code Snippet
Python C++ C#
Python
garment_id = BwApi.GarmentId() elements = [BwApi.Element(1, -1, 0, 3, -1), BwApi.Element(1, -1, 0, 4, -1)] ruler_id = BwApi.RulerCreate(garment_id, 'new_ruler', elements)
C++
BwApiString* garmentId;
BwApiGarmentId(garmentId);
BwApiVectorElement* elements = BwApiVectorElementCreate();
BwApiElement element1 = { 1, -1, 0, 3, -1 };
BwApiElement element2 = { 1, -1, 0, 4, -1 };
BwApiVectorElementInsert(elements, 0, element1);
BwApiVectorElementInsert(elements, 1, element2);int rulerId;
BwApiRulerCreate(BwApiStringGet(garmentId), "new_ruler", elements, &rulerId);C#
Element element1 = new Element(); element1.shapeId = 1; element1.pointId = -1; element1.cross = 0; element1.lineId = 3; element1.edgeId = -1;Element element2 = new Element(); element1.shapeId = 1; element1.pointId = -1; element1.cross = 0; element1.lineId = 4; element1.edgeId = -1;elements.Insert(0, element1); elements.Insert(1, element2);int rulerId; BwApi.RulerCreate(garmentId, "new ruler", elements, out rulerId);
Result
Getting Ruler IDs
Code Snippet
Python C++ C#
Python
garment_id= BwApi.GarmentId() rulerIds = BwApi.RulerIds(garment_id)
C++
BwString garmentId; BwApiGarmentId(garmentId); BwApiRulerIds(garmentId);
C#
string garmentId; BwApi.GarmentId(out garmentId); BwApi.RulerIds(out garmentId);
Result
List of all ruler IDs.
Getting a Ruler name
Code Snippet
Python C++ C#
Python
garment_id = BwApi.GarmentId() ruler_name = BwApi.RulerNameGet(garment_id, ruler_id)
C++
BwString garmentId; BwApiGarmentId(garmentId); BwApiString* rulerName; BwApiRulerNameGet(BwApiStringGet(garmentId), rulerId, rulerName);
C#
BwString garmentId; string rulerName; BwApi.RulerNameGet(garmentId, rulerId, out rulerName);
Result
The name of the Ruler for the given ruler ID.
Getting the Length of a Ruler
Code Snippet
Python C++ C#
Python
garment_id = BwApi.GarmentId() size_id = BwApi.SizeCurrentGet(garment_id) ruler_length = BwApi.RulerLengthGet(garment_id, ruler_id, size_id)
C++
BwString garmentId; BwApiGarmentId(garmentId); BwApiString* rulerName; int sizeId; BwApiSizeCurrentGet(BwApiStringGet(garmentId), &sizeId); float length; BwApiRulerLengthGet(BwApiStringGet(garmentId), rulerId, sizeId, &length);
C#
BwString garmentId; int sizeId; BwApi.SizeCurrentGet(garmentId, out sizeId);float length; BwApi.RulerLengthGet(garmentId, rulerId, sizeId, out length);
Result
The total length of the Ruler.