NXOpen::Preferences::PartVisualizationShade Class Reference

Represents the set of shade visualization preferences applicable to entire part
To obtain an instance of this class, refer to NXOpen::Preferences::PartPreferences

Created in NX3.0.0. More...

Public Types
enum	AdvViewToleranceType {   AdvViewToleranceTypeCoarse, AdvViewToleranceTypeStandard, AdvViewToleranceTypeFine, AdvViewToleranceTypeExtrafine,   AdvViewToleranceTypeSuperfine, AdvViewToleranceTypeUltrafine, AdvViewToleranceTypeCustomize }
	Describes the available tolerance types for Advanced View. More...
enum	HiddenShadedFaceEdges { HiddenShadedFaceEdgesInvisible, HiddenShadedFaceEdgesDashed, HiddenShadedFaceEdgesHiddenColor }
	Describes whether the shaded face edges are invisible or dashed visible or with a color to depict the hidden geometry. More...
enum	ShadedFaceEdge { ShadedFaceEdgeOff, ShadedFaceEdgeBodyColor, ShadedFaceEdgeSpecifyColor }
	Describes whether the shaded face edges are having no color or body color or user defined color. More...
enum	ShadedViewToleranceType {   ShadedViewToleranceTypeCoarse, ShadedViewToleranceTypeStandard, ShadedViewToleranceTypeFine, ShadedViewToleranceTypeExtrafine,   ShadedViewToleranceTypeUltrafine, ShadedViewToleranceTypeCustomize }
	Describes the available tolerance types for Shaded View. More...
enum	ViewUpdateModeType { ViewUpdateModeTypeVisibleObject, ViewUpdateModeTypeAllObject, ViewUpdateModeTypeNone }
	Describes whether the applied changes are applicable to visible object or all object or no object. More...

Public Member Functions
NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType	AdvancedVisViewTolerance ()
	Returns the tolerance for advanced visualization views. More...
NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType	AdvancedVisViewUpdateMode ()
	Returns the update mode for advanced visualization views. More...
bool	AlignAdvVisViewFacetsAlongEdges ()
	Returns the state of whether facets should be aligned along common edges for Advanced Visualization Views Created in NX8.5.0. More...
bool	AlignShadedViewFacetsAlongEdges ()
	Returns the state of whether facets should be aligned along common edges for Shaded Views Created in NX8.5.0. More...
void	GetAdvVisViewFacetTolerances (NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType advVisViewToleranceSet, double *edgeTolerance, double *faceTolerance, double *angleTolerance, double *widthTolerance)
	Returns the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views. More...
void	GetShadedViewFacetTolerances (NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType shadedViewToleranceSet, double *edgeTolerance, double *faceTolerance, double *angleTolerance)
	Returns the edge, face and angle tolerances to be used with the specified tolerance set for shaded views. More...
int	HiddenGeometryColor ()
	Returns the shade hidden geometry color. More...
void	RegenerateShadedViewsFromToleranceChange ()
	Regenerates Shaded Views. More...
void	RegenerateStudioAnalysisViewsFromToleranceChange (bool updateEnvCube)
	Regenerates Studio Analysis Views. More...
void	SetAdvancedVisViewTolerance (NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType advancedVisViewTolerance)
	Sets the tolerance for advanced visualization views. More...
void	SetAdvancedVisViewUpdateMode (NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType advancedVisViewUpdateMode)
	Sets the update mode for advanced visualization views. More...
void	SetAdvVisViewFacetTolerances (NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType advVisViewToleranceSet, double edgeTolerance, double faceTolerance, double angleTolerance, double widthTolerance)
	Sets the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views. More...
void	SetAlignAdvVisViewFacetsAlongEdges (bool alignAdvVisViewFacetsAlongEdges)
	Sets the state of whether facets should be aligned along common edges for Advanced Visualization Views Created in NX8.5.0. More...
void	SetAlignShadedViewFacetsAlongEdges (bool alignShadedViewFacetsAlongEdges)
	Sets the state of whether facets should be aligned along common edges for Shaded Views Created in NX8.5.0. More...
void	SetHiddenGeometryColor (int hiddenGeomColor)
	Sets the shade hidden geometry color. More...
void	SetShadedViewFacetTolerances (NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType shadedViewToleranceSet, double edgeTolerance, double faceTolerance, double angleTolerance)
	Sets the edge, face and angle tolerances to be used with the specified tolerance set for shaded views. More...
void	SetShadedViewTolerance (NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType shadedViewTolerance)
	Sets the tolerance for shaded views. More...
void	SetShadedViewUpdateMode (NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType shadedViewUpdateMode)
	Sets the update mode for shaded views. More...
NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType	ShadedViewTolerance ()
	Returns the tolerance for shaded views. More...
NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType	ShadedViewUpdateMode ()
	Returns the update mode for shaded views. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents the set of shade visualization preferences applicable to entire part
