Represents line and arrow preferences
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Annotations::PmiPreferences:

Public Member Functions
bool	AssemblyCrosshatching ()
	Returns the flag indicating whether PMI support for lightweight section view assembly crosshatching option is available More...

bool	AssociativityForLightweightSectionViews ()
	Returns the option indicating whether plane is associative for Lightweight Section Views More...

bool	ClipCoplanarObjectsForLightweightSectionViews ()
	Returns the option indicating clip coplanar objects More...

bool	ClipWireframeObjects ()
	Returns the option indicating clip wireframe objects More...

bool	CreateViewIndependent ()
	Returns the flag indicating whether the PMI would be created view independent More...

double	CrosshatchAdjacencyTolerance ()
	Returns the flag indicating whether PMI support for lightweight section view crosshatch adjacency tolerance is available More...

NXOpen::Annotations::CuttingPlaneSymbolBuilder::ArrowDirectionOption	CuttingPlaneSymbolArrowDirection ()
	Returns the cutting plane symbol arrow direction related to plane More...

double	CuttingPlaneSymbolArrowLength ()
	Returns the cutting plane symbol arrow length More...

NXOpen::NXColor *	CuttingPlaneSymbolColor ()
	Returns the cutting plane symbol color More...

NXString	CuttingPlaneSymbolSectionPrefix ()
	Returns the section prefix for cutting plane symbol More...

bool	CuttingPlaneSymbolShadedPlane ()
	Returns the cutting plane symbol shaded plane option More...

NXString	CuttingPlaneSymbolStartingLetter ()
	Returns the starting letter for cutting plane symbol More...

NXOpen::Annotations::CuttingPlaneSymbolBuilder::TextPlaneRelativeArrow	CuttingPlaneSymbolTextPlaneRelativeToArrow ()
	Returns the orientation of the cutting plane symbol text plane with respect to arrow plane More...

NXString	DatumLabel ()
	Returns the initial letter for datum labels Created in NX4.0.0. More...

NXOpen::Annotations::PmiDefaultPlane	DefaultPlane ()
	Returns the default annotation plane for PMI symbols More...

bool	DeleteEmptyUserDefinedModelViews ()
	Returns the option to delete Empty User Defined Model Views in Part More...

bool	DisplayEffectivityFilterNodesInPartNavigator ()
	Returns the flag indicating the display of Effectivity Filtered PMI node in Part Navigator More...

bool	DisplayPmiAssociatedComponentsLoadedForReference ()
	Returns the flag indicating PMI associated objects components loaded for reference More...

NXOpen::Annotations::DisplayPmiEffectivityMethod	DisplayPmiEffectivityMethod ()
	Returns the value indicating precise option of PMI Effectivity for prime geometry More...

NXOpen::Annotations::DisplayPmiEffectivityMethod	DisplayPmiEffectivityReferenceMethod ()
	Returns the value indicating precise option of PMI Effectivity for reference geometry More...

NXString	DisplayPmiModelViewDisclosurePurpose ()
	Returns the Model View Disclosure Purpose More...

bool	DisplayPmiQueryDialogFromMb3 ()
	Returns the PMI query dialog visibility from mb3 option More...

bool	DisplayPmiUserDefinedModelViewDisclosure ()
	Returns the User Defined Model View Disclosure More...

bool	EnableResize ()
	Returns the flag indicating whether to enable resize. More...

void	GetParallelToScreenEnabledPmiTypes (std::vector< NXOpen::Annotations::PmiPreferences::PreferenceSymbolTypes > &parallelToScreenEnabledPmiTypes)
	The parallel to screen enabled pmi type More...

bool	LockSizeAndPosition ()
	Returns the lock pan/zoom option More...

bool	ParallelToScreen ()
	Returns the parallel to screen option More...

double	PmiRegionHeight ()
	Returns the rectangular region height More...

double	PmiRegionInnerDiameter ()
	Returns the circular/annular region inner diameter More...

double	PmiRegionOuterDiameter ()
	Returns the circular/annular region outer diameter More...

double	PmiRegionWidth ()
	Returns the rectangular region width More...

bool	PmiSupportForGeometrySharing ()
	Returns the flag indicating whether PMI support for geometry sharing is available More...

NXOpen::NXColor *	RegionBoundaryColor ()
	Returns the region boundary color Created in NX11.0.0. More...

int	RegionBoundaryFont ()
	Returns the region boundary font Created in NX11.0.0. More...

int	RegionBoundaryWidth ()
	Returns the region boundary width Created in NX11.0.0. More...

