FacetSettingsBuilder Class

class NXOpen.Display.FacetSettingsBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Display.FacetSettingsBuilder

Facet Settings are not supported in KF.

New in version NX8.0.0.

Properties

Property Description
AdvVisAlignFacets Returns or sets the state of whether facets for advanced visualization views should be aligned along common edges.
AdvVisFacetRatio Returns or sets the facet ratio to use for Advanced Visualization Views
AdvVisFacetScale Returns or sets the facet scale to use for Advanced Visualization Views
AdvVisFacetToViewRatio Returns or sets the facet to view ratio to use for Advanced Visualization Views
AdvVisRefinementFactor Returns or sets the refinement factor to use for Advanced Visualization Views
AdvVisTolerance Returns or sets the tolerance setting to use for Advanced Visualization Views
AdvVisUpdate Returns or sets the update mode to use for Advanced Visualization Views
ShadedAlignFacets Returns or sets the state of whether facets for shaded views should be aligned along common edges.
ShadedFacetRatio Returns or sets the facet ratio to use for Shaded Views
ShadedFacetScale Returns or sets the facet scale to use for Shaded Views
ShadedFacetToViewRatio Returns or sets the facet to view ratio to use for Shaded Views
ShadedRefinementFactor Returns or sets the refinement factor to use for Shaded Views
ShadedTolerance Returns or sets the tolerance setting to use for Shaded Views
ShadedUpdate Returns or sets the update mode to use for Shaded Views
ShowFacetEdges Returns or sets the state of whether facet edges should be shown for shaded solid and sheet bodies
Tag Returns the Tag for this object.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetAdvVisAngleTol Returns the angle tolerance for a given tolerance set for Advanced Visualization Views
GetAdvVisEdgeTol Returns the edge tolerance for a given tolerance set for Advanced Visualization Views
GetAdvVisFaceTol Returns the face tolerance for a given tolerance set for Advanced Visualization Views
GetAdvVisWidthTol Returns the width tolerance for a given tolerance set for Advanced Visualization Views
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
GetShadedAngleTol Returns the angle tolerance for a given tolerance set for Shaded Views
GetShadedEdgeTol Returns the edge tolerance for a given tolerance set for Shaded Views
GetShadedFaceTol Returns the face tolerance for a given tolerance set for Shaded Views
SetAdvVisAngleTol Sets the angle tolerance for a given tolerance set for Advanced Visualization Views
SetAdvVisEdgeTol Sets the edge tolerance for a given tolerance set for Advanced Visualization Views
SetAdvVisFaceTol Sets the face tolerance for a given tolerance set for Advanced Visualization Views
SetAdvVisWidthTol Sets the width tolerance for a given tolerance set for Advanced Visualization Views
SetShadedAngleTol Sets the angle tolerance for a given tolerance set for Shaded Views
SetShadedEdgeTol Sets the edge toleramce for a given tolerance set for Shaded Views
SetShadedFaceTol Sets the face tolerance for a given tolerance set for Shaded Views
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

FacetSettingsBuilderAdvVisToleranceSetting Enumeration Specifies which set of tolerances are to be used for rendering facets for display for Advanced Visualization views.
FacetSettingsBuilderFacetScale Enumeration Denotes what type of scaling factor is applied to the corresponding tolerances used to generate facets.
FacetSettingsBuilderFacetToViewRatio Enumeration Specifies whether the ratio of the view scale to the scale used to generate facets is determined automatically by the system (as was always done before NX 8) or whether a ratio defined by the user (by one of the set_*FacetRatio methods) is to be used as the ratio.
FacetSettingsBuilderFacetUpdate Enumeration Specifies whether an Update Display or Fit operation is to regenerate the facets for only visible objects, for all objects or for no objects.
FacetSettingsBuilderShadedToleranceSetting Enumeration Specifies which set of tolerances are to be used for rendering facets for display for Shaded views.

Property Detail

AdvVisAlignFacets

FacetSettingsBuilder.AdvVisAlignFacets

Returns or sets the state of whether facets for advanced visualization views should be aligned along common edges.

Using this option will generally increase the quality of the facets but the facet generation will generally take longer.

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

Getter Method

Signature AdvVisAlignFacets

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature AdvVisAlignFacets

Parameters:advVisAlignFacets (bool) –

New in version NX8.5.0.

License requirements: None.

AdvVisFacetRatio

FacetSettingsBuilder.AdvVisFacetRatio

Returns or sets the facet ratio to use for Advanced Visualization Views

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

Getter Method

Signature AdvVisFacetRatio

Returns:
Return type:float

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.AdvVisRefinementFactor() instead

License requirements: None.

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

Setter Method

Signature AdvVisFacetRatio

Parameters:advVisFacetRatio (float) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.AdvVisRefinementFactor() instead

License requirements: None.

AdvVisFacetScale

FacetSettingsBuilder.AdvVisFacetScale

