PmiPreferences Class¶
-
class
NXOpen.Annotations.
PmiPreferences
¶ Bases:
NXOpen.TransientObject
Represents line and arrow preferences
New in version NX4.0.0.
Properties¶
Property | Description |
---|---|
AssemblyCrosshatching | Returns the flag indicating whether PMI support for lightweight section view assembly crosshatching option is available |
AssociativityForLightweightSectionViews | Returns the option indicating whether plane is associative for Lightweight Section Views |
ClipCoplanarObjectsForLightweightSectionViews | Returns or sets the option indicating clip coplanar objects |
CreateViewIndependent | Returns or sets the flag indicating whether the PMI would be created view independent |
CrosshatchAdjacencyTolerance | Returns the flag indicating whether PMI support for lightweight section view crosshatch adjacency tolerance is available |
CuttingPlaneSymbolArrowDirection | Returns or sets the cutting plane symbol arrow direction related to plane |
CuttingPlaneSymbolArrowLength | Returns or sets the cutting plane symbol arrow length |
CuttingPlaneSymbolColor | Returns or sets the cutting plane symbol color |
CuttingPlaneSymbolSectionPrefix | Returns or sets the section prefix for cutting plane symbol |
CuttingPlaneSymbolShadedPlane | Returns or sets the cutting plane symbol shaded plane option |
CuttingPlaneSymbolStartingLetter | Returns or sets the starting letter for cutting plane symbol |
CuttingPlaneSymbolTextPlaneRelativeToArrow | Returns or sets the orientation of the cutting plane symbol text plane with respect to arrow plane |
DatumLabel | Returns or sets the initial letter for datum labels |
DefaultPlane | Returns or sets the default annotation plane for PMI symbols |
DisplayEffectivityFilterNodesInPartNavigator | Returns the flag indicating the display of Effectivity Filtered PMI node in Part Navigator |
DisplayPmiAssociatedComponentsLoadedForReference | Returns the flag indicating PMI associated objects components loaded for reference |
DisplayPmiEffectivityMethod | Returns the value indicating precise option of PMI Effectivity for prime geometry |
DisplayPmiEffectivityReferenceMethod | Returns the value indicating precise option of PMI Effectivity for reference geometry |
DisplayPmiQueryDialogFromMb3 | Returns or sets the PMI query dialog visibility from mb3 option |
EnableResize | Returns the flag indicating whether to enable resize. |
PmiRegionHeight | Returns or sets the rectangular region height |
PmiRegionInnerDiameter | Returns or sets the circular/annular region inner diameter |
PmiRegionOuterDiameter | Returns or sets the circular/annular region outer diameter |
PmiRegionWidth | Returns or sets the rectangular region width |
PmiSupportForGeometrySharing | Returns the flag indicating whether PMI support for geometry sharing is available |
RegionBoundaryColor | Returns or sets the region boundary color |
RegionBoundaryFont | Returns or sets the region boundary font |
RegionBoundaryWidth | Returns or sets the region boundary width |
ResizeMethod | Returns the resize method |
ResizeOnCreate | Returns the flag indicating whether to resize on create |
ResizeOnViewSave | Returns the flag indicating whether to resize on view save |
RestrictCrosshatchAngle | Returns the flag indicating whether PMI support for lightweight section view restrict crosshatch angle option is available |
SectionViewNamePrefix | Returns or sets the Section View name prefix |
ShadedDisplay | Returns the toggle for display through shaded models |
Methods¶
Property Detail¶
AssemblyCrosshatching¶
-
PmiPreferences.
AssemblyCrosshatching
¶ Returns the flag indicating whether PMI support for lightweight section view assembly crosshatching option is available
-------------------------------------
Getter Method
Signature
AssemblyCrosshatching()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
AssociativityForLightweightSectionViews¶
-
PmiPreferences.
AssociativityForLightweightSectionViews
¶ Returns the option indicating whether plane is associative for Lightweight Section Views
-------------------------------------
Getter Method
Signature
AssociativityForLightweightSectionViews()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
ClipCoplanarObjectsForLightweightSectionViews¶
-
PmiPreferences.
ClipCoplanarObjectsForLightweightSectionViews
¶ Returns or sets the option indicating clip coplanar objects
-------------------------------------
Getter Method
Signature
ClipCoplanarObjectsForLightweightSectionViews()
Returns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ClipCoplanarObjectsForLightweightSectionViews(clipCoplanarObjectsOptionForLightweightSectionViews)
Parameters: clipCoplanarObjectsOptionForLightweightSectionViews (bool) – New in version NX11.0.0.
License requirements: None.
CreateViewIndependent¶
-
PmiPreferences.
CreateViewIndependent
¶ Returns or sets the flag indicating whether the PMI would be created view independent
-------------------------------------
Getter Method
Signature
CreateViewIndependent()
Returns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateViewIndependent(createViewIndependent)
Parameters: createViewIndependent (bool) – New in version NX5.0.0.
License requirements: None.
CrosshatchAdjacencyTolerance¶
-
PmiPreferences.
CrosshatchAdjacencyTolerance
¶ Returns the flag indicating whether PMI support for lightweight section view crosshatch adjacency tolerance is available
-------------------------------------
Getter Method
Signature
CrosshatchAdjacencyTolerance()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
CuttingPlaneSymbolArrowDirection¶
-
PmiPreferences.
CuttingPlaneSymbolArrowDirection
¶ Returns or sets the cutting plane symbol arrow direction related to plane
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolArrowDirection()
Returns: Return type: NXOpen.Annotations.CuttingPlaneSymbolBuilderArrowDirectionOption
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolArrowDirection(arrowDirection)
Parameters: arrowDirection ( NXOpen.Annotations.CuttingPlaneSymbolBuilderArrowDirectionOption
) –New in version NX11.0.0.
License requirements: None.
CuttingPlaneSymbolArrowLength¶
-
PmiPreferences.
CuttingPlaneSymbolArrowLength
¶ Returns or sets the cutting plane symbol arrow length
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolArrowLength()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolArrowLength(arrowLength)
Parameters: arrowLength (float) – New in version NX9.0.0.
License requirements: None.
CuttingPlaneSymbolColor¶
-
PmiPreferences.
CuttingPlaneSymbolColor
¶ Returns or sets the cutting plane symbol color
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolColor()
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolColor(color)
Parameters: color (Id) – New in version NX9.0.0.
License requirements: None.
CuttingPlaneSymbolSectionPrefix¶
-
PmiPreferences.
CuttingPlaneSymbolSectionPrefix
¶ Returns or sets the section prefix for cutting plane symbol
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolSectionPrefix()
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolSectionPrefix(sectionPrefix)
Parameters: sectionPrefix (str) – New in version NX9.0.0.
License requirements: None.
CuttingPlaneSymbolShadedPlane¶
-
PmiPreferences.
CuttingPlaneSymbolShadedPlane
¶ Returns or sets the cutting plane symbol shaded plane option
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolShadedPlane()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolShadedPlane(shadedPlane)
Parameters: shadedPlane (bool) – New in version NX9.0.0.
License requirements: None.
CuttingPlaneSymbolStartingLetter¶
-
PmiPreferences.
CuttingPlaneSymbolStartingLetter
¶ Returns or sets the starting letter for cutting plane symbol
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolStartingLetter()
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolStartingLetter(startingLetter)
Parameters: startingLetter (str) – New in version NX9.0.0.
License requirements: None.
CuttingPlaneSymbolTextPlaneRelativeToArrow¶
-
PmiPreferences.
CuttingPlaneSymbolTextPlaneRelativeToArrow
¶ Returns or sets the orientation of the cutting plane symbol text plane with respect to arrow plane
-------------------------------------
Getter Method
Signature
CuttingPlaneSymbolTextPlaneRelativeToArrow()
Returns: Return type: NXOpen.Annotations.CuttingPlaneSymbolBuilderTextPlaneRelativeArrow
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPlaneSymbolTextPlaneRelativeToArrow(textPlaneRelativeArrow)
Parameters: textPlaneRelativeArrow ( NXOpen.Annotations.CuttingPlaneSymbolBuilderTextPlaneRelativeArrow
) –New in version NX9.0.0.
License requirements: None.
DatumLabel¶
-
PmiPreferences.
DatumLabel
¶ Returns or sets the initial letter for datum labels
-------------------------------------
Getter Method
Signature
DatumLabel()
Returns: Return type: str New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DatumLabel(datumLabel)
Parameters: datumLabel (str) – New in version NX4.0.0.
License requirements: None.
DefaultPlane¶
-
PmiPreferences.
DefaultPlane
¶ Returns or sets the default annotation plane for PMI symbols
-------------------------------------
Getter Method
Signature
DefaultPlane()
Returns: Return type: NXOpen.Annotations.PmiDefaultPlane
New in version NX4.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DefaultPlane(defaultPlane)
Parameters: defaultPlane ( NXOpen.Annotations.PmiDefaultPlane
) –New in version NX4.0.0.
License requirements: None.
DisplayPmiAssociatedComponentsLoadedForReference¶
-
PmiPreferences.
DisplayPmiAssociatedComponentsLoadedForReference
¶ Returns the flag indicating PMI associated objects components loaded for reference
-------------------------------------
Getter Method
Signature
DisplayPmiAssociatedComponentsLoadedForReference()
Returns: Return type: bool New in version NX8.5.1.
License requirements: None.
DisplayPmiEffectivityMethod¶
-
PmiPreferences.
DisplayPmiEffectivityMethod
¶ Returns the value indicating precise option of PMI Effectivity for prime geometry
-------------------------------------
Getter Method
Signature
DisplayPmiEffectivityMethod()
Returns: Return type: NXOpen.Annotations.DisplayPmiEffectivityMethod
New in version NX8.5.1.
License requirements: None.
DisplayPmiEffectivityReferenceMethod¶
-
PmiPreferences.
DisplayPmiEffectivityReferenceMethod
¶ Returns the value indicating precise option of PMI Effectivity for reference geometry
-------------------------------------
Getter Method
Signature
DisplayPmiEffectivityReferenceMethod()
Returns: Return type: NXOpen.Annotations.DisplayPmiEffectivityMethod
New in version NX8.5.1.
License requirements: None.
DisplayPmiQueryDialogFromMb3¶
-
PmiPreferences.
DisplayPmiQueryDialogFromMb3
¶ Returns or sets the PMI query dialog visibility from mb3 option
-------------------------------------
Getter Method
Signature
DisplayPmiQueryDialogFromMb3()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayPmiQueryDialogFromMb3(withDialog)
Parameters: withDialog (bool) – New in version NX8.5.0.
License requirements: None.
EnableResize¶
-
PmiPreferences.
EnableResize
¶ Returns the flag indicating whether to enable resize.
If true the resize command is enabled.
-------------------------------------
Getter Method
Signature
EnableResize()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
PmiRegionHeight¶
-
PmiPreferences.
PmiRegionHeight
¶ Returns or sets the rectangular region height
-------------------------------------
Getter Method
Signature
PmiRegionHeight()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PmiRegionHeight(height)
Parameters: height (float) – New in version NX6.0.0.
License requirements: None.
PmiRegionInnerDiameter¶
-
PmiPreferences.
PmiRegionInnerDiameter
¶ Returns or sets the circular/annular region inner diameter
-------------------------------------
Getter Method
Signature
PmiRegionInnerDiameter()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PmiRegionInnerDiameter(innerDiameter)
Parameters: innerDiameter (float) – New in version NX6.0.0.
License requirements: None.
PmiRegionOuterDiameter¶
-
PmiPreferences.
PmiRegionOuterDiameter
¶ Returns or sets the circular/annular region outer diameter
-------------------------------------
Getter Method
Signature
PmiRegionOuterDiameter()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PmiRegionOuterDiameter(outerDiameter)
Parameters: outerDiameter (float) – New in version NX6.0.0.
License requirements: None.
PmiRegionWidth¶
-
PmiPreferences.
PmiRegionWidth
¶ Returns or sets the rectangular region width
-------------------------------------
Getter Method
Signature
PmiRegionWidth()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PmiRegionWidth(width)
Parameters: width (float) – New in version NX6.0.0.
License requirements: None.
PmiSupportForGeometrySharing¶
-
PmiPreferences.
PmiSupportForGeometrySharing
¶ Returns the flag indicating whether PMI support for geometry sharing is available
-------------------------------------
Getter Method
Signature
PmiSupportForGeometrySharing()
Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
RegionBoundaryColor¶
-
PmiPreferences.
RegionBoundaryColor
¶ Returns or sets the region boundary color
-------------------------------------
Getter Method
Signature
RegionBoundaryColor()
Returns: Return type: Id New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionBoundaryColor(boundaryColor)
Parameters: boundaryColor (Id) – New in version NX11.0.0.
License requirements: None.
RegionBoundaryFont¶
-
PmiPreferences.
RegionBoundaryFont
¶ Returns or sets the region boundary font
-------------------------------------
Getter Method
Signature
RegionBoundaryFont()
Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionBoundaryFont(boundaryFont)
Parameters: boundaryFont (int) – New in version NX11.0.0.
License requirements: None.
RegionBoundaryWidth¶
-
PmiPreferences.
RegionBoundaryWidth
¶ Returns or sets the region boundary width
-------------------------------------
Getter Method
Signature
RegionBoundaryWidth()
Returns: Return type: int New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
RegionBoundaryWidth(boundaryWidth)
Parameters: boundaryWidth (int) – New in version NX11.0.0.
License requirements: None.
ResizeMethod¶
-
PmiPreferences.
ResizeMethod
¶ Returns the resize method
-------------------------------------
Getter Method
Signature
ResizeMethod()
Returns: Return type: NXOpen.Annotations.PmiResizeMethod
New in version NX8.0.0.
License requirements: None.
ResizeOnCreate¶
-
PmiPreferences.
ResizeOnCreate
¶ Returns the flag indicating whether to resize on create
-------------------------------------
Getter Method
Signature
ResizeOnCreate()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
ResizeOnViewSave¶
-
PmiPreferences.
ResizeOnViewSave
¶ Returns the flag indicating whether to resize on view save
-------------------------------------
Getter Method
Signature
ResizeOnViewSave()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
RestrictCrosshatchAngle¶
-
PmiPreferences.
RestrictCrosshatchAngle
¶ Returns the flag indicating whether PMI support for lightweight section view restrict crosshatch angle option is available
-------------------------------------
Getter Method
Signature
RestrictCrosshatchAngle()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
SectionViewNamePrefix¶
-
PmiPreferences.
SectionViewNamePrefix
¶ Returns or sets the Section View name prefix
-------------------------------------
Getter Method
Signature
SectionViewNamePrefix()
Returns: Return type: str New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SectionViewNamePrefix(sectionViewNamePrefix)
Parameters: sectionViewNamePrefix (str) – New in version NX11.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
PmiPreferences.
Dispose
¶ Frees the object from memory.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Signature
Dispose()
New in version NX4.0.0.
License requirements: None.
SetAssemblyCrosshatching¶
-
PmiPreferences.
SetAssemblyCrosshatching
¶ Signature
SetAssemblyCrosshatching(assemblyCrosshatching)
Parameters: assemblyCrosshatching (bool) – New in version NX9.0.0.
License requirements: None.
SetAssociativityForLightweightSectionViews¶
-
PmiPreferences.
SetAssociativityForLightweightSectionViews
¶ Signature
SetAssociativityForLightweightSectionViews(associativityOptionForLightweightSectionViews)
Parameters: associativityOptionForLightweightSectionViews (bool) – New in version NX9.0.0.
License requirements: None.
SetCrosshatchAdjacencyTolerance¶
-
PmiPreferences.
SetCrosshatchAdjacencyTolerance
¶ Signature
SetCrosshatchAdjacencyTolerance(crosshatchAdjacencyTolerance)
Parameters: crosshatchAdjacencyTolerance (float) – New in version NX9.0.0.
License requirements: None.
SetDisplayPmiAssociatedComponentsLoadedForReference¶
-
PmiPreferences.
SetDisplayPmiAssociatedComponentsLoadedForReference
¶ Signature
SetDisplayPmiAssociatedComponentsLoadedForReference(displayPmiAssociatedComponentsLoadedForReference)
Parameters: displayPmiAssociatedComponentsLoadedForReference (bool) – New in version NX8.5.1.
License requirements: nx_pmi_effectivity (“NX PMI EFFECTIVITY”)
SetDisplayPmiEffectivityMethod¶
-
PmiPreferences.
SetDisplayPmiEffectivityMethod
¶ Signature
SetDisplayPmiEffectivityMethod(displayPmiEffectivityMethod)
Parameters: displayPmiEffectivityMethod ( NXOpen.Annotations.DisplayPmiEffectivityMethod
) –New in version NX8.5.1.
License requirements: nx_pmi_effectivity (“NX PMI EFFECTIVITY”)
SetDisplayPmiEffectivityReferenceMethod¶
-
PmiPreferences.
SetDisplayPmiEffectivityReferenceMethod
¶ Signature
SetDisplayPmiEffectivityReferenceMethod(displayPmiEffectivityReferenceMethod)
Parameters: displayPmiEffectivityReferenceMethod ( NXOpen.Annotations.DisplayPmiEffectivityMethod
) –New in version NX8.5.1.
License requirements: nx_pmi_effectivity (“NX PMI EFFECTIVITY”)
SetEnableResize¶
-
PmiPreferences.
SetEnableResize
¶ Signature
SetEnableResize(enableResize)
Parameters: enableResize (bool) – New in version NX10.0.0.
License requirements: None.
SetPmiSupportForGeometrySharing¶
-
PmiPreferences.
SetPmiSupportForGeometrySharing
¶ Signature
SetPmiSupportForGeometrySharing(pmiSupportForGeomSharing)
Parameters: pmiSupportForGeomSharing (bool) – New in version NX8.5.0.
License requirements: None.
SetResizeMethod¶
-
PmiPreferences.
SetResizeMethod
¶ Signature
SetResizeMethod(resizeMethod)
Parameters: resizeMethod ( NXOpen.Annotations.PmiResizeMethod
) –New in version NX8.0.0.
License requirements: None.
SetResizeOnCreate¶
-
PmiPreferences.
SetResizeOnCreate
¶ Signature
SetResizeOnCreate(resizeOnCreate)
Parameters: resizeOnCreate (bool) – New in version NX8.0.0.
License requirements: None.
SetResizeOnViewSave¶
-
PmiPreferences.
SetResizeOnViewSave
¶ Signature
SetResizeOnViewSave(resizeOnViewSave)
Parameters: resizeOnViewSave (bool) – New in version NX8.0.0.
License requirements: None.