VS:TrimNurbsSurface

From Vectorworks Developer
Revision as of 06:24, 13 May 2018 by CBM-c- (talk | contribs) (Fix example, it was rising error due to var names not in sync, wikify)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix

Description

Trims the NURBS surface by a given NURBS curve.

FUNCTION TrimNurbsSurface(
surfaceHandle :HANDLE;
curveHandle :HANDLE) : BOOLEAN;
def vs.TrimNurbsSurface(surfaceHandle, curveHandle):
    return BOOLEAN

Parameters

surfaceHandle HANDLE Handle to a NURBS surface to trim.
curveHandle HANDLE Handle to a NURBS curve for trimming.

Return Value

Returns TRUE if trimmed the surface, otherwise returns FALSE.

Remarks

It returns true if the curve is attached to the surface as trimmed curve.

Example

PROCEDURE Example;
VAR
	surfaceH, curveH :HANDLE;
	bFlag :BOOLEAN;

BEGIN
	surfaceH:= CreateNurbsSurface(3, 3, 1, 1);
	NurbsSetPt3D(surfaceH, 0, 0, 0, 0, 0);
	NurbsSetPt3D(surfaceH, 0, 1, 1, 0, 0);
	NurbsSetPt3D(surfaceH, 0, 2, 2, 0, 0);
	NurbsSetPt3D(surfaceH, 1, 0, 0, 1, 0);
	NurbsSetPt3D(surfaceH, 1, 1, 1, 1, 1);
	NurbsSetPt3D(surfaceH, 1, 2, 2, 1, 0);
	NurbsSetPt3D(surfaceH, 2, 0, 0, 2, 0);
	NurbsSetPt3D(surfaceH, 2, 1, 1, 2, 0);
	NurbsSetPt3D(surfaceH, 2, 2, 2, 2, 0);

	curveH := CreateNurbsCurve(0, 0, 0, TRUE, 2);
	AddVertex3D(curveH, 1, 1, 0);
	AddVertex3D(curveH, 2, 0, 0);

	bFlag := TrimNurbsSurface(surfaceH, curveH);
END;
RUN(Example);

Version

Availability: from Vectorworks 2013

See Also

VS Functions:

VS:CreateNurbsSurface | VS:CreateNurbsCurve

VS Functions:

[[VS:CreateNurbsSurface]]

| [[VS:CreateNurbsCurve]]