Returns or sets the facet scale to use for Advanced Visualization Views

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

Getter Method

Signature AdvVisFacetScale

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderFacetScale

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature AdvVisFacetScale

Parameters:advVisFacetScale (NXOpen.Display.FacetSettingsBuilderFacetScale) –

New in version NX9.0.0.

License requirements: None.

AdvVisFacetToViewRatio

FacetSettingsBuilder.AdvVisFacetToViewRatio

Returns or sets the facet to view ratio to use for Advanced Visualization Views

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

Getter Method

Signature AdvVisFacetToViewRatio

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderFacetToViewRatio

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.AdvVisFacetScale() instead

License requirements: None.

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

Setter Method

Signature AdvVisFacetToViewRatio

Parameters:advVisFacetToViewRatio (NXOpen.Display.FacetSettingsBuilderFacetToViewRatio) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.AdvVisFacetScale() instead

License requirements: None.

AdvVisRefinementFactor

FacetSettingsBuilder.AdvVisRefinementFactor

Returns or sets the refinement factor to use for Advanced Visualization Views

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

Getter Method

Signature AdvVisRefinementFactor

Returns:
Return type:float

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature AdvVisRefinementFactor

Parameters:advVisRefinementFactor (float) –

New in version NX9.0.0.

License requirements: None.

AdvVisTolerance

FacetSettingsBuilder.AdvVisTolerance

Returns or sets the tolerance setting to use for Advanced Visualization Views

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

Getter Method

Signature AdvVisTolerance

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderAdvVisToleranceSetting

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature AdvVisTolerance

Parameters:advVisTolerance (NXOpen.Display.FacetSettingsBuilderAdvVisToleranceSetting) –

New in version NX8.0.0.

License requirements: None.

AdvVisUpdate

FacetSettingsBuilder.AdvVisUpdate

Returns or sets the update mode to use for Advanced Visualization Views

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

Getter Method

Signature AdvVisUpdate

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderFacetUpdate

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature AdvVisUpdate

Parameters:advVisUpdate (NXOpen.Display.FacetSettingsBuilderFacetUpdate) –

New in version NX8.0.0.

License requirements: None.

ShadedAlignFacets

FacetSettingsBuilder.ShadedAlignFacets

Returns or sets the state of whether facets for shaded views should be aligned along common edges.

Using this option will generally increase the quality of the facets but the facet generation will generally take longer.

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

Getter Method

Signature ShadedAlignFacets

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ShadedAlignFacets

Parameters:shadedAlignFacets (bool) –

New in version NX8.5.0.

License requirements: None.

ShadedFacetRatio

FacetSettingsBuilder.ShadedFacetRatio

Returns or sets the facet ratio to use for Shaded Views

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

Getter Method

Signature ShadedFacetRatio

Returns:
Return type:float

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.ShadedRefinementFactor() instead

License requirements: None.

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

Setter Method

Signature ShadedFacetRatio

Parameters:shadedFacetRatio (float) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.ShadedRefinementFactor() instead

License requirements: None.

ShadedFacetScale

FacetSettingsBuilder.ShadedFacetScale

Returns or sets the facet scale to use for Shaded Views

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

Getter Method

Signature ShadedFacetScale

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderFacetScale

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature ShadedFacetScale

Parameters:shadedFacetScale (NXOpen.Display.FacetSettingsBuilderFacetScale) –

New in version NX9.0.0.

License requirements: None.

ShadedFacetToViewRatio

FacetSettingsBuilder.ShadedFacetToViewRatio

Returns or sets the facet to view ratio to use for Shaded Views

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

Getter Method

Signature ShadedFacetToViewRatio

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderFacetToViewRatio

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.ShadedFacetScale() instead

License requirements: None.

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

Setter Method

Signature ShadedFacetToViewRatio

Parameters:shadedFacetToViewRatio (NXOpen.Display.FacetSettingsBuilderFacetToViewRatio) –

New in version NX8.0.0.

Deprecated since version NX9.0.0: Refer to NXOpen.Display.FacetSettingsBuilder.ShadedFacetScale() instead

License requirements: None.

ShadedRefinementFactor

FacetSettingsBuilder.ShadedRefinementFactor

Returns or sets the refinement factor to use for Shaded Views

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

Getter Method

Signature ShadedRefinementFactor

Returns:
Return type:float

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature ShadedRefinementFactor

Parameters:shadedRefinementFactor (float) –

New in version NX9.0.0.

License requirements: None.

ShadedTolerance

FacetSettingsBuilder.ShadedTolerance

Returns or sets the tolerance setting to use for Shaded Views

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

Getter Method

Signature ShadedTolerance

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderShadedToleranceSetting

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ShadedTolerance

Parameters:shadedTolerance (NXOpen.Display.FacetSettingsBuilderShadedToleranceSetting) –

New in version NX8.0.0.

License requirements: None.

ShadedUpdate

FacetSettingsBuilder.ShadedUpdate

