SweptVolumeBuilder Class¶
-
class
NXOpen.Features.
SweptVolumeBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.SweptVolume
builderTo create a new instance of this class, use
NXOpen.Features.SweepFeatureCollection.CreateSweptVolumeBuilder()
Default values.
Property Value BooleanData.Type Subtract SweepOrientation ParallelToBody New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
BooleanData | Returns the boolean data |
DistanceTolerance | Returns or sets the Distance Tolerance |
ForcedDirection | Returns or sets the forced direction |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
ReferencePoint | Returns or sets the Reference point |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
SweepOrientation | Returns or sets the sweep orientation |
Tag | Returns the Tag for this object. |
ToolBody | Returns or sets the tool body |
ToolPath | Returns the tool path |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SweptVolumeBuilderSweepOrient Enumeration | These represent the type of Sweep Orientation feature to be created |
Property Detail¶
BooleanData¶
-
SweptVolumeBuilder.
BooleanData
¶ Returns the boolean data
-------------------------------------
Getter Method
Signature
BooleanData
Returns: Return type: NXOpen.GeometricUtilities.BooleanOperation
New in version NX11.0.0.
License requirements: None.
DistanceTolerance¶
-
SweptVolumeBuilder.
DistanceTolerance
¶ Returns or sets the Distance Tolerance
-------------------------------------
Getter Method
Signature
DistanceTolerance
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceTolerance
Parameters: distanceTolerance (float) – New in version NX11.0.0.
License requirements: None.
ForcedDirection¶
-
SweptVolumeBuilder.
ForcedDirection
¶ Returns or sets the forced direction
-------------------------------------
Getter Method
Signature
ForcedDirection
Returns: Return type: NXOpen.Direction
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ForcedDirection
Parameters: forcedDirection ( NXOpen.Direction
) –New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ReferencePoint¶
-
SweptVolumeBuilder.
ReferencePoint
¶ Returns or sets the Reference point
-------------------------------------
Getter Method
Signature
ReferencePoint
Returns: Return type: NXOpen.Point
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferencePoint
Parameters: referencePoint ( NXOpen.Point
) –New in version NX11.0.0.
License requirements: None.
SweepOrientation¶
-
SweptVolumeBuilder.
SweepOrientation
¶ Returns or sets the sweep orientation
-------------------------------------
Getter Method
Signature
SweepOrientation
Returns: Return type: NXOpen.Features.SweptVolumeBuilderSweepOrient
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SweepOrientation
Parameters: sweepOrientation ( NXOpen.Features.SweptVolumeBuilderSweepOrient
) –New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ToolBody¶
-
SweptVolumeBuilder.
ToolBody
¶ Returns or sets the tool body
-------------------------------------
Getter Method
Signature
ToolBody
Returns: Return type: NXOpen.ScCollector
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ToolBody
Parameters: toolBody ( NXOpen.ScCollector
) –New in version NX11.0.0.
License requirements: None.
ToolPath¶
-
SweptVolumeBuilder.
ToolPath
¶ Returns the tool path
-------------------------------------
Getter Method
Signature
ToolPath
Returns: Return type: NXOpen.Section
New in version NX11.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SweptVolumeBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.