StudioSurfaceBuilder Class¶
-
class
NXOpen.Features.
StudioSurfaceBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.StudioSurface
builderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateStudioSurfaceBuilder()
Default values.
Property Value Transition NormalToEndSections New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
AlignmentMethod | Returns the alignment method |
BodyPreference | Returns the body type options |
CurvatureTolerance | Returns or sets the curvature tolerance |
FirstGuideContinuity | Returns the first guide continuity |
FirstSectionContinuity | Returns the first section continuity |
FlowDirection | Returns the flow direction |
GuideList | Returns the list of guides |
GuideRebuild | Returns the guide rebuild |
IntersectionTolerance | Returns or sets the intersection tolerance |
LastGuideContinuity | Returns the last guide continuity |
LastSectionContinuity | Returns the last section continuity |
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 |
PositionTolerance | Returns or sets the position tolerance |
SectionList | Returns the list of sections |
SectionRebuild | Returns the section rebuild |
SplitOutputAlongBoundaryCurves | Returns or sets the split output along boundary curves option |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TangentTolerance | Returns or sets the tangent tolerance |
Transition | Returns or sets the transition control |
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¶
StudioSurfaceBuilderTransitionOptions Enumeration | the transition control options when using By Points alignment method |
Property Detail¶
AlignmentMethod¶
-
StudioSurfaceBuilder.
AlignmentMethod
¶ Returns the alignment method
-------------------------------------
Getter Method
Signature
AlignmentMethod
Returns: Return type: NXOpen.GeometricUtilities.AlignmentMethodBuilder
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
BodyPreference¶
-
StudioSurfaceBuilder.
BodyPreference
¶ Returns the body type options
-------------------------------------
Getter Method
Signature
BodyPreference
Returns: Return type: NXOpen.GeometricUtilities.FeatureOptions
New in version NX7.5.0.
License requirements: None.
CurvatureTolerance¶
-
StudioSurfaceBuilder.
CurvatureTolerance
¶ Returns or sets the curvature tolerance
-------------------------------------
Getter Method
Signature
CurvatureTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
-------------------------------------
Setter Method
Signature
CurvatureTolerance
Parameters: curvatureTolerance (float) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
FirstGuideContinuity¶
-
StudioSurfaceBuilder.
FirstGuideContinuity
¶ Returns the first guide continuity
-------------------------------------
Getter Method
Signature
FirstGuideContinuity
Returns: Return type: NXOpen.GeometricUtilities.Continuity
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
FirstSectionContinuity¶
-
StudioSurfaceBuilder.
FirstSectionContinuity
¶ Returns the first section continuity
-------------------------------------
Getter Method
Signature
FirstSectionContinuity
Returns: Return type: NXOpen.GeometricUtilities.Continuity
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
FlowDirection¶
-
StudioSurfaceBuilder.
FlowDirection
¶ Returns the flow direction
-------------------------------------
Getter Method
Signature
FlowDirection
Returns: Return type: NXOpen.GeometricUtilities.FlowDirection
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
GuideList¶
-
StudioSurfaceBuilder.
GuideList
¶ Returns the list of guides
-------------------------------------
Getter Method
Signature
GuideList
Returns: Return type: NXOpen.SectionList
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
GuideRebuild¶
-
StudioSurfaceBuilder.
GuideRebuild
¶ Returns the guide rebuild
-------------------------------------
Getter Method
Signature
GuideRebuild
Returns: Return type: NXOpen.GeometricUtilities.Rebuild
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
IntersectionTolerance¶
-
StudioSurfaceBuilder.
IntersectionTolerance
¶ Returns or sets the intersection tolerance
-------------------------------------
Getter Method
Signature
IntersectionTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
-------------------------------------
Setter Method
Signature
IntersectionTolerance
Parameters: intersectionTolerance (float) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
LastGuideContinuity¶
-
StudioSurfaceBuilder.
LastGuideContinuity
¶ Returns the last guide continuity
-------------------------------------
Getter Method
Signature
LastGuideContinuity
Returns: Return type: NXOpen.GeometricUtilities.Continuity
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
LastSectionContinuity¶
-
StudioSurfaceBuilder.
LastSectionContinuity
¶ Returns the last section continuity
-------------------------------------
Getter Method
Signature
LastSectionContinuity
Returns: Return type: NXOpen.GeometricUtilities.Continuity
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
PositionTolerance¶
-
StudioSurfaceBuilder.
PositionTolerance
¶ Returns or sets the position tolerance
-------------------------------------
Getter Method
Signature
PositionTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
-------------------------------------
Setter Method
Signature
PositionTolerance
Parameters: positionTolerance (float) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
SectionList¶
-
StudioSurfaceBuilder.
SectionList
¶ Returns the list of sections
-------------------------------------
Getter Method
Signature
SectionList
Returns: Return type: NXOpen.SectionList
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
SectionRebuild¶
-
StudioSurfaceBuilder.
SectionRebuild
¶ Returns the section rebuild
-------------------------------------
Getter Method
Signature
SectionRebuild
Returns: Return type: NXOpen.GeometricUtilities.Rebuild
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
SplitOutputAlongBoundaryCurves¶
-
StudioSurfaceBuilder.
SplitOutputAlongBoundaryCurves
¶ Returns or sets the split output along boundary curves option
-------------------------------------
Getter Method
Signature
SplitOutputAlongBoundaryCurves
Returns: Return type: bool New in version NX8.5.1.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
-------------------------------------
Setter Method
Signature
SplitOutputAlongBoundaryCurves
Parameters: splitOutput (bool) – New in version NX8.5.1.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
TangentTolerance¶
-
StudioSurfaceBuilder.
TangentTolerance
¶ Returns or sets the tangent tolerance
-------------------------------------
Getter Method
Signature
TangentTolerance
Returns: Return type: float New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
-------------------------------------
Setter Method
Signature
TangentTolerance
Parameters: tangentTolerance (float) – New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
Transition¶
-
StudioSurfaceBuilder.
Transition
¶ Returns or sets the transition control
-------------------------------------
Getter Method
Signature
Transition
Returns: Return type: NXOpen.Features.StudioSurfaceBuilderTransitionOptions
New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
-------------------------------------
Setter Method
Signature
Transition
Parameters: transition ( NXOpen.Features.StudioSurfaceBuilderTransitionOptions
) –New in version NX5.0.0.
License requirements: features_modeling (“FEATURES MODELING”), nx_freeform_1 (“basic freeform modeling”)
Method Detail¶
Validate¶
-
StudioSurfaceBuilder.
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.