Returns or sets the update mode to use for Shaded Views

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

Getter Method

Signature ShadedUpdate

Returns:
Return type:NXOpen.Display.FacetSettingsBuilderFacetUpdate

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ShadedUpdate

Parameters:shadedUpdate (NXOpen.Display.FacetSettingsBuilderFacetUpdate) –

New in version NX8.0.0.

License requirements: None.

ShowFacetEdges

FacetSettingsBuilder.ShowFacetEdges

Returns or sets the state of whether facet edges should be shown for shaded solid and sheet bodies

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

Getter Method

Signature ShowFacetEdges

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ShowFacetEdges

Parameters:showFacetEdges (bool) –

New in version NX8.5.0.

License requirements: None.

Method Detail

GetAdvVisAngleTol

FacetSettingsBuilder.GetAdvVisAngleTol

Returns the angle tolerance for a given tolerance set for Advanced Visualization Views

Signature GetAdvVisAngleTol(advVisTolerance)

Parameters:advVisTolerance (NXOpen.Display.FacetSettingsBuilderAdvVisToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

GetAdvVisEdgeTol

FacetSettingsBuilder.GetAdvVisEdgeTol

Returns the edge tolerance for a given tolerance set for Advanced Visualization Views

Signature GetAdvVisEdgeTol(advVisTolerance)

Parameters:advVisTolerance (NXOpen.Display.FacetSettingsBuilderAdvVisToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

GetAdvVisFaceTol

FacetSettingsBuilder.GetAdvVisFaceTol

Returns the face tolerance for a given tolerance set for Advanced Visualization Views

Signature GetAdvVisFaceTol(advVisTolerance)

Parameters:advVisTolerance (NXOpen.Display.FacetSettingsBuilderAdvVisToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

GetAdvVisWidthTol

FacetSettingsBuilder.GetAdvVisWidthTol

Returns the width tolerance for a given tolerance set for Advanced Visualization Views

Signature GetAdvVisWidthTol(advVisTolerance)

Parameters:advVisTolerance (NXOpen.Display.FacetSettingsBuilderAdvVisToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

GetShadedAngleTol

FacetSettingsBuilder.GetShadedAngleTol

Returns the angle tolerance for a given tolerance set for Shaded Views

Signature GetShadedAngleTol(shadedTolerance)

Parameters:shadedTolerance (NXOpen.Display.FacetSettingsBuilderShadedToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

GetShadedEdgeTol

FacetSettingsBuilder.GetShadedEdgeTol

Returns the edge tolerance for a given tolerance set for Shaded Views

Signature GetShadedEdgeTol(shadedTolerance)

Parameters:shadedTolerance (NXOpen.Display.FacetSettingsBuilderShadedToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

GetShadedFaceTol

FacetSettingsBuilder.GetShadedFaceTol

Returns the face tolerance for a given tolerance set for Shaded Views

Signature GetShadedFaceTol(shadedTolerance)

Parameters:shadedTolerance (NXOpen.Display.FacetSettingsBuilderShadedToleranceSetting) –
Returns:
Return type:float

New in version NX8.0.0.

License requirements: None.

SetAdvVisAngleTol

FacetSettingsBuilder.SetAdvVisAngleTol

Sets the angle tolerance for a given tolerance set for Advanced Visualization Views

Signature SetAdvVisAngleTol(advVisTolerance, advVisAngleTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetAdvVisEdgeTol

FacetSettingsBuilder.SetAdvVisEdgeTol

Sets the edge tolerance for a given tolerance set for Advanced Visualization Views

Signature SetAdvVisEdgeTol(advVisTolerance, advVisEdgeTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetAdvVisFaceTol

FacetSettingsBuilder.SetAdvVisFaceTol

Sets the face tolerance for a given tolerance set for Advanced Visualization Views

Signature SetAdvVisFaceTol(advVisTolerance, advVisFaceTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetAdvVisWidthTol

FacetSettingsBuilder.SetAdvVisWidthTol

Sets the width tolerance for a given tolerance set for Advanced Visualization Views

Signature SetAdvVisWidthTol(advVisTolerance, advVisWidthTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetShadedAngleTol

FacetSettingsBuilder.SetShadedAngleTol

Sets the angle tolerance for a given tolerance set for Shaded Views

Signature SetShadedAngleTol(shadedTolerance, shadedAngleTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetShadedEdgeTol

FacetSettingsBuilder.SetShadedEdgeTol

Sets the edge toleramce for a given tolerance set for Shaded Views

Signature SetShadedEdgeTol(shadedTolerance, shadedEdgeTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

SetShadedFaceTol

FacetSettingsBuilder.SetShadedFaceTol

Sets the face tolerance for a given tolerance set for Shaded Views

Signature SetShadedFaceTol(shadedTolerance, shadedFaceTol)

Parameters:

New in version NX8.0.0.

License requirements: None.

Validate

FacetSettingsBuilder.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.