StyledSweepBuilder Class¶

class NXOpen.Features.StyledSweepBuilder¶

Bases: NXOpen.Features.FeatureBuilder

Represents a NXOpen.Features.StyledSweep builder

To create a new instance of this class, use NXOpen.Features.FeatureCollection.CreateStyledSweepBuilder()

Default values.

Property	Value
FixedStringOption	Guide
GuideRebuildData.Degree	3
GuideRebuildData.RebuildType	None
ReferenceMethod.ReferenceOption	ToGuide
ScalingMethodOption	Uniform
SectionOrientationOption	KeepAngle
SectionRebuildData.Degree	3
SectionRebuildData.RebuildType	None
SurfaceRange.AnchorPosition	Vertex1
TransitionOption	Blend

New in version NX6.0.0.

Properties¶

Property	Description
AlternateSolution	Returns or sets the alternate solution.
FirstGuide	Returns the first guide
FixedStringOption	Returns or sets the fixed string option
G0Tolerance	Returns or sets the G0 (Position) tolerance.
G1Tolerance	Returns or sets the G1 (Tangent) tolerance.
GuideRebuildData	Returns the guide rebuild data
InsertedSectionList	Returns the list of inserted sections
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
PivotSetList	Returns the list of pivot sets
ReferenceMethod	Returns the reference method
RotationSetList	Returns the list of rotation sets
ScalingCurve	Returns the scaling curve
ScalingMethodOption	Returns or sets the scaling method option
ScalingSetList	Returns the list of scaling sets
SecondGuide	Returns the second guide
SectionList	Returns the list of sections.
SectionOrientationOption	Returns or sets the section orientation option
SectionRebuildData	Returns the section rebuild data
SurfaceRange	Returns the surface range
SurroundingPatchSurfaceFilename	Returns or sets the surrounding patch surface filename
Tag	Returns the Tag for this object.
TransitionOption	Returns or sets the transition option
Type	Returns or sets the sweep type

Methods¶

Method	Description
Commit	Commits any edits that have been applied to the builder.
CommitFeature	Commits the feature parameters and creates the feature
CreatePivotSet	Creates a new pivot set
CreateRotationSet	Creates a new rotation set
CreateScalingSet	Creates a new scaling set
Destroy	Deletes the builder, and cleans up any objects created by the builder.
EndInsertingSection	Ends inserting section.
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.
StartInsertingSection	Starts inserting section.
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¶

StyledSweepBuilderFixedStringOptions Enumeration	This enum represents the Fixed String option
StyledSweepBuilderScalingMethodOptions Enumeration	This enum represents the Scaling Method option
StyledSweepBuilderSectionOrientationOptions Enumeration	This enum represents the Section Orientation option
StyledSweepBuilderTransitionOptions Enumeration	This enum represents the Transition option
StyledSweepBuilderTypes Enumeration	This enum represents the sweep type option (Number of Guides)

Property Detail¶

AlternateSolution¶

StyledSweepBuilder.AlternateSolution¶

Returns or sets the alternate solution.

This property can be used only when Type is being set to 1 Guide/1 Guide 1 Touch/1 Guide 1 Orientation and orientation method is set to user_defined. For now, alternateSolution = 1, means automatically initial orientation, = 0, means no

-------------------------------------

Getter Method

Signature AlternateSolution

Returns:
Return type:	int

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AlternateSolution

Parameters:	alternateSolution (int) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

FirstGuide¶

StyledSweepBuilder.FirstGuide¶

Returns the first guide

-------------------------------------

Getter Method

Signature FirstGuide

Returns:
Return type:	`NXOpen.Section`

New in version NX6.0.0.

License requirements: None.

FixedStringOption¶

StyledSweepBuilder.FixedStringOption¶

Returns or sets the fixed string option

-------------------------------------

Getter Method

Signature FixedStringOption

Returns:
Return type:	`NXOpen.Features.StyledSweepBuilderFixedStringOptions`

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FixedStringOption

Parameters:	fixedStringOption (`NXOpen.Features.StyledSweepBuilderFixedStringOptions`) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

G0Tolerance¶

StyledSweepBuilder.G0Tolerance¶

Returns or sets the G0 (Position) tolerance.

-------------------------------------

Getter Method

Signature G0Tolerance

