Scripting: RemovePointFromPolygon

RemovePointFromPolygon

Introduced

v1.5

Description

Removes a point from the polygon being created.

Note: This command uses output arguments. C# and some scripting languages (such as JScript, PerlScript and Python) don't support arguments passed by reference so you need to use the best workaround for your situation:

For scripting languages this command returns an ISIVTCollection which you can use to get the output arguments.

For C# you can use the XSIApplication.ExecuteCommand method to call this command. ExecuteCommand packs the output arguments into a C# System.Object containing an Array of the output arguments (see Calling Commands from C#).

Scripting Syntax

RemovePointFromPolygon( InputObj, [PointID], [PolygonID] );

Parameters

Parameter	Type	Description
InputObj	String	Mesh holding the polygon being built
PointID	Long	ID of the vertex to remove in the current polygon being built Default Value: 0
PolygonID	Integer	New ID of the polygon since it is being rebuilt from scratch (-1 is returned if polygon has now less than 3 points)

Examples

VBScript Example

' Create a triangle
dim obj, poly
SIGetPrim "EmptyPolygonMesh", , , , obj
SelectObj obj
ApplyOp "CreatePolygon", obj, siUnspecified
AddPointToNewPolygon obj, -2.229, 2.713, 0.000
AddPointToNewPolygon obj, -3.140, -1.686, 0.000
AddPointToNewPolygon obj, 1.744, -2.345, 0.000, , poly
SelectObj obj & ".poly[" & poly & "]"