To obtain an instance of this class, refer to NXOpen::Preferences::PartPreferences

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType

Describes the available tolerance types for Advanced View.

Each of these options maps tolerance values to for specific operations : Curve Edge Chord Distance, Surface Chord Distance, Angular Tolerance, Facet Width Tolerance

Enumerator
AdvViewToleranceTypeCoarse	Coarse.
AdvViewToleranceTypeStandard	Standard.
AdvViewToleranceTypeFine	Fine.
AdvViewToleranceTypeExtrafine	Extrafine.
AdvViewToleranceTypeSuperfine	Superfine.
AdvViewToleranceTypeUltrafine	Ultrafine.
AdvViewToleranceTypeCustomize	Customize. User can specify the Edge Tolerance, Face Tolerance and Angle Tolerance, Width Tolerance specifically.

enum NXOpen::Preferences::PartVisualizationShade::HiddenShadedFaceEdges

Describes whether the shaded face edges are invisible or dashed visible or with a color to depict the hidden geometry.

Enumerator
HiddenShadedFaceEdgesInvisible	If selected, shaded face edges that are hidden are not displayed.
HiddenShadedFaceEdgesDashed	If selected, hidden shaded face edges are displayed in the body color with a dashed line font.
HiddenShadedFaceEdgesHiddenColor	If any color is selected, hidden shaded face edges are displayed in that color.

enum NXOpen::Preferences::PartVisualizationShade::ShadedFaceEdge

Describes whether the shaded face edges are having no color or body color or user defined color.

Enumerator
ShadedFaceEdgeOff	Option is off.
ShadedFaceEdgeBodyColor	Body Color.
ShadedFaceEdgeSpecifyColor	Specified Color.

enum NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType

Describes the available tolerance types for Shaded View.

Each of these options maps tolerance values to three specific faceting operations: Facet Edge Tolerance, Facet Chord Tolerance, and Angular Tolerance.

Enumerator
ShadedViewToleranceTypeCoarse	For Coarse: Facet Edge Tolerance is 0.01, Facet Chord Tolerance is 0.01, and Angular Tolerance is 0.0.
ShadedViewToleranceTypeStandard	For Standard: Facet Edge Tolerance is 0.005, Facet Chord Tolerance is 0.005 , and Angular Tolerance is 15.
ShadedViewToleranceTypeFine	For Fine: Facet Edge Tolerance is 0.0005, Facet Chord Tolerance is 0.0025, and Angular Tolerance is 6.
ShadedViewToleranceTypeExtrafine	For Extrafine: Facet Edge Tolerance is 0.005, Facet Chord Tolerance is 0.001, and Angular Tolerance is 6.
ShadedViewToleranceTypeUltrafine	For Ultrafine: Facet Edge Tolerance is 0.0005, Facet Chord Tolerance is 0.0005, and Angular Tolerance is 3.
ShadedViewToleranceTypeCustomize	Customize. User can specify the Edge Tolerance, Face Tolerance and Angle Tolerance specifically.

enum NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType

Describes whether the applied changes are applicable to visible object or all object or no object.

Enumerator
ViewUpdateModeTypeVisibleObject	Applicable only to visible object.
ViewUpdateModeTypeAllObject	Applicable to all object.
ViewUpdateModeTypeNone	No object.

Member Function Documentation

NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType NXOpen::Preferences::PartVisualizationShade::AdvancedVisViewTolerance

(

)

Returns the tolerance for advanced visualization views.

Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType NXOpen::Preferences::PartVisualizationShade::AdvancedVisViewUpdateMode

(

)

Returns the update mode for advanced visualization views.

Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::PartVisualizationShade::AlignAdvVisViewFacetsAlongEdges

(

)

Returns the state of whether facets should be aligned along common edges for Advanced Visualization Views
Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::PartVisualizationShade::AlignShadedViewFacetsAlongEdges

(

)

Returns the state of whether facets should be aligned along common edges for Shaded Views
Created in NX8.5.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationShade::GetAdvVisViewFacetTolerances	(	NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType	advVisViewToleranceSet,
		double *	edgeTolerance,
		double *	faceTolerance,
		double *	angleTolerance,
		double *	widthTolerance
	)

Returns the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views.

Created in NX8.0.0.

License requirements : None

Parameters

advVisViewToleranceSet	adv vis view tolerance set
edgeTolerance	edge tolerance
faceTolerance	face tolerance
angleTolerance	angle tolerance
widthTolerance	width tolerance

void NXOpen::Preferences::PartVisualizationShade::GetShadedViewFacetTolerances	(	NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType	shadedViewToleranceSet,
		double *	edgeTolerance,
		double *	faceTolerance,
		double *	angleTolerance
	)

Returns the edge, face and angle tolerances to be used with the specified tolerance set for shaded views.

Created in NX8.0.0.

License requirements : None

Parameters