NXOpen::Annotations::PmiResizeMethod	ResizeMethod ()
	Returns the resize method More...

bool	ResizeOnCreate ()
	Returns the flag indicating whether to resize on create More...

bool	ResizeOnViewSave ()
	Returns the flag indicating whether to resize on view save More...

bool	RestrictCrosshatchAngle ()
	Returns the flag indicating whether PMI support for lightweight section view restrict crosshatch angle option is available More...

NXString	SectionViewNamePrefix ()
	Returns the Section View name prefix More...

void	SetAssemblyCrosshatching (bool assemblyCrosshatching)
	More...

void	SetAssociativityForLightweightSectionViews (bool associativityOptionForLightweightSectionViews)
	More...

void	SetClipCoplanarObjectsForLightweightSectionViews (bool clipCoplanarObjectsOptionForLightweightSectionViews)
	Sets the option indicating clip coplanar objects More...

void	SetClipWireframeObjects (bool clipWireframeObjectsOption)
	Sets the option indicating clip wireframe objects More...

void	SetCreateViewIndependent (bool createViewIndependent)
	Sets the flag indicating whether the PMI would be created view independent More...

void	SetCrosshatchAdjacencyTolerance (double crosshatchAdjacencyTolerance)
	More...

void	SetCuttingPlaneSymbolArrowDirection (NXOpen::Annotations::CuttingPlaneSymbolBuilder::ArrowDirectionOption arrowDirection)
	Sets the cutting plane symbol arrow direction related to plane More...

void	SetCuttingPlaneSymbolArrowLength (double arrowLength)
	Sets the cutting plane symbol arrow length More...

void	SetCuttingPlaneSymbolColor (NXOpen::NXColor *color)
	Sets the cutting plane symbol color More...

void	SetCuttingPlaneSymbolSectionPrefix (const NXString &sectionPrefix)
	Sets the section prefix for cutting plane symbol More...

void	SetCuttingPlaneSymbolSectionPrefix (const char *sectionPrefix)
	Sets the section prefix for cutting plane symbol More...

void	SetCuttingPlaneSymbolShadedPlane (bool shadedPlane)
	Sets the cutting plane symbol shaded plane option More...

void	SetCuttingPlaneSymbolStartingLetter (const NXString &startingLetter)
	Sets the starting letter for cutting plane symbol More...

void	SetCuttingPlaneSymbolStartingLetter (const char *startingLetter)
	Sets the starting letter for cutting plane symbol More...

void	SetCuttingPlaneSymbolTextPlaneRelativeToArrow (NXOpen::Annotations::CuttingPlaneSymbolBuilder::TextPlaneRelativeArrow textPlaneRelativeArrow)
	Sets the orientation of the cutting plane symbol text plane with respect to arrow plane More...

void	SetDatumLabel (const NXString &datumLabel)
	Sets the initial letter for datum labels Created in NX4.0.0. More...

void	SetDatumLabel (const char *datumLabel)
	Sets the initial letter for datum labels Created in NX4.0.0. More...

void	SetDefaultPlane (NXOpen::Annotations::PmiDefaultPlane defaultPlane)
	Sets the default annotation plane for PMI symbols More...

void	SetDeleteEmptyUserDefinedModelViews (bool deleteEmptyUserDefinedModelViews)
	Sets the option to delete Empty User Defined Model Views in Part More...

void	SetDisplayEffectivityFilterNodesInPartNavigator (bool displayEffectivityFilterNodesInPartNavigator)
	More...

void	SetDisplayPmiAssociatedComponentsLoadedForReference (bool displayPmiAssociatedComponentsLoadedForReference)
	More...

void	SetDisplayPmiEffectivityMethod (NXOpen::Annotations::DisplayPmiEffectivityMethod displayPmiEffectivityMethod)
	More...

void	SetDisplayPmiEffectivityReferenceMethod (NXOpen::Annotations::DisplayPmiEffectivityMethod displayPmiEffectivityReferenceMethod)
	More...

void	SetDisplayPmiModelViewDisclosurePurpose (const NXString &purpose)
	Sets the Model View Disclosure Purpose More...

void	SetDisplayPmiModelViewDisclosurePurpose (const char *purpose)
	Sets the Model View Disclosure Purpose More...

void	SetDisplayPmiQueryDialogFromMb3 (bool withDialog)
	Sets the PMI query dialog visibility from mb3 option More...

void	SetDisplayPmiUserDefinedModelViewDisclosure (bool withDialog)
	Sets the User Defined Model View Disclosure More...

