Sweep

Sweep one or several faces, edges, or points along a spine curve into solids, surfaces, or curves in 3D.

Syntax

model.component(<ctag>).geom(<tag>).create(<ftag>,"Sweep");

model.component(<ctag>).geom(<tag>).feature(<ftag>).selection(property);

model.component(<ctag>).geom(<tag>).feature(<ftag>).set(property,<value>);

model.component(<ctag>).geom(<tag>).feature(<ftag>).getType(property);

model.component(<ctag>).geom(<tag>).feature(<ftag>).setAttribute(attribute,<value>);

model.component(<ctag>).geom(<tag>).feature(<ftag>).getAttribute(attribute);

Description

Use model.component(<ctag>).geom(<tag>).create(<ftag>,"Sweep") to sweep faces, edges, or points along a spine curve.

Use to the following methods to set the dimension of the entities to sweep and to select the entities:

model.component(<ctag>).geom(<tag>).feature(<ftag>).
selection("enttosweep").init(entDim);

model.component(<ctag>).geom(<tag>).feature(<ftag>).
selection("enttosweep").set(<objname>,entities);

Use model.component(<ctag>).geom(<tag>).feature(<ftag>).selection("edge") to select the edges to sweep along.

Use model.component(<ctag>).geom(<tag>).feature(<ftag>).selection("diredge") to select the edge whose direction defines the positive sweep direction. If this selection is empty, it is automatically set when the edge selection is set. The diredge selection can be empty if the edge selection contains a single edge.

The following properties are available:

Table 3-163: Valid Property/Value Pairs for Sweep.
Property	Values	Default	Description
adjustlen	double	0.1	Adjustment parameter length at start of spine. Only used if spineperpstart is on.
adjustlenend	double	0.1	Adjustment parameter length at end. Only used if spineperpend is on.
color	none \| custom \| integer between 1 and the number of colors in the current theme	none	The color of the selection, either given as an integer indicating a color in the color theme, or as a custom color in the customcolor property. Coloring is only available when selresult in active.
contributeto	String	none	Tag of cumulative selection to contribute to.
customcolor	RGB-triplet	Next available theme color	The color to use. Active when color is set to custom.
crossfaces	on \| off	off	Create cross-sectional faces. Only used if enttosweep has geometric entity level 2.
diredge	Selection		Direction-defining edge.
edge	Selection		Edges that form spine curve of the sweep.
enttomatch	Selection		Entities to match (with level 2, 1, or 0). Only used if spineperpend is on.
enttosweep	Selection		Entities to sweep (supported levels 2, 1, or 0).
grep	bezier \| spline	spline	Geometry representation.
includefinal	on \| off	off	Include all used input objects in Finalize operation.
keep	on \| off	on	Keep input objects.
manualdir	on \| off	on	Manual control of sweep direction.
matchvertices	on \| off	off	Add twisting and scaling to match vertices.
maxknots	int	1000	Maximum number of knots.
movetospine	on \| off	off	Move entities to sweep to spine start and match work plane coordinate system with spine.
parameterization	arclength \| normalizedarclength \| internal	arclength	Parameterization of the spine curve: arc length, normalized arc length, or the internal parameterization in the geometry’s data structures.
parname	String	s	Parameter name.
projvector	String[]	{0,0,1}	The vector to follow when controlling the twisting of the cross section. Only used if twisting is projvector.
propagatesel	on \| off	on	Propagate selections from input objects to resulting objects.
reversedir	on \| off	off	Reverse sweep direction. Only used if manualdir is on.
rtol	double	1e-4	Relative tolerance.
scale	String	1	Scale factor for cross section.
selresult	on \| off	off	Create selections of all resulting objects.
selresultshow	all \| obj \| dom \| bnd \| edg \| pnt \| off	dom	Show selections, if selresult is on, of resulting objects in physics, materials, and so on, or in part instances. obj is not available in a component’s geometry. dom, bnd, and edg are not available in all features.
smooth	on \| off	on	Smooth edge connections.
spineperpend	on \| off	off	Make spine perpendicular to entities to match at end of spine curve.
spineperpstart	on \| off	off	Make spine perpendicular to entities to sweep at start of spine curve.
twist	String	0	Twist angle for cross section.
twisting	none \| projvector \| curvature	none	Select how the twisting of cross section is done.
vertexinenttosweep	Selection		Vertex in entity to sweep. Only used if matchvertices is on.
vertextomatch	Selection		Vertex to match at end. Only used if matchvertices is on.

If includefinal is off, input objects are automatically removed in the Finalize (Form Union/Assembly) operation if they are completely used by this feature. Objects used in enttosweep are considered completely used if all of their entities of the selected dimension (2, 1, or 0) are included in enttosweep. Objects used in edge are considered completely used if all their edges are included in edge. If an object is considered completely used by one property but not completely used by another property, the object is not removed in the Finalize operation. If includefinal is on, input objects are not removed in the Finalize operation.

For information about the selresult and contributeto properties, see Selections of Geometric Entities.

The following attributes are available:

Table 3-164: Valid attributes
Name	Value	Default	Description
construction	on \| off \| inherit	inherit	Designate the resulting objects as construction geometry. Use inherit to set the construction geometry attribute only if all input objects are construction geometry.