Skip to main content

InternalPoint

InternalPoint

This file contains the internal point functionality you can add internal points, remove internal points etc...

BwApiInternalPointAdd

Add an internal point to an existing shape.

Python

BwApi.InternalPointAdd(garmentId, shapeId, point)

C++

BwApiInternalPointAdd(garmentId, shapeId, point, newInternalPointId);

C#

BwApi.InternalPointAdd(garmentId, shapeId, point);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

shapeId

Existing shape ID.

In

point

Point to add.

Out

newInternalPointId

The newly created internal point ID.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiInternalPointRemove

Delete an internal point.

Python

BwApi.InternalPointRemove(garmentId, shapeId, internalPointId)

C++

BwApiInternalPointRemove(garmentId, shapeId, internalPointId);

C#

BwApi.InternalPointRemove(garmentId, shapeId, internalPointId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

shapeId

Existing shape ID.

In

internalPointId

The internal point ID to delete.

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiInternalPointIdsGet

Get a shape's internal point IDs.

Python

BwApi.InternalPointIdsGet(garmentId, shapeId)

C++

BwApiInternalPointIdsGet(garmentId, shapeId, internalPointIds);

C#

BwApi.InternalPointIdsGet(garmentId, shapeId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

shapeId

Existing shape ID.

Out

internalPointIds

Array of internal point IDs (see BwApiVectorInt).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiInternalPointGet

Get a shape's internal points (see BwApiPoint).

Python

BwApi.InternalPointGet(garmentId, shapeId, internalPointId)

C++

BwApiInternalPointGet(garmentId, shapeId, internalPointId, internalPoint);

C#

BwApi.InternalPointGet(garmentId, shapeId, internalPointId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

shapeId

Existing shape ID.

In

internalPointId

Existing internal point ID.

Out

internalPoint

Get the internal point data (see BwApiPoint).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiInternalPointSet

Get an internal point (see BwApiPoint).

Python

BwApi.InternalPointSet(garmentId, shapeId, internalPointId, internalPoint)

C++

BwApiInternalPointSet(garmentId, shapeId, internalPointId, internalPoint);

C#

BwApi.InternalPointSet(garmentId, shapeId, internalPointId, internalPoint);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

shapeId

Existing shape ID.

In

internalPointId

Existing internal point ID.

In

internalPoint

Set the internal point data (see BwApiPoint).

Returns: Error/success code (see BwApiErrorCodes enum).

---

BwApiInternalPointMirroredIdGet

Get an internal point's mirrored ID.

Python

BwApi.InternalPointMirroredIdGet(garmentId, shapeId, internalPointId)

C++

BwApiInternalPointMirroredIdGet(garmentId, shapeId, internalPointId, mirroredInternalPointId);

C#

BwApi.InternalPointMirroredIdGet(garmentId, shapeId, internalPointId);

Parameters

Param

Variable

Description

In

garmentId

Existing garment ID.

In

shapeId

Existing shape ID.

In

internalPointId

Existing internal point ID.

Out

mirroredInternalPointId

Mirrored internal point ID.

Returns: Error/success code (see BwApiErrorCodes enum).

Note: This function is only relevant on inner symmetry shapes.

---

Did this answer your question?