SilhouetteFlangeBuilder Class¶
-
class
NXOpen.Features.
SilhouetteFlangeBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
NXOpen.Features.SilhouetteFlange
builderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateSilhouetteFlangeBuilder()
Default values.
Property Value AngleLaw.Function ft AngleLaw.LawType MultiTransition AngleLaw.Parameter t BaseFactor 0 BasePipeContinuity.ContinuityType G1 CreateCurves 0 ExtendFlange 1 FlangeFactor 0 FlangePipeContinuity.ContinuityType G0 Gap.Value 5 (millimeters part), 0.2 (inches part) LengthLaw.LawType MultiTransition MergeFacesIfPossible 0 RadiusLaw.LawType MultiTransition ReferenceDirectionOption NormalDraft ShowPipe 0 TrimBaseFaces 0 Type Basic New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AngleLaw | Returns the angle law. |
BaseCurves | Returns the base curves. |
BaseFaces | Returns the base faces. |
BaseFactor | Returns or sets the base pipe continuity factor. |
BasePipeContinuity | Returns the base pipe continuity. |
CreateCurves | Returns or sets a value that indicates whether to create curves. |
ExtendFlange | Returns or sets a value that indicates whether to extend flange until the boundary edges of the base faces. |
FlangeFactor | Returns or sets the flange pipe continuity factor. |
FlangePipeContinuity | Returns the flange pipe continuity |
Gap | Returns the gap |
LengthLaw | Returns the length law. |
MergeFacesIfPossible | Returns or sets a value that indicates whether to the merge faces if possible |
OutputSurfaceOption | Returns or sets the output surface option |
ParentFeature | Returns the parent feature. |
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 |
RadiusLaw | Returns the radius law. |
ReferenceDirectionOption | Returns or sets the reference direction option |
ReferenceFaces | Returns the reference faces. |
ReferenceVector | Returns or sets the reference vector |
ShowPipe | Returns or sets a value that indicates whether to show pipe |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
TangentTolerance | Returns or sets the tangent tolerance |
TrimBaseFaces | Returns or sets a value that indicates whether to trim base faces |
Type | Returns or sets the type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
CreatePipe | Create the tube from the given inputs. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCenterCurve | Return the center curve |
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. |
GetIsDirectionFlipped | A value indicating whether to flip the direction. |
GetIsSideFlipped | Returns a value indicating whether to flip the side. |
GetObject | Returns the object currently being edited by this builder. |
GetSilhouetteCurve | Return the silhouette curve |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SetIsDirectionFlipped | Sets a flag indicating if the direction is flipped. |
SetIsSideFlipped | Sets a value indicating whether to flip the side. |
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 |
UpdateLawSpine | Update the spine curve in length/angle/radius laws. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SilhouetteFlangeBuilderOutputSurfaceOptions Enumeration | Output surface options |
SilhouetteFlangeBuilderReferenceDirectionOptions Enumeration | Reference direction options |
SilhouetteFlangeBuilderTypes Enumeration | Silhouette flange creation types |
Property Detail¶
AngleLaw¶
-
SilhouetteFlangeBuilder.
AngleLaw
¶ Returns the angle law.
The only supported law type is
GeometricUtilities.LawBuilderType.MultiTransition
.-------------------------------------
Getter Method
Signature
AngleLaw
Returns: Return type: NXOpen.GeometricUtilities.LawBuilder
New in version NX6.0.0.
License requirements: None.
BaseCurves¶
-
SilhouetteFlangeBuilder.
BaseCurves
¶ Returns the base curves.
Base curves must be G1 continuous.
-------------------------------------
Getter Method
Signature
BaseCurves
Returns: Return type: NXOpen.Section
New in version NX6.0.0.
License requirements: None.
BaseFaces¶
-
SilhouetteFlangeBuilder.
BaseFaces
¶ Returns the base faces.
The base faces could be from different sheet bodies, but they must be G1 continuous.
-------------------------------------
Getter Method
Signature
BaseFaces
Returns: Return type: NXOpen.ScCollector
New in version NX6.0.0.
License requirements: None.
BaseFactor¶
-
SilhouetteFlangeBuilder.
BaseFactor
¶ Returns or sets the base pipe continuity factor.
It’s used to determine what percentage of the arc will be trimmed away in order to build the transition surface between the base faces and the pipe.
-------------------------------------
Getter Method
Signature
BaseFactor
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BaseFactor
Parameters: baseFactor (int) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
BasePipeContinuity¶
-
SilhouetteFlangeBuilder.
BasePipeContinuity
¶ Returns the base pipe continuity.
-------------------------------------
Getter Method
Signature
BasePipeContinuity
Returns: Return type: NXOpen.GeometricUtilities.Continuity
New in version NX6.0.0.
License requirements: None.
CreateCurves¶
-
SilhouetteFlangeBuilder.
CreateCurves
¶ Returns or sets a value that indicates whether to create curves.
When this option is true, the center line curve of the pipe and silhouette flange curve at zero degrees will be output.
-------------------------------------
Getter Method
Signature
CreateCurves
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateCurves
Parameters: createCurves (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
ExtendFlange¶
-
SilhouetteFlangeBuilder.
ExtendFlange
¶ Returns or sets a value that indicates whether to extend flange until the boundary edges of the base faces.
This option will be enforced if Trim Base Faces option is true. The base faces cannot be trimmed if the pipe does not hit the boundary edges of base faces.
-------------------------------------
Getter Method
Signature
ExtendFlange
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ExtendFlange
Parameters: extendFlange (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
FlangeFactor¶
-
SilhouetteFlangeBuilder.
FlangeFactor
¶ Returns or sets the flange pipe continuity factor.
It’s used to determine what percentage of the arc will be trimmed away in order to build the transition surface between the pipe and flange surface.
-------------------------------------
Getter Method
Signature
FlangeFactor
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
FlangeFactor
Parameters: flangeFactor (int) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
FlangePipeContinuity¶
-
SilhouetteFlangeBuilder.
FlangePipeContinuity
¶ Returns the flange pipe continuity
-------------------------------------
Getter Method
Signature
FlangePipeContinuity
Returns: Return type: NXOpen.GeometricUtilities.Continuity
New in version NX6.0.0.
License requirements: None.
Gap¶
-
SilhouetteFlangeBuilder.
Gap
¶ Returns the gap
-------------------------------------
Getter Method
Signature
Gap
Returns: Return type: NXOpen.Expression
New in version NX6.0.0.
License requirements: None.
LengthLaw¶
-
SilhouetteFlangeBuilder.
LengthLaw
¶ Returns the length law.
The only supported law type is
GeometricUtilities.LawBuilderType.MultiTransition
.-------------------------------------
Getter Method
Signature
LengthLaw
Returns: Return type: NXOpen.GeometricUtilities.LawBuilder
New in version NX6.0.0.
License requirements: None.
MergeFacesIfPossible¶
-
SilhouetteFlangeBuilder.
MergeFacesIfPossible
¶ Returns or sets a value that indicates whether to the merge faces if possible
-------------------------------------
Getter Method
Signature
MergeFacesIfPossible
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MergeFacesIfPossible
Parameters: mergeFacesIfPossible (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
OutputSurfaceOption¶
-
SilhouetteFlangeBuilder.
OutputSurfaceOption
¶ Returns or sets the output surface option
-------------------------------------
Getter Method
Signature
OutputSurfaceOption
Returns: Return type: NXOpen.Features.SilhouetteFlangeBuilderOutputSurfaceOptions
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OutputSurfaceOption
Parameters: outputSurfaceOption ( NXOpen.Features.SilhouetteFlangeBuilderOutputSurfaceOptions
) –New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
ParentFeature¶
-
SilhouetteFlangeBuilder.
ParentFeature
¶ Returns the parent feature.
Parent feature must be a Silhouette Flange feature. A
NXOpen.Features.SilhouetteFlangeBuilderTypes.VisualGap
silhouette flange and its parent Silhouette Flange feature should use parallel vectors as reference direction.-------------------------------------
Getter Method
Signature
ParentFeature
Returns: Return type: NXOpen.Features.SelectFeature
New in version NX6.0.0.
License requirements: None.
PositionTolerance¶
-
SilhouetteFlangeBuilder.
PositionTolerance
¶ Returns or sets the position tolerance
-------------------------------------
Getter Method
Signature
PositionTolerance
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PositionTolerance
Parameters: positionTolerance (float) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
RadiusLaw¶
-
SilhouetteFlangeBuilder.
RadiusLaw
¶ Returns the radius law.
The only supported law type is
GeometricUtilities.LawBuilderType.MultiTransition
.-------------------------------------
Getter Method
Signature
RadiusLaw
Returns: Return type: NXOpen.GeometricUtilities.LawBuilder
New in version NX6.0.0.
License requirements: None.
ReferenceDirectionOption¶
-
SilhouetteFlangeBuilder.
ReferenceDirectionOption
¶ Returns or sets the reference direction option
-------------------------------------
Getter Method
Signature
ReferenceDirectionOption
Returns: Return type: NXOpen.Features.SilhouetteFlangeBuilderReferenceDirectionOptions
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceDirectionOption
Parameters: referenceDirectionOption ( NXOpen.Features.SilhouetteFlangeBuilderReferenceDirectionOptions
) –New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
ReferenceFaces¶
-
SilhouetteFlangeBuilder.
ReferenceFaces
¶ Returns the reference faces.
If any reference face is selected for
NXOpen.Features.SilhouetteFlangeBuilderReferenceDirectionOptions.FaceNormal
case, the normal of reference face is used as the reference direction. Otherwise, the normal of base faces will be used as the reference direction.-------------------------------------
Getter Method
Signature
ReferenceFaces
Returns: Return type: NXOpen.ScCollector
New in version NX6.0.0.
License requirements: None.
ReferenceVector¶
-
SilhouetteFlangeBuilder.
ReferenceVector
¶ Returns or sets the reference vector
-------------------------------------
Getter Method
Signature
ReferenceVector
Returns: Return type: NXOpen.Direction
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceVector
Parameters: referenceVctor ( NXOpen.Direction
) –New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
ShowPipe¶
-
SilhouetteFlangeBuilder.
ShowPipe
¶ Returns or sets a value that indicates whether to show pipe
-------------------------------------
Getter Method
Signature
ShowPipe
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowPipe
Parameters: showPipe (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
TangentTolerance¶
-
SilhouetteFlangeBuilder.
TangentTolerance
¶ Returns or sets the tangent tolerance
-------------------------------------
Getter Method
Signature
TangentTolerance
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TangentTolerance
Parameters: tangentTolerance (float) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
TrimBaseFaces¶
-
SilhouetteFlangeBuilder.
TrimBaseFaces
¶ Returns or sets a value that indicates whether to trim base faces
-------------------------------------
Getter Method
Signature
TrimBaseFaces
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrimBaseFaces
Parameters: trimBaseFaces (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
Type¶
-
SilhouetteFlangeBuilder.
Type
¶ Returns or sets the type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Features.SilhouetteFlangeBuilderTypes
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Features.SilhouetteFlangeBuilderTypes
) –New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
Method Detail¶
CreatePipe¶
-
SilhouetteFlangeBuilder.
CreatePipe
¶ Create the tube from the given inputs.
The tube must be created before creating any flange surface.
Signature
CreatePipe()
New in version NX12.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
GetCenterCurve¶
-
SilhouetteFlangeBuilder.
GetCenterCurve
¶ Return the center curve
Signature
GetCenterCurve()
Returns: Return type: NXOpen.Curve
New in version NX8.0.0.
License requirements: None.
GetIsDirectionFlipped¶
-
SilhouetteFlangeBuilder.
GetIsDirectionFlipped
¶ A value indicating whether to flip the direction.
If the direction is flipped, the pipe is placed to the opposite side of base faces and flange direction is flipped.
Signature
GetIsDirectionFlipped()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
GetIsSideFlipped¶
-
SilhouetteFlangeBuilder.
GetIsSideFlipped
¶ Returns a value indicating whether to flip the side.
If the side is flipped, the pipe is placed to the other side of base curves for Basic Type and the other side of the pipe of the parent feature for Absolute/Visual Gap Type.
Signature
GetIsSideFlipped()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
GetSilhouetteCurve¶
-
SilhouetteFlangeBuilder.
GetSilhouetteCurve
¶ Return the silhouette curve
Signature
GetSilhouetteCurve()
Returns: Return type: NXOpen.Curve
New in version NX8.0.0.
License requirements: None.
SetIsDirectionFlipped¶
-
SilhouetteFlangeBuilder.
SetIsDirectionFlipped
¶ Sets a flag indicating if the direction is flipped.
Signature
SetIsDirectionFlipped(flipDirection)
Parameters: flipDirection (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
SetIsSideFlipped¶
-
SilhouetteFlangeBuilder.
SetIsSideFlipped
¶ Sets a value indicating whether to flip the side.
If the side is flipped, the pipe is placed to the other side of base curves for Basic Type and the other side of the pipe of the parent feature for Absolute/Visual Gap Type.
Signature
SetIsSideFlipped(flipSide)
Parameters: flipSide (bool) – New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
UpdateLawSpine¶
-
SilhouetteFlangeBuilder.
UpdateLawSpine
¶ Update the spine curve in length/angle/radius laws.
All laws use the center line curve of the pipe as the spine curve. This API should be called if the pipe should be reconstructed due to any input change.
Signature
UpdateLawSpine()
New in version NX6.0.0.
License requirements: nx_freeform_2 (“advanced freeform modeling”)
Validate¶
-
SilhouetteFlangeBuilder.
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.