SweptBuilder Class¶
-
class
NXOpen.Features.SweptBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.SweptbuilderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateSweptBuilder()Default values.
Property Value AlignmentMethod.AlignType Parameter GuideRebuildData.Degree 3 GuideRebuildData.RebuildType None OrientationMethod.AngularLaw.EndValue.Value 0 (millimeters part), 0 (inches part) OrientationMethod.AngularLaw.Function ft OrientationMethod.AngularLaw.LawType Constant OrientationMethod.AngularLaw.Parameter t OrientationMethod.AngularLaw.StartValue.Value 0 (millimeters part), 0 (inches part) OrientationMethod.AngularLaw.Value.Value 0 (millimeters part), 0 (inches part) OrientationMethod.OrientationOption Fixed PreserveGuideShapeOption False PreserveShapeOption True ScalingMethod.AreaLaw.EndValue.Value 1.0 (millimeters part), 1.0 (inches part) ScalingMethod.AreaLaw.StartValue.Value 1.0 (millimeters part), 1.0 (inches part) ScalingMethod.AreaLaw.Value.Value 1.0 (millimeters part), 1.0 (inches part) ScalingMethod.BlendingFunctionType Linear ScalingMethod.EndBlendScaleFactor 1.0 ScalingMethod.PerimeterLaw.EndValue.Value 1.0 (millimeters part), 1.0 (inches part) ScalingMethod.PerimeterLaw.StartValue.Value 1.0 (millimeters part), 1.0 (inches part) ScalingMethod.PerimeterLaw.Value.Value 1.0 (millimeters part), 1.0 (inches part) ScalingMethod.ScaleFactor 1.0 ScalingMethod.ScalingOption Constant ScalingMethod.StartBlendScaleFactor 1.0 SectionRebuildData.Degree 3 SectionRebuildData.RebuildType None New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| AlignmentMethod | Returns the alignment method. |
| BodyPreference | Returns the body type options |
| G0Tolerance | Returns or sets the G0 (Position) tolerance. |
| G1Tolerance | Returns or sets the G1 (Tangent) tolerance. |
| GuideList | Returns the list of guides. |
| GuideRebuildData | Returns the guide rebuild data |
| InterpolationOption | Returns or sets the interpolation option. |
| OrientationMethod | Returns the orientation method. |
| 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 |
| PreserveGuideShapeOption | Returns or sets the preserve guide shape option. |
| PreserveShapeOption | Returns or sets the preserve shape option. |
| ScalingMethod | Returns the scaling method. |
| SectionList | Returns the list of sections. |
| SectionLocation | Returns or sets the section location option. |
| SectionRebuildData | Returns the section rebuild data |
| Spine | Returns the spine (optional). |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
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¶
| SweptBuilderInterpolationOptions Enumeration | This enum represents the Interpolation option. |
| SweptBuilderSectionLocationTypes Enumeration | This enum represents the Section Location option. |
Property Detail¶
AlignmentMethod¶
-
SweptBuilder.AlignmentMethod¶ Returns the alignment method.
The Alignment Method Builder sub-object, governs the alignment of the input sections along the guides. Alignment by Points is available only if more than 1 input sections are selected. Refer to GeometricUtilities.AlignmentMethodBuilder documentation.
-------------------------------------Getter Method
Signature
AlignmentMethodReturns: Return type: NXOpen.GeometricUtilities.AlignmentMethodBuilderNew in version NX5.0.0.
License requirements: None.
BodyPreference¶
-
SweptBuilder.BodyPreference¶ Returns the body type options
-------------------------------------Getter Method
Signature
BodyPreferenceReturns: Return type: NXOpen.GeometricUtilities.FeatureOptionsNew in version NX7.5.0.
License requirements: None.
G0Tolerance¶
-
SweptBuilder.G0Tolerance¶ Returns or sets the G0 (Position) tolerance.
-------------------------------------Getter Method
Signature
G0ToleranceReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
G0ToleranceParameters: g0Tolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
G1Tolerance¶
-
SweptBuilder.G1Tolerance¶ Returns or sets the G1 (Tangent) tolerance.
-------------------------------------Getter Method
Signature
G1ToleranceReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
G1ToleranceParameters: g1Tolerance (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
GuideList¶
-
SweptBuilder.GuideList¶ Returns the list of guides.
At least 1 but no more than 3 guides are required.
-------------------------------------Getter Method
Signature
GuideListReturns: Return type: NXOpen.SectionListNew in version NX5.0.0.
License requirements: None.
GuideRebuildData¶
-
SweptBuilder.GuideRebuildData¶ Returns the guide rebuild data
-------------------------------------Getter Method
Signature
GuideRebuildDataReturns: Exact class name unknown Return type: NXOpen.GeometricUtilities.RebuildNew in version NX5.0.0.
License requirements: None.
InterpolationOption¶
-
SweptBuilder.InterpolationOption¶ Returns or sets the interpolation option.
This option governs the method by which to interpolate between sections, if the section list contains more than 1 section.
-------------------------------------Getter Method
Signature
InterpolationOptionReturns: Return type: NXOpen.Features.SweptBuilderInterpolationOptionsNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
InterpolationOptionParameters: interpolationOption ( NXOpen.Features.SweptBuilderInterpolationOptions) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OrientationMethod¶
-
SweptBuilder.OrientationMethod¶ Returns the orientation method.
The Orientation Method Builder sub-object, governs the orientation of the input sections, if the guide list contains a single guide. Refer to GeometricUtilities.OrientationMethodBuilder documentation.
-------------------------------------Getter Method
Signature
OrientationMethodReturns: Return type: NXOpen.GeometricUtilities.OrientationMethodBuilderNew in version NX5.0.0.
License requirements: None.
PreserveGuideShapeOption¶
-
SweptBuilder.PreserveGuideShapeOption¶ Returns or sets the preserve guide shape option.
-------------------------------------Getter Method
Signature
PreserveGuideShapeOptionReturns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PreserveGuideShapeOptionParameters: preserveGuideShapeOption (bool) – New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PreserveShapeOption¶
-
SweptBuilder.PreserveShapeOption¶ Returns or sets the preserve shape option.
-------------------------------------Getter Method
Signature
PreserveShapeOptionReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PreserveShapeOptionParameters: preserveShapeOption (bool) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
ScalingMethod¶
-
SweptBuilder.ScalingMethod¶ Returns the scaling method.
The Scaling Method Builder sub-object, governs the size / scale of the input sections along a guide, if a single guide is selected. Refer to GeometricUtilities.ScalingMethodBuilder documentation.
-------------------------------------Getter Method
Signature
ScalingMethodReturns: Return type: NXOpen.GeometricUtilities.ScalingMethodBuilderNew in version NX5.0.0.
License requirements: None.
SectionList¶
-
SweptBuilder.SectionList¶ Returns the list of sections.
At least 1 section is required.
-------------------------------------Getter Method
Signature
SectionListReturns: Return type: NXOpen.SectionListNew in version NX5.0.0.
License requirements: None.
SectionLocation¶
-
SweptBuilder.SectionLocation¶ Returns or sets the section location option.
This option governs the location of the input section with respect to the guides. The section location option is ignored if the section list contains more than 1 section.
-------------------------------------Getter Method
Signature
SectionLocationReturns: Return type: NXOpen.Features.SweptBuilderSectionLocationTypesNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SectionLocationParameters: sectionLocation ( NXOpen.Features.SweptBuilderSectionLocationTypes) –New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SectionRebuildData¶
-
SweptBuilder.SectionRebuildData¶ Returns the section rebuild data
-------------------------------------Getter Method
Signature
SectionRebuildDataReturns: Exact class name unknown Return type: NXOpen.GeometricUtilities.RebuildNew in version NX5.0.0.
License requirements: None.
Spine¶
-
SweptBuilder.Spine¶ Returns the spine (optional).
For more than 1 guide, an optional spine curve can be input to gain further control of the orientation of the section string. The spine curve cannot contain more than 1 loop.
-------------------------------------Getter Method
Signature
SpineReturns: Return type: NXOpen.SectionNew in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SweptBuilder.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.