ExtrudeFacetBodyBuilder Class¶
-
class
NXOpen.Facet.
ExtrudeFacetBodyBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Facet.ExtrudeFacetBodyBuilder
It extrudes a NX Facet Body.The limit of extrusion can be specified by direction and distance or plane object. It returns the extruded NX Facet Body.
To create a new instance of this class, use
NXOpen.Facet.FacetedBodyCollection.CreateExtrudeFacetBodyBuilder()
Default values.
Property Value Distance.Value 10 (millimeters part), 1 (inches part) Offset.Value 0 (millimeters part), 0 (inches part) Type Distance New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
Direction | Returns or sets the direction used when limit type is NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType.Distance |
Distance | Returns the distance used when limit type is NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType.Distance |
DistanceTolerance | Returns or sets the distance tolerance used in the extrude facet body feature |
FacetBody | Returns the facet/sheet bodies to be extruded |
Offset | Returns the offset value used to offset the extruded body |
Plane | Returns or sets the plane used when limit type is NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType.ToPlane |
Tag | Returns the Tag for this object. |
Type | Returns or sets the limit type |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
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. |
GetObject | Returns the object currently being edited by this builder. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ExtrudeFacetBodyBuilderLimitType Enumeration | Represents the extrude limit type |
Property Detail¶
Direction¶
-
ExtrudeFacetBodyBuilder.
Direction
¶ Returns or sets the direction used when limit type is
NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType.Distance
-------------------------------------
Getter Method
Signature
Direction
Returns: Return type: NXOpen.Direction
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Direction
Parameters: direction ( NXOpen.Direction
) –New in version NX9.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”) OR die_engineering (“DIE ENGINEERING”)
Distance¶
-
ExtrudeFacetBodyBuilder.
Distance
¶ Returns the distance used when limit type is
NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType.Distance
-------------------------------------
Getter Method
Signature
Distance
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
DistanceTolerance¶
-
ExtrudeFacetBodyBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance used in the extrude facet body feature
-------------------------------------
Getter Method
Signature
DistanceTolerance
Returns: Return type: float New in version NX9.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceTolerance
Parameters: distanceTolerance (float) – New in version NX9.0.1.
License requirements: None.
FacetBody¶
-
ExtrudeFacetBodyBuilder.
FacetBody
¶ Returns the facet/sheet bodies to be extruded
-------------------------------------
Getter Method
Signature
FacetBody
Returns: Return type: NXOpen.SelectDisplayableObjectList
New in version NX9.0.0.
License requirements: None.
Offset¶
-
ExtrudeFacetBodyBuilder.
Offset
¶ Returns the offset value used to offset the extruded body
-------------------------------------
Getter Method
Signature
Offset
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: None.
Plane¶
-
ExtrudeFacetBodyBuilder.
Plane
¶ Returns or sets the plane used when limit type is
NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType.ToPlane
-------------------------------------
Getter Method
Signature
Plane
Returns: Return type: NXOpen.Plane
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Plane
Parameters: plane ( NXOpen.Plane
) –New in version NX9.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”) OR die_engineering (“DIE ENGINEERING”)
Type¶
-
ExtrudeFacetBodyBuilder.
Type
¶ Returns or sets the limit type
-------------------------------------
Getter Method
Signature
Type
Returns: Return type: NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Type
Parameters: type ( NXOpen.Facet.ExtrudeFacetBodyBuilderLimitType
) –New in version NX9.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”) OR die_engineering (“DIE ENGINEERING”)
Method Detail¶
Validate¶
-
ExtrudeFacetBodyBuilder.
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.