NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder Class Reference

Represents a set of display settings used by Face Analysis. More...

Inheritance diagram for NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder:

Public Types
enum	ColorLegendOptions { ColorLegendOptionsBlend, ColorLegendOptionsSharp }
	Represents color legend type in display. More...
enum	ColorsOptions {   ColorsOptionsTwo, ColorsOptionsThree, ColorsOptionsFour, ColorsOptionsFive,   ColorsOptionsSix, ColorsOptionsSeven, ColorsOptionsEight, ColorsOptionsNine,   ColorsOptionsTen, ColorsOptionsEleven, ColorsOptionsTwelve }
	The option indicating number of colors to be used for display. More...

Public Member Functions
bool	CanShowFacet ()
	Returns the flag indicating if facets should be shown. More...
NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorLegendOptions	ColorLegendOption ()
	Returns the color legend option. More...
NXOpen::GeometricUtilities::DisplayResolutionBuilder *	DisplayResolution ()
	Returns the display resolution. More...
NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorsOptions	NumberOfColors ()
	Returns the number of colors. More...
void	SetCanShowFacet (bool canShowFacet)
	Sets the flag indicating if facets should be shown. More...
void	SetColorLegendOption (NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorLegendOptions colorLegendOption)
	Sets the color legend option. More...
void	SetNumberOfColors (NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorsOptions numberOfColors)
	Sets the number of colors. 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 set of display settings used by Face Analysis.

Created in NX11.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorLegendOptions

Represents color legend type in display.

Enumerator
ColorLegendOptionsBlend	Blended color display.
ColorLegendOptionsSharp	Sharp color display.

enum NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorsOptions

The option indicating number of colors to be used for display.

Enumerator
ColorsOptionsTwo	Display in 2 colors.
ColorsOptionsThree	Display in 3 colors.
ColorsOptionsFour	Display in 4 colors.
ColorsOptionsFive	Display in 5 colors.
ColorsOptionsSix	Display in 6 colors.
ColorsOptionsSeven	Display in 7 colors.
ColorsOptionsEight	Display in 8 colors.
ColorsOptionsNine	Display in 9 colors.
ColorsOptionsTen	Display in 10 colors.
ColorsOptionsEleven	Display in 11 colors.
ColorsOptionsTwelve	Display in 12 colors.

Member Function Documentation

bool NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::CanShowFacet

(

)

Returns the flag indicating if facets should be shown.

Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorLegendOptions NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorLegendOption

(

)

Returns the color legend option.

Created in NX11.0.0.

License requirements : None

NXOpen::GeometricUtilities::DisplayResolutionBuilder* NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::DisplayResolution

(

)

Returns the display resolution.

Created in NX11.0.0.

License requirements : None

NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorsOptions NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::NumberOfColors

(

)

Returns the number of colors.

Created in NX11.0.0.

License requirements : None

void NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::SetCanShowFacet

(

bool

canShowFacet

)

Sets the flag indicating if facets should be shown.

Created in NX11.0.0.

License requirements : None

Parameters

canShowFacet

canshowfacet

void NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::SetColorLegendOption

(

NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorLegendOptions

colorLegendOption

)

Sets the color legend option.

Created in NX11.0.0.

License requirements : None

Parameters

colorLegendOption

colorlegendoption

void NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::SetNumberOfColors

(

NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::ColorsOptions

numberOfColors

)

Sets the number of colors.

Created in NX11.0.0.

License requirements : None

Parameters

numberOfColors

numberofcolors

virtual bool NXOpen::GeometricAnalysis::FaceAnalysisDisplayBuilder::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:

• GeometricAnalysis_FaceAnalysisDisplayBuilder.hxx