void	SetEnableResize (bool enableResize)
	More...

void	SetLockSizeAndPosition (bool lockSizeAndPosition)
	Sets the lock pan/zoom option More...

void	SetParallelToScreen (bool parallelToScreen)
	Sets the parallel to screen option More...

void	SetParallelToScreenEnabledPmiTypes (const std::vector< NXOpen::Annotations::PmiPreferences::PreferenceSymbolTypes > &parallelToScreenEnabledPmiTypes)
	More...

void	SetPmiRegionHeight (double height)
	Sets the rectangular region height More...

void	SetPmiRegionInnerDiameter (double innerDiameter)
	Sets the circular/annular region inner diameter More...

void	SetPmiRegionOuterDiameter (double outerDiameter)
	Sets the circular/annular region outer diameter More...

void	SetPmiRegionWidth (double width)
	Sets the rectangular region width More...

void	SetPmiSupportForGeometrySharing (bool pmiSupportForGeomSharing)
	More...

void	SetRegionBoundaryColor (NXOpen::NXColor *boundaryColor)
	Sets the region boundary color Created in NX11.0.0. More...

void	SetRegionBoundaryFont (int boundaryFont)
	Sets the region boundary font Created in NX11.0.0. More...

void	SetRegionBoundaryWidth (int boundaryWidth)
	Sets the region boundary width Created in NX11.0.0. More...

void	SetResizeMethod (NXOpen::Annotations::PmiResizeMethod resizeMethod)
	More...

void	SetResizeOnCreate (bool resizeOnCreate)
	More...

void	SetResizeOnViewSave (bool resizeOnViewSave)
	More...

void	SetRestrictCrosshatchAngle (bool restrictCrosshatchAngle)
	More...

void	SetSectionViewNamePrefix (const NXString &sectionViewNamePrefix)
	Sets the Section View name prefix More...

void	SetSectionViewNamePrefix (const char *sectionViewNamePrefix)
	Sets the Section View name prefix More...

void	SetShadedDisplay (bool shadedDisplay)
	More...

void	SetSuppressRetainedPmis (bool suppressRetainedPmis)
	Sets the option to suppress retained PMIs in part More...

bool	ShadedDisplay ()
	Returns the toggle for display through shaded models More...

bool	SuppressRetainedPmis ()
	Returns the option to suppress retained PMIs in part More...

virtual	~PmiPreferences ()
	Frees the object from memory. More...

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object. More...

Detailed Description

Represents line and arrow preferences
Created in NX4.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::PmiPreferences::PreferenceSymbolTypes

Specifies the allowable symbol types for Parallel To Screen and Lock Pan/Zoom.

Enumerator
PreferenceSymbolTypesNote	note
PreferenceSymbolTypesGeneralNote	general note
PreferenceSymbolTypesSpecificNote	specific note
PreferenceSymbolTypesEnterpriseId	enterprise id
PreferenceSymbolTypesMaterialSpecification	material specification
PreferenceSymbolTypesPartId	part id
PreferenceSymbolTypesProcessSpecification	process specification
PreferenceSymbolTypesUrlNote	url note
PreferenceSymbolTypesStringNote	string note
PreferenceSymbolTypesNumberNote	number note
PreferenceSymbolTypesIntegerNote	integer note
PreferenceSymbolTypesBalloonNote	balloon note
PreferenceSymbolTypesCustomSymbol	custom symbol
PreferenceSymbolTypesGovernmentSecurityInfo	government security info
PreferenceSymbolTypesCompanySpecificProprietaryInfo	company specific proprietary info
PreferenceSymbolTypesExportControl	export control
PreferenceSymbolTypesTable	table
PreferenceSymbolTypesCoordinateNote	coordinate note

Constructor & Destructor Documentation

virtual NXOpen::Annotations::PmiPreferences::~PmiPreferences ( )

virtual

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.
Created in NX4.0.0.

License requirements : None

Member Function Documentation

bool NXOpen::Annotations::PmiPreferences::AssemblyCrosshatching ( )

Returns the flag indicating whether PMI support for lightweight section view assembly crosshatching option is available

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::AssemblyCrosshatching instead.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::AssociativityForLightweightSectionViews ( )

Returns the option indicating whether plane is associative for Lightweight Section Views

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::AssociativePlane instead.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::ClipCoplanarObjectsForLightweightSectionViews ( )

Returns the option indicating clip coplanar objects

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::ClipCoplanarObjects instead.

Created in NX11.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::ClipWireframeObjects ( )

