ConcaveFacesBuilder Class¶
-
class
NXOpen.Features.
ConcaveFacesBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a Concave Faces builder.
These are faces which are concave with respect to the draw direction and whose maximum radii is within the specified range.
To create a new instance of this class, use
NXOpen.Features.FeatureCollection.CreateConcaveFacesBuilder()
Default values.
Property Value Lower.Value 3 (millimeters part), 0.118 (inches part) SamplePoints 4 Upper.Value 6 (millimeters part), 0.236 (inches part) New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
AngleTolerance | Returns or sets the angle tolerance. |
AttributeColor | Returns or sets the color to be applied to the face. |
AttributeTitle | Returns or sets the title if the face attribute. |
AttributeValue | Returns or sets the value of the face attribute title. |
DistanceTolerance | Returns or sets the distance tolerance. |
DrawDirection | Returns or sets the vector representing the draw direction. |
Faces | Returns the collection of all the possible faces. |
GroupInterval | Returns or sets the group interval value. |
Lower | Returns the lower limit of the maximum concave range. |
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 |
ReverseNormalDirection | Returns or sets the reverse normal direction switch |
SamplePoints | Returns or sets the number of sample points to apply to the analysis. |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Upper | Returns the upper limit of the maximum concave range. |
UseSurfaceNormal | Returns or sets the surface normal vector toggle |
Methods¶
Method | Description |
---|---|
CalculatePointCurvature | The radius values at the point selected on a targeted face, the maximum and minimum radius of the targeted face. |
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature |
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. |
SetFaceAttributeColor | Set the color ID for the specified face in tree list |
SetFaceGroupAttributeTitle | Set face group attribute title. |
SetFaceGroupAttributeValue | Set face group attribute value. |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
SetTreeSelectedIndex | Set face indexes in tree list. |
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 |
UpdateLocationLabel | The PMI as a location label created or edited at the point selected on a face. |
UpdateRadiusFaces | The targeted faces updated according to the given radius range, number of sample point and group interval changing. |
UpdateSelectedFacesColor | Update selected faces color. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AngleTolerance¶
-
ConcaveFacesBuilder.
AngleTolerance
¶ Returns or sets the angle tolerance.
-------------------------------------
Getter Method
Signature
AngleTolerance
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleTolerance
Parameters: angleTolerance (float) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
AttributeColor¶
-
ConcaveFacesBuilder.
AttributeColor
¶ Returns or sets the color to be applied to the face.
-------------------------------------
Getter Method
Signature
AttributeColor
Returns: Return type: Id New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AttributeColor
Parameters: attributeColor (Id) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
AttributeTitle¶
-
ConcaveFacesBuilder.
AttributeTitle
¶ Returns or sets the title if the face attribute.
-------------------------------------
Getter Method
Signature
AttributeTitle
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AttributeTitle
Parameters: attributeTitle (str) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
AttributeValue¶
-
ConcaveFacesBuilder.
AttributeValue
¶ Returns or sets the value of the face attribute title.
-------------------------------------
Getter Method
Signature
AttributeValue
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AttributeValue
Parameters: attributeValue (str) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DistanceTolerance¶
-
ConcaveFacesBuilder.
DistanceTolerance
¶ Returns or sets the distance tolerance.
-------------------------------------
Getter Method
Signature
DistanceTolerance
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceTolerance
Parameters: distanceTolerance (float) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
DrawDirection¶
-
ConcaveFacesBuilder.
DrawDirection
¶ Returns or sets the vector representing the draw direction.
-------------------------------------
Getter Method
Signature
DrawDirection
Returns: Return type: NXOpen.Direction
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DrawDirection
Parameters: drawDirection ( NXOpen.Direction
) –New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Faces¶
-
ConcaveFacesBuilder.
Faces
¶ Returns the collection of all the possible faces.
-------------------------------------
Getter Method
Signature
Faces
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
GroupInterval¶
-
ConcaveFacesBuilder.
GroupInterval
¶ Returns or sets the group interval value.
-------------------------------------
Getter Method
Signature
GroupInterval
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GroupInterval
Parameters: interval (float) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Lower¶
-
ConcaveFacesBuilder.
Lower
¶ Returns the lower limit of the maximum concave range.
-------------------------------------
Getter Method
Signature
Lower
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
ReverseNormalDirection¶
-
ConcaveFacesBuilder.
ReverseNormalDirection
¶ Returns or sets the reverse normal direction switch
-------------------------------------
Getter Method
Signature
ReverseNormalDirection
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReverseNormalDirection
Parameters: reverseNormalDirection (bool) – New in version NX8.5.0.
License requirements: None.
SamplePoints¶
-
ConcaveFacesBuilder.
SamplePoints
¶ Returns or sets the number of sample points to apply to the analysis.
-------------------------------------
Getter Method
Signature
SamplePoints
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SamplePoints
Parameters: samplePoints (int) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Upper¶
-
ConcaveFacesBuilder.
Upper
¶ Returns the upper limit of the maximum concave range.
-------------------------------------
Getter Method
Signature
Upper
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
UseSurfaceNormal¶
-
ConcaveFacesBuilder.
UseSurfaceNormal
¶ Returns or sets the surface normal vector toggle
-------------------------------------
Getter Method
Signature
UseSurfaceNormal
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UseSurfaceNormal
Parameters: useSuraceNormal (bool) – New in version NX8.5.0.
License requirements: None.
Method Detail¶
CalculatePointCurvature¶
-
ConcaveFacesBuilder.
CalculatePointCurvature
¶ The radius values at the point selected on a targeted face, the maximum and minimum radius of the targeted face.
Signature
CalculatePointCurvature(faceId, point)
Parameters: - faceId (
NXOpen.Face
) – the targeted face - point (
NXOpen.Point3d
) – the point selected on targeted face
Returns: a tuple
Return type: A tuple consisting of (radius, minRadius, maxRadius) radius is a float. the value at point selected minRadius is a float. the minimum value of targeted face maxRadius is a float. the maximum value of targeted face
New in version NX9.0.0.
License requirements: None.
- faceId (
SetFaceAttributeColor¶
SetFaceGroupAttributeTitle¶
-
ConcaveFacesBuilder.
SetFaceGroupAttributeTitle
¶ Set face group attribute title.
Signature
SetFaceGroupAttributeTitle(grpAttributeTitle)
Parameters: grpAttributeTitle (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetFaceGroupAttributeValue¶
-
ConcaveFacesBuilder.
SetFaceGroupAttributeValue
¶ Set face group attribute value.
Signature
SetFaceGroupAttributeValue(grpAttributeValue)
Parameters: grpAttributeValue (str) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
SetTreeSelectedIndex¶
-
ConcaveFacesBuilder.
SetTreeSelectedIndex
¶ Set face indexes in tree list.
Signature
SetTreeSelectedIndex(indexArray)
Parameters: indexArray (list of int) – New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
UpdateLocationLabel¶
-
ConcaveFacesBuilder.
UpdateLocationLabel
¶ The PMI as a location label created or edited at the point selected on a face.
Signature
UpdateLocationLabel(edit, point)
Parameters: - edit (bool) – If true edit PMI, false create PMI
- point (
NXOpen.Point
) – the point selected on targeted face
New in version NX9.0.0.
License requirements: None.
UpdateRadiusFaces¶
-
ConcaveFacesBuilder.
UpdateRadiusFaces
¶ The targeted faces updated according to the given radius range, number of sample point and group interval changing.
Signature
UpdateRadiusFaces()
New in version NX9.0.0.
License requirements: None.
UpdateSelectedFacesColor¶
-
ConcaveFacesBuilder.
UpdateSelectedFacesColor
¶ Update selected faces color.
Signature
UpdateSelectedFacesColor()
New in version NX12.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
Validate¶
-
ConcaveFacesBuilder.
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.