VS:BeginSweep

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

Description

Procedure BeginSweep creates a three-dimensional sweep object in the VectorWorks document. A sweep object is a two-dimensional template object which has been rotated about a specified point to create a 3D object. For example, a circle of radius 1" that is swept about a point 2" to the right of the circles center wil create a sweep object resembling a donut, also known as a torus.

The sweep increment may also be thought of as the spacing between the duplication of radial sweep mesh lines. The "pitch", or vertical distance, is the distance that the sweep object will travel for every 360 degrees of rotation. In sweep objects, the 2D template object may also be translated as it rotates, resulting in a "corkscrew" effect. The vertical movement is determined by the following equation: vertical movement = pitch * ArcAngle/360.

2D Object "Template" for Sweep

Sweep Object

PROCEDURE BeginSweep(
           startAngle      :REAL;
           arcAngle        :REAL;
           incAngle        :REAL;
           PitchDistance   :REAL);

def vs.BeginSweep(startAngle, arcAngle, incAngle, PitchDistance):
    return None

Parameters

startAngle	REAL	Starting angle of the sweep.
arcAngle	REAL	Angle of sweep.
incAngle	REAL	Increment of sweep.
PitchDistance	REAL	Pitch (translation distance) of sweep.

Example

VectorScript

BeginSweep(#0d,#360d,#10d,0');
Poly(3 1/4",-1/2",
3 1/4",-1",
2 3/4",-1",
2 1/4",-1/2",
2 1/4",1",
1 3/4",1 1/2",
-1 3/4",1 1/2",
-2 1/4",1",
-2 1/4",-1/2",
-2 3/4",-1",
-3 1/4",-1",
-3 1/4",-1/2",
-2 3/4",0",
-2 3/4",1 1/2",
-2 1/4",2",
2 1/4",2",
2 3/4",1 1/2",
2 3/4",0");
EndSweep;

Python

vs.BeginSweep(0,360,10,0)
vs.Poly(3 + 1/4,-1/2,
3 + 1/4,-1,
2 + 3/4,-1,
2 + 1/4,-1/2,
2 + 1/4,1,
1 + 3/4,1 + 1/2,
-1+ 3/4,1 + 1/2,
-2+ 1/4,1,
-2+ 1/4,-1/2,
-2+ 3/4,-1,
-3+ 1/4,-1,
-3+ 1/4,-1/2,
-2+ 3/4,0,
-2+ 3/4,1 + 1/2,
-2+ 1/4,2,
2 + 1/4,2,
2 + 3/4,1 + 1/2,
2 + 3/4,0)
vs.EndSweep()

Version

Availability: from All Versions