LocalOffsetBuilder Class¶
-
class
NXOpen.Facet.
LocalOffsetBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Facet.LocalOffsetBuilder
.This class adds or removes material on facet bodies by creating local offsets. To create a new instance of this class, use
NXOpen.Facet.FacetModelingCollection.CreateLocalOffsetBuilder()
Default values.
Property Value IsEditCopy 0 IsSmoothEdge 1 OffsetDistance.Value 5 (millimeters part), 0.2 (inches part) RegionDistance.Value 10 (millimeters part), 0.4 (inches part) ShapeMethod Smooth TransitionMethod None New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
FacetRegion | Returns the facets to be offset |
FacetTransitionRegions | Returns the user-selected transition regions |
IsEditCopy | Returns or sets the option to create a non-associative copy of the selected body and edit that copy |
IsRegenerateOffsetMesh | Returns or sets the option to rebuild the mesh structure of the offset output |
IsReverseDirection | Returns or sets the method to reverse the direction of the offset. |
IsSmoothEdge | Returns or sets the option to add smoothing to the edge of the offset region |
OffsetDistance | Returns the linear distance of the created local offset, which may be a positive or negative distance |
RegionDistance | Returns the distance of the transition region with the constant offset option |
ShapeMethod | Returns or sets the method to define the shape of the transition region |
Tag | Returns the Tag for this object. |
TransitionMethod | Returns or sets the type of transition region |
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¶
LocalOffsetBuilderShapeMethodType Enumeration | Continuity Method |
LocalOffsetBuilderTransitionMethodType Enumeration | Transition Region Definition |
Property Detail¶
FacetRegion¶
-
LocalOffsetBuilder.
FacetRegion
¶ Returns the facets to be offset
-------------------------------------
Getter Method
Signature
FacetRegion
Returns: Return type: NXOpen.FacetCollector
New in version NX12.0.0.
License requirements: None.
FacetTransitionRegions¶
-
LocalOffsetBuilder.
FacetTransitionRegions
¶ Returns the user-selected transition regions
-------------------------------------
Getter Method
Signature
FacetTransitionRegions
Returns: Return type: NXOpen.FacetCollector
New in version NX12.0.0.
License requirements: None.
IsEditCopy¶
-
LocalOffsetBuilder.
IsEditCopy
¶ Returns or sets the option to create a non-associative copy of the selected body and edit that copy
-------------------------------------
Getter Method
Signature
IsEditCopy
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsEditCopy
Parameters: isEditCopy (bool) – New in version NX12.0.0.
License requirements: nx_polygon_modeling (” NX Polygon Modeling”)
IsRegenerateOffsetMesh¶
-
LocalOffsetBuilder.
IsRegenerateOffsetMesh
¶ Returns or sets the option to rebuild the mesh structure of the offset output
-------------------------------------
Getter Method
Signature
IsRegenerateOffsetMesh
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsRegenerateOffsetMesh
Parameters: isRegenerateOffsetMesh (bool) – New in version NX12.0.0.
License requirements: nx_polygon_modeling (” NX Polygon Modeling”)
IsReverseDirection¶
-
LocalOffsetBuilder.
IsReverseDirection
¶ Returns or sets the method to reverse the direction of the offset.
-------------------------------------
Getter Method
Signature
IsReverseDirection
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsReverseDirection
Parameters: isReverseDirection (bool) – New in version NX12.0.0.
License requirements: nx_polygon_modeling (” NX Polygon Modeling”)
IsSmoothEdge¶
-
LocalOffsetBuilder.
IsSmoothEdge
¶ Returns or sets the option to add smoothing to the edge of the offset region
-------------------------------------
Getter Method
Signature
IsSmoothEdge
Returns: Return type: bool New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsSmoothEdge
Parameters: isSmoothEdge (bool) – New in version NX12.0.0.
License requirements: nx_polygon_modeling (” NX Polygon Modeling”)
OffsetDistance¶
-
LocalOffsetBuilder.
OffsetDistance
¶ Returns the linear distance of the created local offset, which may be a positive or negative distance
-------------------------------------
Getter Method
Signature
OffsetDistance
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
RegionDistance¶
-
LocalOffsetBuilder.
RegionDistance
¶ Returns the distance of the transition region with the constant offset option
-------------------------------------
Getter Method
Signature
RegionDistance
Returns: Return type: NXOpen.Expression
New in version NX12.0.0.
License requirements: None.
ShapeMethod¶
-
LocalOffsetBuilder.
ShapeMethod
¶ Returns or sets the method to define the shape of the transition region
-------------------------------------
Getter Method
Signature
ShapeMethod
Returns: Return type: NXOpen.Facet.LocalOffsetBuilderShapeMethodType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShapeMethod
Parameters: shapeMethod ( NXOpen.Facet.LocalOffsetBuilderShapeMethodType
) –New in version NX12.0.0.
License requirements: nx_polygon_modeling (” NX Polygon Modeling”)
TransitionMethod¶
-
LocalOffsetBuilder.
TransitionMethod
¶ Returns or sets the type of transition region
-------------------------------------
Getter Method
Signature
TransitionMethod
Returns: Return type: NXOpen.Facet.LocalOffsetBuilderTransitionMethodType
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TransitionMethod
Parameters: transitionMethod ( NXOpen.Facet.LocalOffsetBuilderTransitionMethodType
) –New in version NX12.0.0.
License requirements: nx_polygon_modeling (” NX Polygon Modeling”)
Method Detail¶
Validate¶
-
LocalOffsetBuilder.
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.