Returns the option indicating clip wireframe objects

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::ClipWireframeObjects instead.

Created in NX11.0.1.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::CreateViewIndependent ( )

Returns the flag indicating whether the PMI would be created view independent

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::DisplayInAllViews instead.

Created in NX5.0.0.

License requirements : None

double NXOpen::Annotations::PmiPreferences::CrosshatchAdjacencyTolerance ( )

Returns the flag indicating whether PMI support for lightweight section view crosshatch adjacency tolerance is available

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::CrosshatchAdjacencyTolerance instead.

Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::CuttingPlaneSymbolBuilder::ArrowDirectionOption NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolArrowDirection ( )

Returns the cutting plane symbol arrow direction related to plane

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowDirection instead.

Created in NX11.0.0.

License requirements : None

double NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolArrowLength ( )

Returns the cutting plane symbol arrow length

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ArrowLineLength instead.

Created in NX9.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolColor ( )

Returns the cutting plane symbol color

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::Color instead.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolSectionPrefix ( )

Returns the section prefix for cutting plane symbol

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SectionPrefix instead.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolShadedPlane ( )

Returns the cutting plane symbol shaded plane option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::ShadedPlane instead.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolStartingLetter ( )

Returns the starting letter for cutting plane symbol

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::StartingLetter instead.

Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::CuttingPlaneSymbolBuilder::TextPlaneRelativeArrow NXOpen::Annotations::PmiPreferences::CuttingPlaneSymbolTextPlaneRelativeToArrow ( )

Returns the orientation of the cutting plane symbol text plane with respect to arrow plane

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::TextPlaneRelativeToArrow instead.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Annotations::PmiPreferences::DatumLabel ( )

Returns the initial letter for datum labels
Created in NX4.0.0.

License requirements : None

NXOpen::Annotations::PmiDefaultPlane NXOpen::Annotations::PmiPreferences::DefaultPlane ( )

Returns the default annotation plane for PMI symbols

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlane instead.

Created in NX4.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::DeleteEmptyUserDefinedModelViews ( )

Returns the option to delete Empty User Defined Model Views in Part

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::DeleteEmptyUserDefinedModelViews instead.

Created in NX12.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::DisplayEffectivityFilterNodesInPartNavigator ( )

Returns the flag indicating the display of Effectivity Filtered PMI node in Part Navigator

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::DisplayEffectivityFilteredNodes instead.

Created in NX8.5.1.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::DisplayPmiAssociatedComponentsLoadedForReference ( )

Returns the flag indicating PMI associated objects components loaded for reference

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::ComponentsLoadedForReference instead.

Created in NX8.5.1.

License requirements : None

NXOpen::Annotations::DisplayPmiEffectivityMethod NXOpen::Annotations::PmiPreferences::DisplayPmiEffectivityMethod ( )

Returns the value indicating precise option of PMI Effectivity for prime geometry

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::DisplayPmiAssociatedOnlyToPrimaryGeometry instead.

Created in NX8.5.1.

License requirements : None

NXOpen::Annotations::DisplayPmiEffectivityMethod NXOpen::Annotations::PmiPreferences::DisplayPmiEffectivityReferenceMethod ( )

Returns the value indicating precise option of PMI Effectivity for reference geometry

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::DisplayPmiAssociatedToReferenceGeometry instead.

Created in NX8.5.1.

License requirements : None

NXString NXOpen::Annotations::PmiPreferences::DisplayPmiModelViewDisclosurePurpose ( )

Returns the Model View Disclosure Purpose

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::DisclosurePurpose instead.

Created in NX12.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::DisplayPmiQueryDialogFromMb3 ( )

Returns the PMI query dialog visibility from mb3 option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::DisplayDialogBoxFromShortcut instead.

Created in NX8.5.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::DisplayPmiUserDefinedModelViewDisclosure ( )

Returns the User Defined Model View Disclosure

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::UserDefinedModelViews instead.

Created in NX12.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::EnableResize ( )

Returns the flag indicating whether to enable resize.

If true the resize command is enabled.

Deprecated:: Deprecated in NX1847.0.0. Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::EnableResize instead.

Created in NX10.0.0.

License requirements : None

void NXOpen::Annotations::PmiPreferences::GetParallelToScreenEnabledPmiTypes ( std::vector< NXOpen::Annotations::PmiPreferences::PreferenceSymbolTypes > & parallelToScreenEnabledPmiTypes )

The parallel to screen enabled pmi type

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupParallelToScreenBuilder::EnabledPmiTypes instead.

Created in NX11.0.1.

License requirements : None

Parameters

