This class gets and sets components of Visual Overlay in Drafting Preferences. More...

Inheritance diagram for NXOpen::Drawings::VisualDrawingComparePrefsBuilder:

Public Types
enum	VisualDrawingComparePrefsMethodType { VisualDrawingComparePrefsMethodTypeAgainstAnotherDrawing, VisualDrawingComparePrefsMethodTypeAgainstOverlayDatainActiveDrawing }
	Compare Method Type This indicate various options of Compare Method. More...

enum	VisualDrawingComparePrefsOverlayDataToUse { VisualDrawingComparePrefsOverlayDataToUseAskatRuntime, VisualDrawingComparePrefsOverlayDataToUseAlwaysUseExistingData, VisualDrawingComparePrefsOverlayDataToUseAlwaysCreateNewData, VisualDrawingComparePrefsOverlayDataToUseCreateNewDataifNoneExists }
	Overlay Data To Use This indicate various options that can be used before Overlaying. More...

Public Member Functions
NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsMethodType	CompareMethodType ()
	Returns the compare method type Created in NX11.0.0. More...

NXOpen::NXColor *	OverlayColor ()
	Returns the overlay color Created in NX11.0.0. More...

NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsOverlayDataToUse	OverlayDataToUse ()
	Returns the overlay data to use Created in NX11.0.0. More...

void	SetCompareMethodType (NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsMethodType compareMethodType)
	Sets the compare method type Created in NX11.0.0. More...

void	SetOverlayColor (NXOpen::NXColor *overlayColor)
	Sets the overlay color Created in NX11.0.0. More...

void	SetOverlayDataToUse (NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsOverlayDataToUse overlayDataToUse)
	Sets the overlay data to use 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

This class gets and sets components of Visual Overlay in Drafting Preferences.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsMethodType

Compare Method Type This indicate various options of Compare Method.

Enumerator
VisualDrawingComparePrefsMethodTypeAgainstAnotherDrawing	This option is used to overlay different part over current part.
VisualDrawingComparePrefsMethodTypeAgainstOverlayDatainActiveDrawing	This option is used to overlay current part on itself.

enum NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsOverlayDataToUse

Overlay Data To Use This indicate various options that can be used before Overlaying.

Enumerator
VisualDrawingComparePrefsOverlayDataToUseAskatRuntime	This option tells to show messages at rumtime.
VisualDrawingComparePrefsOverlayDataToUseAlwaysUseExistingData	This option will use existing data to overlay.
VisualDrawingComparePrefsOverlayDataToUseAlwaysCreateNewData	This option will always create new data.
VisualDrawingComparePrefsOverlayDataToUseCreateNewDataifNoneExists	This option will create new data if none exists.

Member Function Documentation

NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsMethodType NXOpen::Drawings::VisualDrawingComparePrefsBuilder::CompareMethodType ( )

Returns the compare method type
Created in NX11.0.0.

License requirements : None

NXOpen::NXColor* NXOpen::Drawings::VisualDrawingComparePrefsBuilder::OverlayColor ( )

Returns the overlay color
Created in NX11.0.0.

License requirements : None

NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsOverlayDataToUse NXOpen::Drawings::VisualDrawingComparePrefsBuilder::OverlayDataToUse ( )

Returns the overlay data to use
Created in NX11.0.0.

License requirements : None

void NXOpen::Drawings::VisualDrawingComparePrefsBuilder::SetCompareMethodType ( NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsMethodType compareMethodType )

Sets the compare method type
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

compareMethodType comparemethodtype

void NXOpen::Drawings::VisualDrawingComparePrefsBuilder::SetOverlayColor ( NXOpen::NXColor * overlayColor )

Sets the overlay color
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

overlayColor overlaycolor

void NXOpen::Drawings::VisualDrawingComparePrefsBuilder::SetOverlayDataToUse ( NXOpen::Drawings::VisualDrawingComparePrefsBuilder::VisualDrawingComparePrefsOverlayDataToUse overlayDataToUse )

Sets the overlay data to use
Created in NX11.0.0.

License requirements : drafting ("DRAFTING")

Parameters

overlayDataToUse overlaydatatouse

virtual bool NXOpen::Drawings::VisualDrawingComparePrefsBuilder::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_VisualDrawingComparePrefsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation