OffsetSurfaceBuilder Class¶
-
class
NXOpen.Features.OffsetSurfaceBuilder¶ Bases:
NXOpen.Features.FeatureBuilderThis class represents a offset surface builder, used for creating or editing an offset surface feature.
The offset surface feature allows different face sets to be offset by different distances. Inputs to this class can be convergent objects.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateOffsetSurfaceBuilder()Default values.
Property Value ApproxOption False OutputOption OneFeatureForConnectedFaces PartialOption False StepOption True New in version NX4.0.0.
Properties¶
| Property | Description |
|---|---|
| ApproxOption | Returns or sets the option to create approximate offset surface if the offset surface has self-intersections. |
| FaceSets | Returns the list of face sets. |
| MaximumExcludedObjects | Returns or sets the maximum excluded objects during partial offset. |
| OutputOption | Returns or sets the offset surface output option based on the enum NXOpen.Features.OffsetSurfaceBuilderOutputOptionType |
| ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
| PartialOption | Returns or sets the option to pursue a partial offset result |
| PatchSolutionFlag | Returns or sets the patch solution flag |
| PatchSurfaceFilename | Returns or sets the patch surface filename |
| Radius | Returns the radius for error vertex excision during partial offset |
| RemoveProblemVerticesOption | Returns or sets the option to remove problem vertices |
| StepOption | Returns or sets the offset surface allow step boundaries option. |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| Tolerance | Returns or sets the offset surface tolerance |
Methods¶
| Method | Description |
|---|---|
| AddFaceSets | Adds face sets to the face set list |
| Commit | Commits any edits that have been applied to the builder. |
| CommitFeature | Commits the feature parameters and creates the feature |
| DeleteFaceSet | Deletes a face set at the specified index from the face set list |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| FindFaceSet | Finds and returns a face set at the specified index from the face set list |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetFaceSetList | Gets the list of face sets |
| GetFeature | Returns the feature currently being edited by this builder. |
| GetInteriorPosition | Gets the offset surface interior position for specify interior position method. |
| GetObject | Returns the object currently being edited by this builder. |
| GetOrientationMethod | Returns the offset surface orientation method based on the NXOpen.Features.OffsetSurfaceBuilderOutputOptionType |
| HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
| SetInteriorPosition | Sets the offset surface interior position for specify interior position method. |
| SetOrientationMethod | Sets the orientation method |
| 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¶
| OffsetSurfaceBuilderOrientationMethodType Enumeration | Represents the type of orientation method. |
| OffsetSurfaceBuilderOutputOptionType Enumeration | Represents the type of output option. |
Property Detail¶
ApproxOption¶
-
OffsetSurfaceBuilder.ApproxOption¶ Returns or sets the option to create approximate offset surface if the offset surface has self-intersections.
-------------------------------------Getter Method
Signature
ApproxOptionReturns: Approximate offset option Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ApproxOptionParameters: approxOption (bool) – Approximate offset option New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
FaceSets¶
-
OffsetSurfaceBuilder.FaceSets¶ Returns the list of face sets.
Each element defines a set of faces, and an offset distance applied to those faces.
-------------------------------------Getter Method
Signature
FaceSetsReturns: Face set list Return type: NXOpen.GeometricUtilities.FaceSetOffsetListNew in version NX4.0.0.
License requirements: None.
MaximumExcludedObjects¶
-
OffsetSurfaceBuilder.MaximumExcludedObjects¶ Returns or sets the maximum excluded objects during partial offset.
If the excluded objects reach this number, the partial offset will stop.
-------------------------------------Getter Method
Signature
MaximumExcludedObjectsReturns: Maximum excluded objects Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaximumExcludedObjectsParameters: maximumExcludedObjects (int) – Maximum excluded objects New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
OutputOption¶
-
OffsetSurfaceBuilder.OutputOption¶ Returns or sets the offset surface output option based on the enum
NXOpen.Features.OffsetSurfaceBuilderOutputOptionType-------------------------------------Getter Method
Signature
OutputOptionReturns: Output option Return type: NXOpen.Features.OffsetSurfaceBuilderOutputOptionTypeNew in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OutputOptionParameters: outputOption ( NXOpen.Features.OffsetSurfaceBuilderOutputOptionType) – Output optionNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
PartialOption¶
-
OffsetSurfaceBuilder.PartialOption¶ Returns or sets the option to pursue a partial offset result
-------------------------------------Getter Method
Signature
PartialOptionReturns: Partial option Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PartialOptionParameters: partialOption (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Radius¶
-
OffsetSurfaceBuilder.Radius¶ Returns the radius for error vertex excision during partial offset
-------------------------------------Getter Method
Signature
RadiusReturns: Sphere radius Return type: NXOpen.ExpressionNew in version NX7.5.0.
License requirements: None.
RemoveProblemVerticesOption¶
-
OffsetSurfaceBuilder.RemoveProblemVerticesOption¶ Returns or sets the option to remove problem vertices
-------------------------------------Getter Method
Signature
RemoveProblemVerticesOptionReturns: Remove problem vertices option Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
RemoveProblemVerticesOptionParameters: removeProblemVerticesOption (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
StepOption¶
-
OffsetSurfaceBuilder.StepOption¶ Returns or sets the offset surface allow step boundaries option.
If this option is true then side faces will be created along any smooth edge between a face which is offset and one which is not.
-------------------------------------Getter Method
Signature
StepOptionReturns: Allow step boundaries option Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StepOptionParameters: stepOption (bool) – Allow step boundaries option New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Tolerance¶
-
OffsetSurfaceBuilder.Tolerance¶ Returns or sets the offset surface tolerance
-------------------------------------Getter Method
Signature
ToleranceReturns: Tolerance Return type: float New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ToleranceParameters: tolerance (float) – Tolerance New in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Method Detail¶
AddFaceSets¶
-
OffsetSurfaceBuilder.AddFaceSets¶ Adds face sets to the face set list
Signature
AddFaceSets(faceSets)Parameters: faceSets (list of NXOpen.GeometricUtilities.FaceSetOffset) – Face set listNew in version NX4.0.0.
Deprecated since version NX5.0.0: Use
NXOpen.Features.OffsetSurfaceBuilder.FaceSets()instead.License requirements: solid_modeling (“SOLIDS MODELING”)
DeleteFaceSet¶
-
OffsetSurfaceBuilder.DeleteFaceSet¶ Deletes a face set at the specified index from the face set list
Signature
DeleteFaceSet(index)Parameters: index (int) – Index of face set to be deleted New in version NX4.0.0.
Deprecated since version NX5.0.0: Use
NXOpen.Features.OffsetSurfaceBuilder.FaceSets()instead.License requirements: solid_modeling (“SOLIDS MODELING”)
FindFaceSet¶
-
OffsetSurfaceBuilder.FindFaceSet¶ Finds and returns a face set at the specified index from the face set list
Signature
FindFaceSet(index)Parameters: index (int) – Index of face set to be returned Returns: Face set returned Return type: NXOpen.GeometricUtilities.FaceSetOffsetNew in version NX4.0.0.
Deprecated since version NX5.0.0: Use
NXOpen.Features.OffsetSurfaceBuilder.FaceSets()instead.License requirements: solid_modeling (“SOLIDS MODELING”)
GetFaceSetList¶
-
OffsetSurfaceBuilder.GetFaceSetList¶ Gets the list of face sets
Signature
GetFaceSetList()Returns: Face set list Return type: NXOpen.ObjectListNew in version NX4.0.0.
Deprecated since version NX5.0.0: Use
NXOpen.Features.OffsetSurfaceBuilder.FaceSets()instead.License requirements: None.
GetInteriorPosition¶
-
OffsetSurfaceBuilder.GetInteriorPosition¶ Gets the offset surface interior position for specify interior position method.
Signature
GetInteriorPosition()Returns: Interior position for specify interior position method Return type: NXOpen.Point3dNew in version NX4.0.0.
License requirements: None.
GetOrientationMethod¶
-
OffsetSurfaceBuilder.GetOrientationMethod¶ Returns the offset surface orientation method based on the
NXOpen.Features.OffsetSurfaceBuilderOutputOptionTypeSignature
GetOrientationMethod()Returns: Orientation method Return type: NXOpen.Features.OffsetSurfaceBuilderOrientationMethodTypeNew in version NX4.0.0.
License requirements: None.
SetInteriorPosition¶
-
OffsetSurfaceBuilder.SetInteriorPosition¶ Sets the offset surface interior position for specify interior position method.
This allows * the specified faces to be offset away from the interior position.
Signature
SetInteriorPosition(point)Parameters: point ( NXOpen.Point3d) – Interior position for specify interior position methodNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetOrientationMethod¶
-
OffsetSurfaceBuilder.SetOrientationMethod¶ Sets the orientation method
Signature
SetOrientationMethod(orientationMethod)Parameters: orientationMethod ( NXOpen.Features.OffsetSurfaceBuilderOrientationMethodType) – Orientation methodNew in version NX4.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
OffsetSurfaceBuilder.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.