shadedViewToleranceSet	shaded view tolerance set
edgeTolerance	edge tolerance
faceTolerance	face tolerance
angleTolerance	angle tolerance

int NXOpen::Preferences::PartVisualizationShade::HiddenGeometryColor

(

)

Returns the shade hidden geometry color.

Created in NX3.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationShade::RegenerateShadedViewsFromToleranceChange

(

)

Regenerates Shaded Views.

Updates all objects based on their surfacing tolerance.
Created in NX12.0.0.

License requirements : None

void NXOpen::Preferences::PartVisualizationShade::RegenerateStudioAnalysisViewsFromToleranceChange

(

bool

updateEnvCube

)

Regenerates Studio Analysis Views.

Updates all objects based on their surfacing tolerance.
Created in NX12.0.0.

License requirements : None

Parameters

updateEnvCube

True if env cube should be updated

void NXOpen::Preferences::PartVisualizationShade::SetAdvancedVisViewTolerance

(

NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType

advancedVisViewTolerance

)

Sets the tolerance for advanced visualization views.

Created in NX3.0.0.

License requirements : None

Parameters

advancedVisViewTolerance

advanced vis view tolerance

void NXOpen::Preferences::PartVisualizationShade::SetAdvancedVisViewUpdateMode

(

NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType

advancedVisViewUpdateMode

)

Sets the update mode for advanced visualization views.

Created in NX3.0.0.

License requirements : None

Parameters

advancedVisViewUpdateMode

advanced vis view update mode

void NXOpen::Preferences::PartVisualizationShade::SetAdvVisViewFacetTolerances	(	NXOpen::Preferences::PartVisualizationShade::AdvViewToleranceType	advVisViewToleranceSet,
		double	edgeTolerance,
		double	faceTolerance,
		double	angleTolerance,
		double	widthTolerance
	)

Sets the edge, face, angle and width tolerances to be used with the specified tolerance set for Advanced Visualization views.

Created in NX8.0.0.

License requirements : None

Parameters

advVisViewToleranceSet	adv vis view tolerance set
edgeTolerance	edge tolerance
faceTolerance	face tolerance
angleTolerance	angle tolerance
widthTolerance	width tolerance

void NXOpen::Preferences::PartVisualizationShade::SetAlignAdvVisViewFacetsAlongEdges

(

bool

alignAdvVisViewFacetsAlongEdges

)

Sets the state of whether facets should be aligned along common edges for Advanced Visualization Views
Created in NX8.5.0.

License requirements : None

Parameters

alignAdvVisViewFacetsAlongEdges

align adv vis view facets along edges

void NXOpen::Preferences::PartVisualizationShade::SetAlignShadedViewFacetsAlongEdges

(

bool

alignShadedViewFacetsAlongEdges

)

Sets the state of whether facets should be aligned along common edges for Shaded Views
Created in NX8.5.0.

License requirements : None

Parameters

alignShadedViewFacetsAlongEdges

align shaded view facets along edges

void NXOpen::Preferences::PartVisualizationShade::SetHiddenGeometryColor

(

int

hiddenGeomColor

)

Sets the shade hidden geometry color.

Created in NX3.0.0.

License requirements : None

Parameters

hiddenGeomColor

hidden geom color

void NXOpen::Preferences::PartVisualizationShade::SetShadedViewFacetTolerances	(	NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType	shadedViewToleranceSet,
		double	edgeTolerance,
		double	faceTolerance,
		double	angleTolerance
	)

Sets the edge, face and angle tolerances to be used with the specified tolerance set for shaded views.

Created in NX8.0.0.

License requirements : None

Parameters

shadedViewToleranceSet	shaded view tolerance set
edgeTolerance	edge tolerance
faceTolerance	face tolerance
angleTolerance	angle tolerance

void NXOpen::Preferences::PartVisualizationShade::SetShadedViewTolerance

(

NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType

shadedViewTolerance

)

Sets the tolerance for shaded views.

Created in NX3.0.0.

License requirements : None

Parameters

shadedViewTolerance

shaded view tolerance

void NXOpen::Preferences::PartVisualizationShade::SetShadedViewUpdateMode

(

NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType

shadedViewUpdateMode

)

Sets the update mode for shaded views.

Created in NX3.0.0.

License requirements : None

Parameters

shadedViewUpdateMode

shaded view update mode

NXOpen::Preferences::PartVisualizationShade::ShadedViewToleranceType NXOpen::Preferences::PartVisualizationShade::ShadedViewTolerance

(

)

Returns the tolerance for shaded views.

Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::PartVisualizationShade::ViewUpdateModeType NXOpen::Preferences::PartVisualizationShade::ShadedViewUpdateMode

(

)

Returns the update mode for shaded views.

Created in NX3.0.0.

License requirements : None

tag_t NXOpen::Preferences::PartVisualizationShade::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• Preferences_PartVisualizationShade.hxx