NXOpen::Drawings::AnnotationSettingsBuilder Class Reference

Represents a Drawings::AnnotationSettingsBuilder . More...

Inheritance diagram for NXOpen::Drawings::AnnotationSettingsBuilder:

Public Types
enum	AnnotationTypeEnum {   AnnotationTypeEnumDimension, AnnotationTypeEnumNote, AnnotationTypeEnumFeatureControlFrame, AnnotationTypeEnumDatumFeatureSymbol,   AnnotationTypeEnumDatumTarget, AnnotationTypeEnumBalloon, AnnotationTypeEnumSurfaceFinishSymbol, AnnotationTypeEnumWeldSymbol,   AnnotationTypeEnumCustomSymbol, AnnotationTypeEnumCenterLine, AnnotationTypeEnumUserDefinedSymbol, AnnotationTypeEnumMaxAnnotationYypes }
	enum is used to list out annotation types More...
enum	UnitsEnum { UnitsEnumUseTargetPartUnits, UnitsEnumUseDrawingUnits }
	enum is used to list out different unit types More...

Public Member Functions
bool	ConvertToOriginalModelView ()
	Returns the convert to original model view Created in NX11.0.0. More...
double	LinearDimensionTolerance ()
	Returns the linear dimension tolerance Created in NX11.0.0. More...
bool	PreserveDraftingLayer ()
	Returns the preserve drafting layer Created in NX11.0.0. More...
bool	PreserveHiddenStatus ()
	Returns the preserve hidden status Created in NX11.0.0. More...
bool	ProcessObjectsHidden ()
	Returns the process objects hidden Created in NX11.0.0. More...
void	SaveAnnotationType (NXOpen::Drawings::AnnotationSettingsBuilder::AnnotationTypeEnum annType, bool annValue)
	API used to save settings data Created in NX11.0.0. More...
void	SetConvertToOriginalModelView (bool convertToOriginalModelView)
	Sets the convert to original model view Created in NX11.0.0. More...
void	SetLinearDimensionTolerance (double linearDimensionTolerance)
	Sets the linear dimension tolerance Created in NX11.0.0. More...
void	SetPreserveDraftingLayer (bool preserveDraftingLayer)
	Sets the preserve drafting layer Created in NX11.0.0. More...
void	SetPreserveHiddenStatus (bool preserveHiddenStatus)
	Sets the preserve hidden status Created in NX11.0.0. More...
void	SetProcessObjectsHidden (bool processObjectsHidden)
	Sets the process objects hidden Created in NX11.0.0. More...
void	SetUnits (NXOpen::Drawings::AnnotationSettingsBuilder::UnitsEnum units)
	Sets the units Created in NX11.0.0. More...
NXOpen::Drawings::AnnotationSettingsBuilder::UnitsEnum	Units ()
	Returns the units Created in NX11.0.0. 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 Drawings::AnnotationSettingsBuilder .

This class queries and sets settings specific to drawings data which will get converted to PMIs.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::AnnotationSettingsBuilder::AnnotationTypeEnum

enum is used to list out annotation types

Enumerator
AnnotationTypeEnumDimension	dimension
AnnotationTypeEnumNote	note
AnnotationTypeEnumFeatureControlFrame	feature control frame
AnnotationTypeEnumDatumFeatureSymbol	datum feature symbol
AnnotationTypeEnumDatumTarget	datum target
AnnotationTypeEnumBalloon	balloon
AnnotationTypeEnumSurfaceFinishSymbol	surface finish symbol
AnnotationTypeEnumWeldSymbol	weld symbol
AnnotationTypeEnumCustomSymbol	custom symbol
AnnotationTypeEnumCenterLine	center line
AnnotationTypeEnumUserDefinedSymbol	user defined symbol
AnnotationTypeEnumMaxAnnotationYypes	max annotation yypes

enum NXOpen::Drawings::AnnotationSettingsBuilder::UnitsEnum

enum is used to list out different unit types

Enumerator
UnitsEnumUseTargetPartUnits	use target part units
UnitsEnumUseDrawingUnits	use drawing units

Member Function Documentation

bool NXOpen::Drawings::AnnotationSettingsBuilder::ConvertToOriginalModelView

(

)

Returns the convert to original model view
Created in NX11.0.0.

License requirements : None

double NXOpen::Drawings::AnnotationSettingsBuilder::LinearDimensionTolerance

(

)

Returns the linear dimension tolerance
Created in NX11.0.0.

License requirements : None

bool NXOpen::Drawings::AnnotationSettingsBuilder::PreserveDraftingLayer

(

)

Returns the preserve drafting layer
Created in NX11.0.0.

License requirements : None

bool NXOpen::Drawings::AnnotationSettingsBuilder::PreserveHiddenStatus

(

)

Returns the preserve hidden status
Created in NX11.0.0.

License requirements : None

bool NXOpen::Drawings::AnnotationSettingsBuilder::ProcessObjectsHidden

(

)

Returns the process objects hidden
Created in NX11.0.0.

License requirements : None

void NXOpen::Drawings::AnnotationSettingsBuilder::SaveAnnotationType	(	NXOpen::Drawings::AnnotationSettingsBuilder::AnnotationTypeEnum	annType,
		bool	annValue
	)

API used to save settings data
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

annType	anntype
annValue	annvalue

void NXOpen::Drawings::AnnotationSettingsBuilder::SetConvertToOriginalModelView

(

bool

convertToOriginalModelView

)

Sets the convert to original model view
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

convertToOriginalModelView

converttooriginalmodelview

void NXOpen::Drawings::AnnotationSettingsBuilder::SetLinearDimensionTolerance

(

double

linearDimensionTolerance

)

Sets the linear dimension tolerance
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

linearDimensionTolerance

lineardimensiontolerance

void NXOpen::Drawings::AnnotationSettingsBuilder::SetPreserveDraftingLayer

(

bool

preserveDraftingLayer

)

Sets the preserve drafting layer
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

preserveDraftingLayer

preservedraftinglayer

void NXOpen::Drawings::AnnotationSettingsBuilder::SetPreserveHiddenStatus

(

bool

preserveHiddenStatus

)

Sets the preserve hidden status
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

preserveHiddenStatus

preservehiddenstatus

void NXOpen::Drawings::AnnotationSettingsBuilder::SetProcessObjectsHidden

(

bool

processObjectsHidden

)

Sets the process objects hidden
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

processObjectsHidden

processobjectshidden

void NXOpen::Drawings::AnnotationSettingsBuilder::SetUnits

(

NXOpen::Drawings::AnnotationSettingsBuilder::UnitsEnum

units

)

Sets the units
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

units

units

NXOpen::Drawings::AnnotationSettingsBuilder::UnitsEnum NXOpen::Drawings::AnnotationSettingsBuilder::Units

(

)

Returns the units
Created in NX11.0.0.

License requirements : None

virtual bool NXOpen::Drawings::AnnotationSettingsBuilder::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:

• Drawings_AnnotationSettingsBuilder.hxx