SurfaceRegions Class¶
-
class
NXOpen.CAM.SurfaceRegions¶ Bases:
NXOpen.Features.FeatureBuilderRepresents a Surface Regions Builder
To create a new instance of this class, use
NXOpen.CAM.CAMSetup.CreateSurfaceRegionsNew in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| AngleTolerance | Returns or sets the angle tolerance |
| AtTimestamp | Returns or sets the at timestamp flag |
| Bodies | Returns the bodies |
| BoundaryFaces | Returns the boundary faces |
| CreateRegionsOption | Returns or sets the create regions type |
| CutDirection | Returns or sets the cut direction |
| Direction | Returns or sets the direction |
| ExcludedFaces | Returns the excluded faces |
| Faces | Returns the faces |
| FeatureType | Returns or sets the feature type |
| IsoclineAngle | Returns or sets the isocline angle |
| LimitSteepByCutDirection | Returns or sets the limit steep by cut direction flag |
| 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 |
| SeedFace | Returns or sets the seed face |
| SteepBody | Returns or sets the steep body |
| SurfaceRegionName | Returns or sets the surface region name |
| SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
| Tag | Returns the Tag for this object. |
| TraverseInteriorEdges | Returns or sets the traverse interior edges flag |
| UseTangentEdgeAngles | Returns or sets the use tangent edge angle flag |
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¶
| SurfaceRegionsCreateRegionsTypes Enumeration | enum for create regions |
| SurfaceRegionsFeatureTypes Enumeration | enum for feature type |
Property Detail¶
AngleTolerance¶
-
SurfaceRegions.AngleTolerance¶ Returns or sets the angle tolerance
-------------------------------------Getter Method
Signature
AngleTolerance()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AngleTolerance(angleTol)Parameters: angleTol (float) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
AtTimestamp¶
-
SurfaceRegions.AtTimestamp¶ Returns or sets the at timestamp flag
-------------------------------------Getter Method
Signature
AtTimestamp()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AtTimestamp(timestamp)Parameters: timestamp (bool) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
Bodies¶
-
SurfaceRegions.Bodies¶ Returns the bodies
-------------------------------------Getter Method
Signature
Bodies()Returns: the body objects list Return type: NXOpen.SelectBodyListNew in version NX8.0.0.
License requirements: None.
BoundaryFaces¶
-
SurfaceRegions.BoundaryFaces¶ Returns the boundary faces
-------------------------------------Getter Method
Signature
BoundaryFaces()Returns: the boundary face objects list Return type: NXOpen.SelectFaceListNew in version NX8.0.0.
License requirements: None.
CreateRegionsOption¶
-
SurfaceRegions.CreateRegionsOption¶ Returns or sets the create regions type
-------------------------------------Getter Method
Signature
CreateRegionsOption()Returns: Return type: NXOpen.CAM.SurfaceRegionsCreateRegionsTypesNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateRegionsOption(type)Parameters: type ( NXOpen.CAM.SurfaceRegionsCreateRegionsTypes) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
CutDirection¶
-
SurfaceRegions.CutDirection¶ Returns or sets the cut direction
-------------------------------------Getter Method
Signature
CutDirection()Returns: Return type: NXOpen.DirectionNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CutDirection(direction)Parameters: direction ( NXOpen.Direction) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
Direction¶
-
SurfaceRegions.Direction¶ Returns or sets the direction
-------------------------------------Getter Method
Signature
Direction()Returns: Return type: NXOpen.DirectionNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Direction(direction)Parameters: direction ( NXOpen.Direction) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
ExcludedFaces¶
-
SurfaceRegions.ExcludedFaces¶ Returns the excluded faces
-------------------------------------Getter Method
Signature
ExcludedFaces()Returns: the excluded face objects list Return type: NXOpen.SelectFaceListNew in version NX8.0.0.
License requirements: None.
Faces¶
-
SurfaceRegions.Faces¶ Returns the faces
-------------------------------------Getter Method
Signature
Faces()Returns: the face objects list Return type: NXOpen.SelectFaceListNew in version NX8.0.0.
License requirements: None.
FeatureType¶
-
SurfaceRegions.FeatureType¶ Returns or sets the feature type
-------------------------------------Getter Method
Signature
FeatureType()Returns: Return type: NXOpen.CAM.SurfaceRegionsFeatureTypesNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FeatureType(type)Parameters: type ( NXOpen.CAM.SurfaceRegionsFeatureTypes) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
IsoclineAngle¶
-
SurfaceRegions.IsoclineAngle¶ Returns or sets the isocline angle
-------------------------------------Getter Method
Signature
IsoclineAngle()Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsoclineAngle(angle)Parameters: angle (float) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
LimitSteepByCutDirection¶
-
SurfaceRegions.LimitSteepByCutDirection¶ Returns or sets the limit steep by cut direction flag
-------------------------------------Getter Method
Signature
LimitSteepByCutDirection()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LimitSteepByCutDirection(limit)Parameters: limit (bool) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
SeedFace¶
-
SurfaceRegions.SeedFace¶ Returns or sets the seed face
-------------------------------------Getter Method
Signature
SeedFace()Returns: Return type: NXOpen.FaceNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SeedFace(face)Parameters: face ( NXOpen.Face) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
SteepBody¶
-
SurfaceRegions.SteepBody¶ Returns or sets the steep body
-------------------------------------Getter Method
Signature
SteepBody()Returns: Return type: NXOpen.BodyNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SteepBody(body)Parameters: body ( NXOpen.Body) –New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
SurfaceRegionName¶
-
SurfaceRegions.SurfaceRegionName¶ Returns or sets the surface region name
-------------------------------------Getter Method
Signature
SurfaceRegionName()Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SurfaceRegionName(name)Parameters: name (str) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
TraverseInteriorEdges¶
-
SurfaceRegions.TraverseInteriorEdges¶ Returns or sets the traverse interior edges flag
-------------------------------------Getter Method
Signature
TraverseInteriorEdges()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TraverseInteriorEdges(traverseInteriorEdges)Parameters: traverseInteriorEdges (bool) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
UseTangentEdgeAngles¶
-
SurfaceRegions.UseTangentEdgeAngles¶ Returns or sets the use tangent edge angle flag
-------------------------------------Getter Method
Signature
UseTangentEdgeAngles()Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseTangentEdgeAngles(useAngle)Parameters: useAngle (bool) – New in version NX8.0.0.
License requirements: cam_base (“CAM BASE”)
Method Detail¶
Validate¶
-
SurfaceRegions.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.