parallelToScreenEnabledPmiTypes paralleltoscreenenabledpmitypes

bool NXOpen::Annotations::PmiPreferences::LockSizeAndPosition ( )

Returns the lock pan/zoom option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupParallelToScreenBuilder::LockSizeAndPosition instead.

Created in NX11.0.1.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::ParallelToScreen ( )

Returns the parallel to screen option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupParallelToScreenBuilder::DisplayParallelToScreen instead.

Created in NX11.0.1.

License requirements : None

double NXOpen::Annotations::PmiPreferences::PmiRegionHeight ( )

Returns the rectangular region height

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::RegionHeight instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::PmiPreferences::PmiRegionInnerDiameter ( )

Returns the circular/annular region inner diameter

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::RegionInnerDiameter instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::PmiPreferences::PmiRegionOuterDiameter ( )

Returns the circular/annular region outer diameter

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::RegionOuterDiameter instead.

Created in NX6.0.0.

License requirements : None

double NXOpen::Annotations::PmiPreferences::PmiRegionWidth ( )

Returns the rectangular region width

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::RegionWidth instead.

Created in NX6.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::PmiSupportForGeometrySharing ( )

Returns the flag indicating whether PMI support for geometry sharing is available

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::PmiSupportForGeometrySharing instead.

Created in NX8.5.0.

License requirements : None

NXOpen::NXColor* NXOpen::Annotations::PmiPreferences::RegionBoundaryColor ( )

Returns the region boundary color
Created in NX11.0.0.

License requirements : None

int NXOpen::Annotations::PmiPreferences::RegionBoundaryFont ( )

Returns the region boundary font
Created in NX11.0.0.

License requirements : None

int NXOpen::Annotations::PmiPreferences::RegionBoundaryWidth ( )

Returns the region boundary width
Created in NX11.0.0.

License requirements : None

NXOpen::Annotations::PmiResizeMethod NXOpen::Annotations::PmiPreferences::ResizeMethod ( )

Returns the resize method

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettings instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::ResizeOnCreate ( )

Returns the flag indicating whether to resize on create

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeOnCreate instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::ResizeOnViewSave ( )

Returns the flag indicating whether to resize on view save

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeOnViewSave instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::RestrictCrosshatchAngle ( )

Returns the flag indicating whether PMI support for lightweight section view restrict crosshatch angle option is available

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::RestrictCrosshatchAngle instead.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Annotations::PmiPreferences::SectionViewNamePrefix ( )

Returns the Section View name prefix

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SectionNamePrefix instead.

Created in NX11.0.0.

License requirements : None

void NXOpen::Annotations::PmiPreferences::SetAssemblyCrosshatching ( bool assemblyCrosshatching )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetAssemblyCrosshatching instead.

Created in NX9.0.0.

License requirements : None

Parameters

assemblyCrosshatching assemblycrosshatching

void NXOpen::Annotations::PmiPreferences::SetAssociativityForLightweightSectionViews ( bool associativityOptionForLightweightSectionViews )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetAssociativePlane instead.

Created in NX9.0.0.

License requirements : None

Parameters

associativityOptionForLightweightSectionViews associativityoptionforlightweightsectionviews

void NXOpen::Annotations::PmiPreferences::SetClipCoplanarObjectsForLightweightSectionViews ( bool clipCoplanarObjectsOptionForLightweightSectionViews )

Sets the option indicating clip coplanar objects

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetClipCoplanarObjects instead.

Created in NX11.0.0.

License requirements : None

Parameters

clipCoplanarObjectsOptionForLightweightSectionViews clipcoplanarobjectsoptionforlightweightsectionviews

void NXOpen::Annotations::PmiPreferences::SetClipWireframeObjects ( bool clipWireframeObjectsOption )

Sets the option indicating clip wireframe objects

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetClipWireframeObjects instead.

Created in NX11.0.1.

License requirements : None

Parameters

clipWireframeObjectsOption clipwireframeobjectsoption

void NXOpen::Annotations::PmiPreferences::SetCreateViewIndependent ( bool createViewIndependent )

Sets the flag indicating whether the PMI would be created view independent

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetDisplayInAllViews instead.

Created in NX5.0.0.

License requirements : None

Parameters

createViewIndependent create view independent

void NXOpen::Annotations::PmiPreferences::SetCrosshatchAdjacencyTolerance ( double crosshatchAdjacencyTolerance )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetCrosshatchAdjacencyTolerance instead.

Created in NX9.0.0.

License requirements : None

Parameters

