Share

SweepFeatures.CreateSolidSweepDefinition Method

Parent Object: SweepFeatures

Description

Method that creates the SolidSweepDefinition object.

Syntax

SweepFeatures.CreateSolidSweepDefinition( ToolBody As SurfaceBody, Path As Path, Operation As PartFeatureOperationEnum, AffectedBodies As ObjectCollection, [KeepToolbody] As Boolean ) As SolidSweepDefinition

Parameters

Name Type Description
ToolBody SurfaceBody Input SurfaceBody object indicates which surfacebody will be used as tool body to sweep.
Path Path Input entity that defines the path of the sweep. Use the CreatePath or CreateSpecifiedPath methods on the PartFeatures object to create a Path. The path can be a combination of 2D and 3D sketch elements and can be open or closed.
Operation PartFeatureOperationEnum Input constant that indicates the type of operation to perform. Valid input is kJoinOperation, kCutOperation, kIntersectOperation or kNewBodyOperation.
AffectedBodies ObjectCollection Input ObjectCollection object that specifies which surface bodies will be affected. When the Operation is set to kJoinOperation only one surface body should be specified, when the operation is set to kCutOperation or kIntersectOperation more than one surface bodies can be specified, when the operation is set to kNewBodyOperation an empty ObjectCollection should be provided. Anyway the ToolBody should not be provided in this argument.
KeepToolbody Boolean Optional input Boolean that specifies whether to keep the source tool body or not. This defaults to False if not provided.

This is an optional argument whose default value is False.

Version

Introduced in version 2020

Was this information helpful?