NXOpen::Annotations::PmiGeneralSetupDisplayBuilder Class Reference

Represents a NXOpen.Annotations.PmiGeneralSetupDisplayBuilder. More...

Inheritance diagram for NXOpen::Annotations::PmiGeneralSetupDisplayBuilder:

Public Types
enum	AnnotationPlaneType { AnnotationPlaneTypeXYPlaneofWCS, AnnotationPlaneTypeXZPlaneofWCS, AnnotationPlaneTypeYZPlaneofWCS, AnnotationPlaneTypeModelViewPlane }
	the plane values which specify the annotation plane that will be used to display PMI. More...
enum	ResizeSettingsType { ResizeSettingsTypeRelativetoSavedViewScale, ResizeSettingsTypeRelativetoViewZoomFactor, ResizeSettingsTypeIndependently, ResizeSettingsTypeRelativetoPartPreferences }
	the resize values which specify the method used to resize PMI. More...

Public Member Functions
NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlaneType	AnnotationPlane ()
	Returns the annotation plane option which specifies the annotation plane that will be used to display PMI Created in NX1847.0.0. More...
bool	DisplayInAllViews ()
	Returns the display in all views option which determines whether or not PMI should be displayed in all views on create. More...
bool	DisplayPmiShadedModel ()
	Returns the display pmi shaded model toggle option which determines how a PMI is displayed in a shaded model. More...
bool	EnableResize ()
	Returns the enable resize toggle option which determines whether the resize function for PMI is enabled. More...
bool	ResizeOnCreate ()
	Returns the resize on create toggle option which determines whether the PMI are resized when they are created. More...
bool	ResizeOnViewSave ()
	Returns the resize on view save toggle option which determines whether the PMI are resized during a view save operation. More...
NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettingsType	ResizeSettings ()
	Returns the resize settings option specifies the method used to resize PMI. More...
void	SetAnnotationPlane (NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlaneType annotationPlane)
	Sets the annotation plane option which specifies the annotation plane that will be used to display PMI Created in NX1847.0.0. More...
void	SetDisplayInAllViews (bool displayInAllViews)
	Sets the display in all views option which determines whether or not PMI should be displayed in all views on create. More...
void	SetDisplayPmiShadedModel (bool displayPmiShadedModel)
	Sets the display pmi shaded model toggle option which determines how a PMI is displayed in a shaded model. More...
void	SetEnableResize (bool enableResize)
	Sets the enable resize toggle option which determines whether the resize function for PMI is enabled. More...
void	SetResizeOnCreate (bool resizeOnCreate)
	Sets the resize on create toggle option which determines whether the PMI are resized when they are created. More...
void	SetResizeOnViewSave (bool resizeOnViewSave)
	Sets the resize on view save toggle option which determines whether the PMI are resized during a view save operation. More...
void	SetResizeSettings (NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettingsType resizeSettings)
	Sets the resize settings option specifies the method used to resize PMI. More...
void	SetUpdateReadingDirection (bool updateReadingDirection)
	Sets the update reading direction toggle option which determines whether or not PMI text reading direction should be updated in response to view rotation. More...
bool	UpdateReadingDirection ()
	Returns the update reading direction toggle option which determines whether or not PMI text reading direction should be updated in response to view rotation. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen.Annotations.PmiGeneralSetupDisplayBuilder.

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlaneType

the plane values which specify the annotation plane that will be used to display PMI.

Enumerator
AnnotationPlaneTypeXYPlaneofWCS	the plane value which represents XY Plane of WCS type
AnnotationPlaneTypeXZPlaneofWCS	the plane value which represents XZ Plane of WCS type
AnnotationPlaneTypeYZPlaneofWCS	the plane value which represents YZ Plane of WCS type
AnnotationPlaneTypeModelViewPlane	the plane value which represents Model View Plane type

enum NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettingsType

the resize values which specify the method used to resize PMI.

Enumerator
ResizeSettingsTypeRelativetoSavedViewScale	the resize value which represents 'Settings Relative to Saved View Scale' type
ResizeSettingsTypeRelativetoViewZoomFactor	the resize value which represents 'Settings Relative to View Zoom Factor' type
ResizeSettingsTypeIndependently	the resize value which represents 'Independent of Settings' type
ResizeSettingsTypeRelativetoPartPreferences	the resize value which represents 'Settings Relative to Part Preferences' type

Member Function Documentation

NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlaneType NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlane

(

)

Returns the annotation plane option which specifies the annotation plane that will be used to display PMI
Created in NX1847.0.0.

License requirements : None

bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::DisplayInAllViews

(

)

Returns the display in all views option which determines whether or not PMI should be displayed in all views on create.

Created in NX1847.0.0.

License requirements : None

bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::DisplayPmiShadedModel

(

)

Returns the display pmi shaded model toggle option which determines how a PMI is displayed in a shaded model.

When turned on, PMI will show through the shaded model.
Created in NX1847.0.0.

License requirements : None

bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::EnableResize

(

)

Returns the enable resize toggle option which determines whether the resize function for PMI is enabled.

Created in NX1847.0.0.

License requirements : None

bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeOnCreate

(

)

Returns the resize on create toggle option which determines whether the PMI are resized when they are created.

Created in NX1847.0.0.

License requirements : None

bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeOnViewSave

(

)

Returns the resize on view save toggle option which determines whether the PMI are resized during a view save operation.

Created in NX1847.0.0.

License requirements : None

NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettingsType NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettings

(

)

Returns the resize settings option specifies the method used to resize PMI.

Created in NX1847.0.0.

License requirements : None

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetAnnotationPlane

(

NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::AnnotationPlaneType

annotationPlane

)

Sets the annotation plane option which specifies the annotation plane that will be used to display PMI
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

annotationPlane

annotationplane

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetDisplayInAllViews

(

bool

displayInAllViews

)

Sets the display in all views option which determines whether or not PMI should be displayed in all views on create.

Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

displayInAllViews

displayinallviews

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetDisplayPmiShadedModel

(

bool

displayPmiShadedModel

)

Sets the display pmi shaded model toggle option which determines how a PMI is displayed in a shaded model.

When turned on, PMI will show through the shaded model.
Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

displayPmiShadedModel

displaypmishadedmodel

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetEnableResize

(

bool

enableResize

)

Sets the enable resize toggle option which determines whether the resize function for PMI is enabled.

Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

enableResize

enableresize

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetResizeOnCreate

(

bool

resizeOnCreate

)

Sets the resize on create toggle option which determines whether the PMI are resized when they are created.

Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

resizeOnCreate

resizeoncreate

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetResizeOnViewSave

(

bool

resizeOnViewSave

)

Sets the resize on view save toggle option which determines whether the PMI are resized during a view save operation.

Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

resizeOnViewSave

resizeonviewsave

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetResizeSettings

(

NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::ResizeSettingsType

resizeSettings

)

Sets the resize settings option specifies the method used to resize PMI.

Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

resizeSettings

resizesettings

void NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::SetUpdateReadingDirection

(

bool

updateReadingDirection

)

Sets the update reading direction toggle option which determines whether or not PMI text reading direction should be updated in response to view rotation.

Created in NX1847.0.0.

License requirements : geometric_tol ("GDT") OR drafting ("DRAFTING")

Parameters

updateReadingDirection

updatereadingdirection

bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::UpdateReadingDirection

(

)

Returns the update reading direction toggle option which determines whether or not PMI text reading direction should be updated in response to view rotation.

Created in NX1847.0.0.

License requirements : None

virtual bool NXOpen::Annotations::PmiGeneralSetupDisplayBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• Annotations_PmiGeneralSetupDisplayBuilder.hxx