VariableOffsetBuilder Class¶
-
class
NXOpen.Features.VariableOffsetBuilder¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a
NXOpen.Features.VariableOffsetbuilderTo create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateVariableOffsetBuilder()Default values.
Property Value IsApplyToAll 0 IsKeepParameterization 0 Method Linear New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| DistanceTolerance | Returns or sets the distance tolerance. |
| Face | Returns the face to be offset |
| IsApplyToAll | Returns or sets the toggle to set all offsets to equal value. |
| IsKeepParameterization | Returns or sets the toggle to maintain source face parameterization in the offset face. |
| IsReverseDirection | Returns or sets the toggle to reverse the direction of all offsets. |
| Method | Returns or sets the offset method |
| OffsetAtA | Returns the offset at corner A. |
| OffsetAtB | Returns the offset at corner B. |
| OffsetAtC | Returns the offset at corner C. |
| OffsetAtD | Returns the offset at corner D. |
| 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 |
| PointA | Returns or sets the point at corner A. |
| PointB | Returns or sets the point at corner B. |
| PointC | Returns or sets the point at corner C. |
| PointD | Returns or sets the point at corner D. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature @return |
| 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¶
| VariableOffsetBuilderMethodOptions Enumeration | offset methods for creating the new surface |
Property Detail¶
DistanceTolerance¶
-
VariableOffsetBuilder.DistanceTolerance¶ Returns or sets the distance tolerance.
-------------------------------------Getter Method
Signature
DistanceTolerance()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DistanceTolerance(distanceTolerance)Parameters: distanceTolerance (float) – New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Face¶
-
VariableOffsetBuilder.Face¶ Returns the face to be offset
-------------------------------------Getter Method
Signature
Face()Returns: Return type: NXOpen.SelectFaceNew in version NX8.0.0.
License requirements: None.
IsApplyToAll¶
-
VariableOffsetBuilder.IsApplyToAll¶ Returns or sets the toggle to set all offsets to equal value.
-------------------------------------Getter Method
Signature
IsApplyToAll()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsApplyToAll(isApplyToAll)Parameters: isApplyToAll (bool) – New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
IsKeepParameterization¶
-
VariableOffsetBuilder.IsKeepParameterization¶ Returns or sets the toggle to maintain source face parameterization in the offset face.
-------------------------------------Getter Method
Signature
IsKeepParameterization()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsKeepParameterization(isKeepParameterization)Parameters: isKeepParameterization (bool) – New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
IsReverseDirection¶
-
VariableOffsetBuilder.IsReverseDirection¶ Returns or sets the toggle to reverse the direction of all offsets.
-------------------------------------Getter Method
Signature
IsReverseDirection()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsReverseDirection(isReverseDirection)Parameters: isReverseDirection (bool) – New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method¶
-
VariableOffsetBuilder.Method¶ Returns or sets the offset method
-------------------------------------Getter Method
Signature
Method()Returns: Return type: NXOpen.Features.VariableOffsetBuilderMethodOptionsNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Method(method)Parameters: method ( NXOpen.Features.VariableOffsetBuilderMethodOptions) –New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
OffsetAtA¶
-
VariableOffsetBuilder.OffsetAtA¶ Returns the offset at corner A.
-------------------------------------Getter Method
Signature
OffsetAtA()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
OffsetAtB¶
-
VariableOffsetBuilder.OffsetAtB¶ Returns the offset at corner B.
-------------------------------------Getter Method
Signature
OffsetAtB()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
OffsetAtC¶
-
VariableOffsetBuilder.OffsetAtC¶ Returns the offset at corner C.
-------------------------------------Getter Method
Signature
OffsetAtC()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
OffsetAtD¶
-
VariableOffsetBuilder.OffsetAtD¶ Returns the offset at corner D.
-------------------------------------Getter Method
Signature
OffsetAtD()Returns: Return type: NXOpen.ExpressionNew in version NX8.0.0.
License requirements: None.
PointA¶
-
VariableOffsetBuilder.PointA¶ Returns or sets the point at corner A.
-------------------------------------Getter Method
Signature
PointA()Returns: Return type: NXOpen.PointNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointA(point)Parameters: point ( NXOpen.Point) –New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
PointB¶
-
VariableOffsetBuilder.PointB¶ Returns or sets the point at corner B.
-------------------------------------Getter Method
Signature
PointB()Returns: Return type: NXOpen.PointNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointB(point)Parameters: point ( NXOpen.Point) –New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
PointC¶
-
VariableOffsetBuilder.PointC¶ Returns or sets the point at corner C.
-------------------------------------Getter Method
Signature
PointC()Returns: Return type: NXOpen.PointNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointC(point)Parameters: point ( NXOpen.Point) –New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
PointD¶
-
VariableOffsetBuilder.PointD¶ Returns or sets the point at corner D.
-------------------------------------Getter Method
Signature
PointD()Returns: Return type: NXOpen.PointNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointD(point)Parameters: point ( NXOpen.Point) –New in version NX8.0.0.
License requirements: studio_free_form (“STUDIO FREE FORM”)
Method Detail¶
Validate¶
-
VariableOffsetBuilder.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.