Skip to content

Latest commit

 

History

History
70 lines (58 loc) · 1.42 KB

ClipSurface.md

File metadata and controls

70 lines (58 loc) · 1.42 KB

ClipSurface

Description

Creates a new surface object by subtracting the intersection of surfaces s1 and s2 from s1.

PROCEDURE ClipSurface(
				s1 : HANDLE;
				s2 : HANDLE);
def vs.ClipSurface(s1, s2):
    return None

Parameters

Name Type Description
s1 HANDLE Handle to object.
s2 HANDLE Handle to object.

Remarks

ClipSurface is not reliable if the smaller poly is not fully contained within the larger one.

Note that in the above example, PrevObj(h2); was used to get a handle to the clipped surface. Also note that checking the validity of this handle and possibly even its object type (polyline) or comparing it to the object being clipped (IF h3 <> h1), is necessary to check that the clipping operation was successful.

Examples

==== VectorScript ====

PROCEDURE ClipSurfaceExample;
VAR
h1, h2, h3 :HANDLE;
BEGIN
DSelectAll;
CallTool(-203);
h1 := FSActLayer;
DSelectAll;
CallTool(-203);
h2 := FSActLayer;
ClipSurface(h1, h2);
h3 := PrevObj(h2);
IF h3 &lt;&gt; h1 THEN SetFPat(h3, 5);
END;
RUN(ClipSurfaceExample);

==== Python ====

def ClipSurfaceExample():
	vs.DSelectAll()
	vs.CallTool(-203)
	h1 = vs.FSActLayer()
	vs.DSelectAll()
	vs.CallTool(-203)
	h2 = vs.FSActLayer()
	vs.ClipSurface(h1, h2)
	h3 = vs.PrevObj(h2)
	if h3 != h1:
		vs.SetFPat(h3, 5)
ClipSurfaceExample()

Version

Availability: from VectorWorks8.5

Category

  • Objects - 2D