FaceAnalysisDisplayBuilder Class

class NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a set of display settings used by Face Analysis.

New in version NX11.0.0.

Properties

Property	Description
CanShowFacet	Returns or sets the flag indicating if facets should be shown.
ColorLegendOption	Returns or sets the color legend option.
DisplayResolution	Returns the display resolution.
NumberOfColors	Returns or sets the number of colors.
Tag	Returns the Tag for this object.

Methods

Method	Description
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

FaceAnalysisDisplayBuilderColorLegendOptions Enumeration	Represents color legend type in display.
FaceAnalysisDisplayBuilderColorsOptions Enumeration	The option indicating number of colors to be used for display.

Property Detail

CanShowFacet

FaceAnalysisDisplayBuilder.CanShowFacet

Returns or sets the flag indicating if facets should be shown.

-------------------------------------

Getter Method

Signature CanShowFacet

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CanShowFacet

Parameters:canShowFacet (bool) –

New in version NX11.0.0.

License requirements: None.

ColorLegendOption

FaceAnalysisDisplayBuilder.ColorLegendOption

Returns or sets the color legend option.

-------------------------------------

Getter Method

Signature ColorLegendOption

Returns: Return type:NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilderColorLegendOptions

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ColorLegendOption

Parameters:colorLegendOption (NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilderColorLegendOptions) –

New in version NX11.0.0.

License requirements: None.

DisplayResolution

FaceAnalysisDisplayBuilder.DisplayResolution

Returns the display resolution.

-------------------------------------

Getter Method

Signature DisplayResolution

Returns: Return type:NXOpen.GeometricUtilities.DisplayResolutionBuilder

New in version NX11.0.0.

License requirements: None.

NumberOfColors

FaceAnalysisDisplayBuilder.NumberOfColors

Returns or sets the number of colors.

-------------------------------------

Getter Method

Signature NumberOfColors

Returns: Return type:NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilderColorsOptions

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature NumberOfColors

Parameters:numberOfColors (NXOpen.GeometricAnalysis.FaceAnalysisDisplayBuilderColorsOptions) –

New in version NX11.0.0.

License requirements: None.

Method Detail

Validate

FaceAnalysisDisplayBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.