Returns:
Return type:	float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature G0Tolerance

Parameters:	g0Tolerance (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

G1Tolerance¶

StyledSweepBuilder.G1Tolerance¶

Returns or sets the G1 (Tangent) tolerance.

-------------------------------------

Getter Method

Signature G1Tolerance

Returns:
Return type:	float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature G1Tolerance

Parameters:	g1Tolerance (float) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

GuideRebuildData¶

StyledSweepBuilder.GuideRebuildData¶

Returns the guide rebuild data

-------------------------------------

Getter Method

Signature GuideRebuildData

Returns:	Exact class name unknown
Return type:	`NXOpen.GeometricUtilities.Rebuild`

New in version NX6.0.0.

License requirements: None.

InsertedSectionList¶

StyledSweepBuilder.InsertedSectionList¶

Returns the list of inserted sections

-------------------------------------

Getter Method

Signature InsertedSectionList

Returns:
Return type:	`NXOpen.SectionList`

New in version NX6.0.0.

License requirements: None.

PivotSetList¶

StyledSweepBuilder.PivotSetList¶

Returns the list of pivot sets

-------------------------------------

Getter Method

Signature PivotSetList

Returns:
Return type:	`NXOpen.GeometricUtilities.StyledSweepDoubleOnPathDimBuilderList`

New in version NX6.0.0.

License requirements: None.

ReferenceMethod¶

StyledSweepBuilder.ReferenceMethod¶

Returns the reference method

-------------------------------------

Getter Method

Signature ReferenceMethod

Returns:
Return type:	`NXOpen.GeometricUtilities.StyledSweepReferenceMethodBuilder`

New in version NX6.0.0.

License requirements: None.

RotationSetList¶

StyledSweepBuilder.RotationSetList¶

Returns the list of rotation sets

-------------------------------------

Getter Method

Signature RotationSetList

Returns:
Return type:	`NXOpen.GeometricUtilities.RotationSetBuilderList`

New in version NX6.0.0.

License requirements: None.

ScalingCurve¶

StyledSweepBuilder.ScalingCurve¶

Returns the scaling curve

-------------------------------------

Getter Method

Signature ScalingCurve

Returns:
Return type:	`NXOpen.Section`

New in version NX6.0.0.

License requirements: None.

ScalingMethodOption¶

StyledSweepBuilder.ScalingMethodOption¶

Returns or sets the scaling method option

-------------------------------------

Getter Method

Signature ScalingMethodOption

Returns:
Return type:	`NXOpen.Features.StyledSweepBuilderScalingMethodOptions`

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ScalingMethodOption

Parameters:	scalingMethodOption (`NXOpen.Features.StyledSweepBuilderScalingMethodOptions`) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

ScalingSetList¶

StyledSweepBuilder.ScalingSetList¶

Returns the list of scaling sets

-------------------------------------

Getter Method

Signature ScalingSetList

Returns:
Return type:	`NXOpen.GeometricUtilities.ScalingSetBuilderList`

New in version NX6.0.0.

License requirements: None.

SecondGuide¶

StyledSweepBuilder.SecondGuide¶

Returns the second guide

-------------------------------------

Getter Method

Signature SecondGuide

Returns:
Return type:	`NXOpen.Section`

New in version NX6.0.0.

License requirements: None.

SectionList¶

StyledSweepBuilder.SectionList¶

Returns the list of sections.

At least 1 section is required.

-------------------------------------

Getter Method

Signature SectionList

Returns:
Return type:	`NXOpen.SectionList`

New in version NX6.0.0.

License requirements: None.

SectionOrientationOption¶

StyledSweepBuilder.SectionOrientationOption¶

Returns or sets the section orientation option

-------------------------------------

Getter Method

Signature SectionOrientationOption

Returns:
Return type:	`NXOpen.Features.StyledSweepBuilderSectionOrientationOptions`

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SectionOrientationOption

Parameters:	sectionOrientationOption (`NXOpen.Features.StyledSweepBuilderSectionOrientationOptions`) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

SectionRebuildData¶

StyledSweepBuilder.SectionRebuildData¶

Returns the section rebuild data

-------------------------------------

Getter Method

Signature SectionRebuildData

Returns:	Exact class name unknown
Return type:	`NXOpen.GeometricUtilities.Rebuild`

New in version NX6.0.0.

License requirements: None.

SurfaceRange¶

StyledSweepBuilder.SurfaceRange¶

Returns the surface range

-------------------------------------

Getter Method

Signature SurfaceRange

Returns:
Return type:	`NXOpen.GeometricUtilities.SurfaceRangeBuilder`

New in version NX6.0.0.

License requirements: None.

TransitionOption¶

StyledSweepBuilder.TransitionOption¶

Returns or sets the transition option

-------------------------------------

Getter Method

Signature TransitionOption

Returns:
Return type:	`NXOpen.Features.StyledSweepBuilderTransitionOptions`

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TransitionOption

Parameters:	transitionOption (`NXOpen.Features.StyledSweepBuilderTransitionOptions`) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

Type¶

StyledSweepBuilder.Type¶

Returns or sets the sweep type

-------------------------------------

Getter Method

Signature Type

Returns:
Return type:	`NXOpen.Features.StyledSweepBuilderTypes`

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Type

Parameters:	type (`NXOpen.Features.StyledSweepBuilderTypes`) –

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

Method Detail¶

CreatePivotSet¶

StyledSweepBuilder.CreatePivotSet¶

Creates a new pivot set

Signature CreatePivotSet(value1, value2, path1, path2)

Parameters:	value1 (float) – Point on section value2 (float) – Point on guide path1 (`NXOpen.Curve`) – The path of point on section path2 (`NXOpen.Curve`) – The path of point on guide
Returns:	StyledSweepDoubleOnPathDimBuilder Object
Return type:	`NXOpen.GeometricUtilities.StyledSweepDoubleOnPathDimBuilder`

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

CreateRotationSet¶

StyledSweepBuilder.CreateRotationSet¶

Creates a new rotation set

Signature CreateRotationSet(value, pathPar, path)

Parameters:	value (float) – Rotation angle pathPar (float) – Rotation position path (`NXOpen.Curve`) – The path of on path dim
Returns:	RotationSetBuilder Object
Return type:	`NXOpen.GeometricUtilities.RotationSetBuilder`

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

CreateScalingSet¶

StyledSweepBuilder.CreateScalingSet¶

Creates a new scaling set

Signature CreateScalingSet(valuePar, depthPar, pathPar, path)

Parameters:	valuePar (float) – Scaling value depthPar (float) – Depth value pathPar (float) – Depth position path (`NXOpen.Curve`) – The path of on path dim
Returns:	ScalingSetBuilder Object
Return type:	`NXOpen.GeometricUtilities.ScalingSetBuilder`

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

EndInsertingSection¶

StyledSweepBuilder.EndInsertingSection¶

Ends inserting section.

The client should call this API whenever he finishes inserting a section.

Signature EndInsertingSection()

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

StartInsertingSection¶

StyledSweepBuilder.StartInsertingSection¶

Starts inserting section.

The client should call this API whenever he starts inserting a section. According to the insert point, the application automatically computes the closed point on the current surface, then extracts an iso curve to create a UG curve and add this curve into the section. Note: After the client calls this API, he needs to create a pivot set, a rotation set, a scaling set and a Section in turn, then he needs to insert them to the corresponding set list separately.

Signature StartInsertingSection(insertPnt)

Parameters:	insertPnt (list of float) – Insert point - the point on guide curve is better

New in version NX6.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR studio_free_form (“STUDIO FREE FORM”)

Validate¶

StyledSweepBuilder.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.

StyledSweepBuilder Class¶

Properties¶

Methods¶

Enumerations¶

Property Detail¶

AlternateSolution¶

FirstGuide¶

FixedStringOption¶

G0Tolerance¶

G1Tolerance¶

GuideRebuildData¶

InsertedSectionList¶

PivotSetList¶

ReferenceMethod¶

RotationSetList¶

ScalingCurve¶

ScalingMethodOption¶

ScalingSetList¶

SecondGuide¶

SectionList¶

SectionOrientationOption¶

SectionRebuildData¶

SurfaceRange¶

TransitionOption¶

Type¶

Method Detail¶

CreatePivotSet¶

CreateRotationSet¶

CreateScalingSet¶

EndInsertingSection¶

StartInsertingSection¶

Validate¶

NXOpen Python API Reference

Navigation

Related Topics