crosshatchAdjacencyTolerance crosshatchadjacencytolerance

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolArrowDirection ( NXOpen::Annotations::CuttingPlaneSymbolBuilder::ArrowDirectionOption arrowDirection )

Sets the cutting plane symbol arrow direction related to plane

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetArrowDirection instead.

Created in NX11.0.0.

License requirements : None

Parameters

arrowDirection arrowdirection

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolArrowLength ( double arrowLength )

Sets the cutting plane symbol arrow length

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetArrowLineLength instead.

Created in NX9.0.0.

License requirements : None

Parameters

arrowLength arrowlength

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolColor ( NXOpen::NXColor * color )

Sets the cutting plane symbol color

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetColor instead.

Created in NX9.0.0.

License requirements : None

Parameters

color color

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolSectionPrefix ( const NXString & sectionPrefix )

Sets the section prefix for cutting plane symbol

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetSectionPrefix instead.

Created in NX9.0.0.

License requirements : None

Parameters

sectionPrefix sectionprefix

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolSectionPrefix ( const char * sectionPrefix )

Sets the section prefix for cutting plane symbol

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetSectionPrefix instead.

Created in NX9.0.0.

License requirements : None

Parameters

sectionPrefix sectionprefix

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolShadedPlane ( bool shadedPlane )

Sets the cutting plane symbol shaded plane option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetShadedPlane instead.

Created in NX9.0.0.

License requirements : None

Parameters

shadedPlane shadedplane

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolStartingLetter ( const NXString & startingLetter )

Sets the starting letter for cutting plane symbol

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetStartingLetter instead.

Created in NX9.0.0.

License requirements : None

Parameters

startingLetter startingletter

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolStartingLetter ( const char * startingLetter )

Sets the starting letter for cutting plane symbol

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetStartingLetter instead.

Created in NX9.0.0.

License requirements : None

Parameters

startingLetter startingletter

void NXOpen::Annotations::PmiPreferences::SetCuttingPlaneSymbolTextPlaneRelativeToArrow ( NXOpen::Annotations::CuttingPlaneSymbolBuilder::TextPlaneRelativeArrow textPlaneRelativeArrow )

Sets the orientation of the cutting plane symbol text plane with respect to arrow plane

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewCuttingPlaneSymbolBuilder::SetTextPlaneRelativeToArrow instead.

Created in NX9.0.0.

License requirements : None

Parameters

textPlaneRelativeArrow textplanerelativearrow

void NXOpen::Annotations::PmiPreferences::SetDatumLabel ( const NXString & datumLabel )

Sets the initial letter for datum labels
Created in NX4.0.0.

License requirements : None

Parameters

datumLabel datum label

void NXOpen::Annotations::PmiPreferences::SetDatumLabel ( const char * datumLabel )

Sets the initial letter for datum labels
Created in NX4.0.0.

License requirements : None

Parameters

datumLabel datum label

void NXOpen::Annotations::PmiPreferences::SetDefaultPlane ( NXOpen::Annotations::PmiDefaultPlane defaultPlane )

Sets the default annotation plane for PMI symbols

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetAnnotationPlane instead.

Created in NX4.0.0.

License requirements : None

Parameters

defaultPlane default plane

void NXOpen::Annotations::PmiPreferences::SetDeleteEmptyUserDefinedModelViews ( bool deleteEmptyUserDefinedModelViews )

Sets the option to delete Empty User Defined Model Views in Part

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetDeleteEmptyUserDefinedModelViews instead.

Created in NX12.0.0.

License requirements : None

Parameters

deleteEmptyUserDefinedModelViews deleteemptyuserdefinedmodelviews

void NXOpen::Annotations::PmiPreferences::SetDisplayEffectivityFilterNodesInPartNavigator ( bool displayEffectivityFilterNodesInPartNavigator )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetDisplayEffectivityFilteredNodes instead.

Created in NX8.5.1.

License requirements : nx_pmi_effectivity ("NX PMI EFFECTIVITY")

Parameters

displayEffectivityFilterNodesInPartNavigator display effectivity filter nodes in part navigator

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiAssociatedComponentsLoadedForReference ( bool displayPmiAssociatedComponentsLoadedForReference )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetComponentsLoadedForReference instead.

Created in NX8.5.1.

License requirements : nx_pmi_effectivity ("NX PMI EFFECTIVITY")

Parameters

displayPmiAssociatedComponentsLoadedForReference display pmi associated components loaded for reference

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiEffectivityMethod ( NXOpen::Annotations::DisplayPmiEffectivityMethod displayPmiEffectivityMethod )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetDisplayPmiAssociatedOnlyToPrimaryGeometry instead.

