FaceAnnotationBuilder Class¶
-
class
NXOpen.Formboard.FaceAnnotationBuilder¶ Bases:
NXOpen.BuilderBuilder for Face Annotation functionality used in formboard.
It allows importing CGM or Pattern file geometry and placing it on a drawing sheet or model view. As a result of this a group of dumb geometry is placed such that defined origin is located at the lower left hand of the bounding box containing the group of geometry.
To create a new instance of this class, use
NXOpen.Formboard.FormboardManager.CreateFaceAnnotationBuilder()Default values.
Property Value DestEnum DrawingSheet TogBlank 0 New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| CgmflBrsr | Returns or sets the browser which enables selection of CGM file when Formboard.FaceAnnotationBuilderTypes is :py:class:` Formboard.FaceAnnotationBuilderTypes.CgmFileSelection < Formboard.FaceAnnotationBuilderTypes>`. |
| CompSel | Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined. |
| DestEnum | Returns or sets the NXOpen.Formboard.FaceAnnotationBuilderDrwDestination selected by user to place the geometry |
| PntOrigin | Returns or sets the user selected point where geometry will be placed |
| StrAnnot | Returns or sets the string to display the name of Pattern file name selected by user. |
| StrAnnotFileName | Returns or sets the string to display the name of CGM name selected by user. |
| Tag | Returns the Tag for this object. |
| TogBlank | Returns or sets the toggle which defines whether the selected component is to be blanked or not |
| Type | Returns or sets the NXOpen.Formboard.FaceAnnotationBuilderTypes selected by user |
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¶
| FaceAnnotationBuilderDrwDestination Enumeration | Enum which defines where the geometry is to be placed. |
| FaceAnnotationBuilderTypes Enumeration | Enum which defines the type to import CGM/Pattern file |
Property Detail¶
CgmflBrsr¶
-
FaceAnnotationBuilder.CgmflBrsr¶ Returns or sets the browser which enables selection of CGM file when
Formboard.FaceAnnotationBuilderTypesis :py:class:` Formboard.FaceAnnotationBuilderTypes.CgmFileSelection < Formboard.FaceAnnotationBuilderTypes>`.-------------------------------------Getter Method
Signature
CgmflBrsrReturns: Return type: str New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
CgmflBrsrParameters: filename (str) – New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
CompSel¶
-
FaceAnnotationBuilder.CompSel¶ Returns the user selected component which has a CGM_FILE or PATTERN_FILE attribute defined.
-------------------------------------Getter Method
Signature
CompSelReturns: Return type: NXOpen.SelectNXObjectNew in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
DestEnum¶
-
FaceAnnotationBuilder.DestEnum¶ Returns or sets the
NXOpen.Formboard.FaceAnnotationBuilderDrwDestinationselected by user to place the geometry-------------------------------------Getter Method
Signature
DestEnumReturns: Return type: NXOpen.Formboard.FaceAnnotationBuilderDrwDestinationNew in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
DestEnumParameters: destEnum ( NXOpen.Formboard.FaceAnnotationBuilderDrwDestination) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
PntOrigin¶
-
FaceAnnotationBuilder.PntOrigin¶ Returns or sets the user selected point where geometry will be placed
-------------------------------------Getter Method
Signature
PntOriginReturns: Return type: NXOpen.PointNew in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
PntOriginParameters: pntOrigin ( NXOpen.Point) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
StrAnnot¶
-
FaceAnnotationBuilder.StrAnnot¶ Returns or sets the string to display the name of Pattern file name selected by user.
-------------------------------------Getter Method
Signature
StrAnnotReturns: Return type: str New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
StrAnnotParameters: strAnnot (str) – New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
StrAnnotFileName¶
-
FaceAnnotationBuilder.StrAnnotFileName¶ Returns or sets the string to display the name of CGM name selected by user.
-------------------------------------Getter Method
Signature
StrAnnotFileNameReturns: Return type: str New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
StrAnnotFileNameParameters: strAnnot (str) – New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
TogBlank¶
-
FaceAnnotationBuilder.TogBlank¶ Returns or sets the toggle which defines whether the selected component is to be blanked or not
-------------------------------------Getter Method
Signature
TogBlankReturns: Return type: bool New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
TogBlankParameters: togBlank (bool) – New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Type¶
-
FaceAnnotationBuilder.Type¶ Returns or sets the
NXOpen.Formboard.FaceAnnotationBuilderTypesselected by user-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.Formboard.FaceAnnotationBuilderTypesNew in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
-------------------------------------Setter Method
Signature
TypeParameters: type ( NXOpen.Formboard.FaceAnnotationBuilderTypes) –New in version NX7.5.0.
License requirements: routing_harness (“Routing Harness”)
Method Detail¶
Validate¶
-
FaceAnnotationBuilder.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.