Sweep

Sweep one or several faces along a spine curve into a solid 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 along a spine curve.

Use model.component(<ctag>).geom(<tag>).feature(<ftag>).selection("face") to select the faces to sweep.

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-161: Valid Property/Value Pairs for Sweep
Property	Values	Default	Description
adjustlen	double	0	Spine adjustment parameter length. Used when align is set to adjustspine.
align	noadjust \| adjustspine \| moveface	noadjust	Type of alignment between face and spine curve.
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.
diredge	Selection		Direction-defining edge.
edge	Selection		Edges that form spine curve.
face	Selection		Faces to sweep.
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.
maxknots	int	1000	Maximum number of knots.
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.
reversedir	on \| off	off	Reverse sweep direction.
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	boolean	true	Smooth edge connections.
twist	String	0	Twist angle for cross section.
twistcomp	on \| off	on	Twist compensation.

The expressions in scale and twist can contain functions defined in the model. If the definition of such a function is changed, the swept object is not automatically rebuilt. Use model.component(<ctag>).geom(<tag>).feature(<ftag>).importData() to rebuild the swept object after such a change.

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 face are considered completely used if they contain a single face. Objects used in edge are considered completely used if they contain no faces and 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-162: 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.