AnnotationSettingsBuilder Class¶
-
class
NXOpen.Drawings.
AnnotationSettingsBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
Drawings.AnnotationSettingsBuilder
.This class queries and sets settings specific to drawings data which will get converted to PMIs.
New in version NX11.0.0.
Properties¶
Property | Description |
---|---|
ConvertToOriginalModelView | Returns or sets the convert to original model view |
LinearDimensionTolerance | Returns or sets the linear dimension tolerance |
PreserveDraftingLayer | Returns or sets the preserve drafting layer |
PreserveHiddenStatus | Returns or sets the preserve hidden status |
ProcessObjectsHidden | Returns or sets the process objects hidden |
Tag | Returns the Tag for this object. |
Units | Returns or sets the units |
Methods¶
Method | Description |
---|---|
SaveAnnotationType | API used to save settings data |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
AnnotationSettingsBuilderAnnotationTypeEnum Enumeration | enum is used to list out annotation types |
AnnotationSettingsBuilderUnitsEnum Enumeration | enum is used to list out different unit types |
Property Detail¶
ConvertToOriginalModelView¶
-
AnnotationSettingsBuilder.
ConvertToOriginalModelView
¶ Returns or sets the convert to original model view
-------------------------------------
Getter Method
Signature
ConvertToOriginalModelView()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ConvertToOriginalModelView(convertToOriginalModelView)
Parameters: convertToOriginalModelView (bool) – New in version NX11.0.0.
License requirements: convert_to_pmi (” Convert To PMI”), drafting (“DRAFTING”)
LinearDimensionTolerance¶
-
AnnotationSettingsBuilder.
LinearDimensionTolerance
¶ Returns or sets the linear dimension tolerance
-------------------------------------
Getter Method
Signature
LinearDimensionTolerance()
Returns: Return type: float New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LinearDimensionTolerance(linearDimensionTolerance)
Parameters: linearDimensionTolerance (float) – New in version NX11.0.0.
License requirements: convert_to_pmi (” Convert To PMI”), drafting (“DRAFTING”)
PreserveDraftingLayer¶
-
AnnotationSettingsBuilder.
PreserveDraftingLayer
¶ Returns or sets the preserve drafting layer
-------------------------------------
Getter Method
Signature
PreserveDraftingLayer()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PreserveDraftingLayer(preserveDraftingLayer)
Parameters: preserveDraftingLayer (bool) – New in version NX11.0.0.
License requirements: convert_to_pmi (” Convert To PMI”), drafting (“DRAFTING”)
Units¶
-
AnnotationSettingsBuilder.
Units
¶ Returns or sets the units
-------------------------------------
Getter Method
Signature
Units()
Returns: Return type: NXOpen.Drawings.AnnotationSettingsBuilderUnitsEnum
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Units(units)
Parameters: units ( NXOpen.Drawings.AnnotationSettingsBuilderUnitsEnum
) –New in version NX11.0.0.
License requirements: convert_to_pmi (” Convert To PMI”), drafting (“DRAFTING”)
Method Detail¶
SaveAnnotationType¶
-
AnnotationSettingsBuilder.
SaveAnnotationType
¶ API used to save settings data
Signature
SaveAnnotationType(annType, annValue)
Parameters: - annType (
NXOpen.Drawings.AnnotationSettingsBuilderAnnotationTypeEnum
) – - annValue (bool) –
New in version NX11.0.0.
License requirements: convert_to_pmi (” Convert To PMI”), drafting (“DRAFTING”)
- annType (
Validate¶
-
AnnotationSettingsBuilder.
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.