Skip to content

Latest commit

 

History

History
55 lines (48 loc) · 1.12 KB

AddHole.md

File metadata and controls

55 lines (48 loc) · 1.12 KB

AddHole

Description

AddHole uses a holeTemplate to create a hole inside objectToGetHole. Upon success, objectToGetHole is converted to polyline. holeTemplate is unchanged.

FUNCTION AddHole(
				VAR objectToGetHole : HANDLE;
				holeTemplate        : HANDLE): BOOLEAN;
def vs.AddHole(objectToGetHole, holeTemplate):
    return (BOOLEAN, objectToGetHole)

Parameters

Name Type Description
objectToGetHole HANDLE A 2D object to be cut by holeTemplate.
holeTemplate HANDLE A 2D object to cut a hole out of objectToGetHole.

Examples

VectorScript

PROCEDURE AddHoleExample;
VAR
h1, h2 :HANDLE;
BEGIN
CallTool(-204);
h1 := FSActLayer;
CallTool(-204);
h2 := FSActLayer;
IF AddHole(h1, h2) THEN SetFPat(h1, 3);
END;
RUN(AddHoleExample);

Python

def AddHoleExample():
	vs.CallTool(-204)
	h1 = vs.FSActLayer()
	if(h1 != none):
		vs.CallTool(-204)
		h2 = vs.FSActLayer()
		if vs.AddHole(h1, h2):
			vs.SetFPat(h1, 3)
AddHoleExample()

Version

Availability: from VectorWorks10.1

Category