Created in NX8.5.1.

License requirements : nx_pmi_effectivity ("NX PMI EFFECTIVITY")

Parameters

displayPmiEffectivityMethod display pmi effectivity method

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiEffectivityReferenceMethod ( NXOpen::Annotations::DisplayPmiEffectivityMethod displayPmiEffectivityReferenceMethod )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupEffectivityBuilder::SetDisplayPmiAssociatedToReferenceGeometry instead.

Created in NX8.5.1.

License requirements : nx_pmi_effectivity ("NX PMI EFFECTIVITY")

Parameters

displayPmiEffectivityReferenceMethod display pmi effectivity reference method

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiModelViewDisclosurePurpose ( const NXString & purpose )

Sets the Model View Disclosure Purpose

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetDisclosurePurpose instead.

Created in NX12.0.0.

License requirements : None

Parameters

purpose purpose

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiModelViewDisclosurePurpose ( const char * purpose )

Sets the Model View Disclosure Purpose

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetDisclosurePurpose instead.

Created in NX12.0.0.

License requirements : None

Parameters

purpose purpose

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiQueryDialogFromMb3 ( bool withDialog )

Sets the PMI query dialog visibility from mb3 option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetDisplayDialogBoxFromShortcut instead.

Created in NX8.5.0.

License requirements : None

Parameters

withDialog withdialog

void NXOpen::Annotations::PmiPreferences::SetDisplayPmiUserDefinedModelViewDisclosure ( bool withDialog )

Sets the User Defined Model View Disclosure

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetUserDefinedModelViews instead.

Created in NX12.0.0.

License requirements : None

Parameters

withDialog withdialog

void NXOpen::Annotations::PmiPreferences::SetEnableResize ( bool enableResize )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetEnableResize instead.

Created in NX10.0.0.

License requirements : None

Parameters

enableResize enable resize

void NXOpen::Annotations::PmiPreferences::SetLockSizeAndPosition ( bool lockSizeAndPosition )

Sets the lock pan/zoom option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupParallelToScreenBuilder::SetLockSizeAndPosition instead.

Created in NX11.0.1.

License requirements : None

Parameters

lockSizeAndPosition locksizeandposition

void NXOpen::Annotations::PmiPreferences::SetParallelToScreen ( bool parallelToScreen )

Sets the parallel to screen option

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupParallelToScreenBuilder::SetDisplayParallelToScreen instead.

Created in NX11.0.1.

License requirements : None

Parameters

parallelToScreen paralleltoscreen

void NXOpen::Annotations::PmiPreferences::SetParallelToScreenEnabledPmiTypes ( const std::vector< NXOpen::Annotations::PmiPreferences::PreferenceSymbolTypes > & parallelToScreenEnabledPmiTypes )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupParallelToScreenBuilder::SetEnabledPmiTypes instead.

Created in NX11.0.1.

License requirements : None

Parameters

parallelToScreenEnabledPmiTypes paralleltoscreenenabledpmitypes

void NXOpen::Annotations::PmiPreferences::SetPmiRegionHeight ( double height )

Sets the rectangular region height

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::SetRegionHeight instead.

Created in NX6.0.0.

License requirements : None

Parameters

height height

void NXOpen::Annotations::PmiPreferences::SetPmiRegionInnerDiameter ( double innerDiameter )

Sets the circular/annular region inner diameter

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::SetRegionInnerDiameter instead.

Created in NX6.0.0.

License requirements : None

Parameters

innerDiameter inner diameter

void NXOpen::Annotations::PmiPreferences::SetPmiRegionOuterDiameter ( double outerDiameter )

Sets the circular/annular region outer diameter

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::SetRegionOuterDiameter instead.

Created in NX6.0.0.

License requirements : None

Parameters

outerDiameter outer diameter

void NXOpen::Annotations::PmiPreferences::SetPmiRegionWidth ( double width )

Sets the rectangular region width

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSupplementalGeometryRegionBuilder::SetRegionWidth instead.

Created in NX6.0.0.

License requirements : None

Parameters

width width

void NXOpen::Annotations::PmiPreferences::SetPmiSupportForGeometrySharing ( bool pmiSupportForGeomSharing )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetPmiSupportForGeometrySharing instead.

Created in NX8.5.0.

License requirements : None

Parameters

pmiSupportForGeomSharing pmi support for geom sharing

void NXOpen::Annotations::PmiPreferences::SetRegionBoundaryColor ( NXOpen::NXColor * boundaryColor )

Sets the region boundary color
Created in NX11.0.0.

License requirements : None

Parameters

boundaryColor boundarycolor

void NXOpen::Annotations::PmiPreferences::SetRegionBoundaryFont ( int boundaryFont )

Sets the region boundary font
Created in NX11.0.0.

License requirements : None

Parameters

boundaryFont boundaryfont

void NXOpen::Annotations::PmiPreferences::SetRegionBoundaryWidth ( int boundaryWidth )

Sets the region boundary width
Created in NX11.0.0.

License requirements : None

Parameters

boundaryWidth boundarywidth

void NXOpen::Annotations::PmiPreferences::SetResizeMethod ( NXOpen::Annotations::PmiResizeMethod resizeMethod )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetResizeSettings instead.

Created in NX8.0.0.

License requirements : None

Parameters

resizeMethod resize method

void NXOpen::Annotations::PmiPreferences::SetResizeOnCreate ( bool resizeOnCreate )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetResizeOnCreate instead.

Created in NX8.0.0.

License requirements : None

Parameters

resizeOnCreate resize on create

void NXOpen::Annotations::PmiPreferences::SetResizeOnViewSave ( bool resizeOnViewSave )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetResizeOnViewSave instead.

Created in NX8.0.0.

License requirements : None

Parameters

resizeOnViewSave resize on view save

void NXOpen::Annotations::PmiPreferences::SetRestrictCrosshatchAngle ( bool restrictCrosshatchAngle )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetRestrictCrosshatchAngle instead.

Created in NX9.0.0.

License requirements : None

Parameters

restrictCrosshatchAngle restrictcrosshatchangle

void NXOpen::Annotations::PmiPreferences::SetSectionViewNamePrefix ( const NXString & sectionViewNamePrefix )

Sets the Section View name prefix

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetSectionNamePrefix instead.

Created in NX11.0.0.

License requirements : None

Parameters

sectionViewNamePrefix sectionviewnameprefix

void NXOpen::Annotations::PmiPreferences::SetSectionViewNamePrefix ( const char * sectionViewNamePrefix )

Sets the Section View name prefix

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiSectionViewViewBuilder::SetSectionNamePrefix instead.

Created in NX11.0.0.

License requirements : None

Parameters

sectionViewNamePrefix sectionviewnameprefix

void NXOpen::Annotations::PmiPreferences::SetShadedDisplay ( bool shadedDisplay )

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetDisplayPmiShadedModel instead.

Created in NX4.0.0.

License requirements : None

Parameters

shadedDisplay shaded display

void NXOpen::Annotations::PmiPreferences::SetSuppressRetainedPmis ( bool suppressRetainedPmis )

Sets the option to suppress retained PMIs in part

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SetSuppressRetainedPMI instead.

Created in NX12.0.0.

License requirements : None

Parameters

suppressRetainedPmis suppressretainedpmis

bool NXOpen::Annotations::PmiPreferences::ShadedDisplay ( )

Returns the toggle for display through shaded models

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::DisplayPmiShadedModel instead.

Created in NX4.0.0.

License requirements : None

bool NXOpen::Annotations::PmiPreferences::SuppressRetainedPmis ( )

Returns the option to suppress retained PMIs in part

Deprecated:: Deprecated in NX1847.0.0.

Use NXOpen::Annotations::PmiGeneralSetupGeneralBuilder::SuppressRetainedPMI instead.

Created in NX12.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Annotations_PmiPreferences.hxx

Public Types
enum	PreferenceSymbolTypes { PreferenceSymbolTypesNote, PreferenceSymbolTypesGeneralNote, PreferenceSymbolTypesSpecificNote, PreferenceSymbolTypesEnterpriseId, PreferenceSymbolTypesMaterialSpecification, PreferenceSymbolTypesPartId, PreferenceSymbolTypesProcessSpecification, PreferenceSymbolTypesUrlNote, PreferenceSymbolTypesStringNote, PreferenceSymbolTypesNumberNote, PreferenceSymbolTypesIntegerNote, PreferenceSymbolTypesBalloonNote, PreferenceSymbolTypesCustomSymbol, PreferenceSymbolTypesGovernmentSecurityInfo, PreferenceSymbolTypesCompanySpecificProprietaryInfo, PreferenceSymbolTypesExportControl, PreferenceSymbolTypesTable, PreferenceSymbolTypesCoordinateNote }
	Specifies the allowable symbol types for Parallel To Screen and Lock Pan/Zoom. More...

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation