Represents the set of sketch preferences applicable on Sketch object
To obtain an instance of this class, refer to Sketch

Created in NX3.0.0. More...

Public Types
enum	DimensionLabelType { DimensionLabelTypeExpression, DimensionLabelTypeName, DimensionLabelTypeValue }
	Describes the different options for displaying dimension labels. More...

Public Member Functions
void	ApplySketchPreferences (int dimDisplayFlag)
	Applies sketch preferences set by user.

double	ConstraintSymbolSize ()
	Returns the constraint symbol size Created in NX8.5.0.

bool	ContinuousAutoDimensioningSetting ()
	Returns the option to set continuous auto dimensioning in a sketch on or off.

bool	CreateInferredConstraints ()
	Returns the option to control if inferred constraints are automatically created when curves and points are created in the sketch.

NXOpen::Preferences::SketchPreferences::DimensionLabelType	DimensionLabel ()
	Returns the dimension label.

bool	DisplayObjectColor ()
	Returns the toggle that controls whether objects are displayed in their actual color in sketch Created in NX4.0.0.

bool	DisplayObjectName ()
	Returns the toggle that controls whether objects are displayed with their names in sketch Created in NX9.0.0.

double	FixedTextSize ()
	Returns the fixed text size.

void	SetConstraintSymbolSize (double constraintSize)
	Sets the constraint symbol size Created in NX8.5.0.

void	SetContinuousAutoDimensioningSetting (bool autoDim)
	Sets the option to set continuous auto dimensioning in a sketch on or off.

void	SetCreateInferredConstraints (bool createInferredConstraints)
	Sets the option to control if inferred constraints are automatically created when curves and points are created in the sketch.

void	SetDimensionLabel (NXOpen::Preferences::SketchPreferences::DimensionLabelType dimensionLabel)
	Sets the dimension label.

void	SetDisplayObjectColor (bool displayObjectColor)
	Sets the toggle that controls whether objects are displayed in their actual color in sketch Created in NX4.0.0.

void	SetDisplayObjectName (bool displayObjectName)
	Sets the toggle that controls whether objects are displayed with their names in sketch Created in NX9.0.0.

void	SetFixedTextSize (double fixedTextSize)
	Sets the fixed text size.

void	SetSolvingTolerance (double tolerance)
	Sets the sketch solving tolerance.

void	SetTextSizeFixed (bool textSizeFixed)
	Sets the option that controls if the text size should be fixed.

void	SetUseSolvingTolerance (bool useTolerance)
	Sets the sketch solving tolerance flag.

double	SolvingTolerance ()
	Returns the sketch solving tolerance.

tag_t	Tag () const
	Returns the tag of this object.

bool	TextSizeFixed ()
	Returns the option that controls if the text size should be fixed.

bool	UseSolvingTolerance ()
	Returns the sketch solving tolerance flag.

Detailed Description

Represents the set of sketch preferences applicable on Sketch object
To obtain an instance of this class, refer to Sketch

Created in NX3.0.0.

Member Enumeration Documentation

enum NXOpen::Preferences::SketchPreferences::DimensionLabelType

Describes the different options for displaying dimension labels.

Enumerator:

DimensionLabelTypeExpression	Displays the entire expression such as P2=P3*4.
DimensionLabelTypeName	Displays only the name of the expression, such as P2.
DimensionLabelTypeValue	Displays the numerical value of the expression.

Member Function Documentation

void NXOpen::Preferences::SketchPreferences::ApplySketchPreferences ( int dimDisplayFlag )

Applies sketch preferences set by user.

The dimDisplayFlag is the API version of the UI setting of Retain Dimensions which was last available for use in NX 6. The setting still exists in the UI for legacy parts that have a sketch with Retain Dimensions enabled. However, once the setting is turned off, it cannot be turned on again. This functionality is replaced by Annotations::AnnotationManager::MakePmi in an active sketch or Features::EditDimensionBuilder::DisplayAsPmi and Features::EditDimensionBuilder::SetDisplayAsPmi when not in an active sketch.
Created in NX3.0.0.

License requirements : None

Parameters

dimDisplayFlag If sketch dimensions are already displayed outside of an active sketch, Set 0 to turn off the display of dimensions outside of the active sketch.

double NXOpen::Preferences::SketchPreferences::ConstraintSymbolSize ( )

Returns the constraint symbol size
Created in NX8.5.0.

License requirements : None

bool NXOpen::Preferences::SketchPreferences::ContinuousAutoDimensioningSetting ( )

Returns the option to set continuous auto dimensioning in a sketch on or off.

If the option is true (On) then the auto dimensioner will be automatically executed right after an individual curve is created in a sketch.
Created in NX7.5.0.

License requirements : None

bool NXOpen::Preferences::SketchPreferences::CreateInferredConstraints ( )

Returns the option to control if inferred constraints are automatically created when curves and points are created in the sketch.

Created in NX6.0.0.

License requirements : None

NXOpen::Preferences::SketchPreferences::DimensionLabelType NXOpen::Preferences::SketchPreferences::DimensionLabel ( )

Returns the dimension label.

Controls how expressions in sketch dimensions are displayed
Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::SketchPreferences::DisplayObjectColor ( )

Returns the toggle that controls whether objects are displayed in their actual color in sketch
Created in NX4.0.0.

License requirements : None

bool NXOpen::Preferences::SketchPreferences::DisplayObjectName ( )

Returns the toggle that controls whether objects are displayed with their names in sketch
Created in NX9.0.0.

License requirements : None

double NXOpen::Preferences::SketchPreferences::FixedTextSize ( )

Returns the fixed text size.

It is the visible dimension size when text size fixed is enabled.
Created in NX6.0.0.

License requirements : None

void NXOpen::Preferences::SketchPreferences::SetConstraintSymbolSize ( double constraintSize )

Sets the constraint symbol size
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

constraintSize constraint size

void NXOpen::Preferences::SketchPreferences::SetContinuousAutoDimensioningSetting ( bool autoDim )

Sets the option to set continuous auto dimensioning in a sketch on or off.

If the option is true (On) then the auto dimensioner will be automatically executed right after an individual curve is created in a sketch.
Created in NX7.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

autoDim auto dim

void NXOpen::Preferences::SketchPreferences::SetCreateInferredConstraints ( bool createInferredConstraints )

Sets the option to control if inferred constraints are automatically created when curves and points are created in the sketch.

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

createInferredConstraints create inferred constraints

void NXOpen::Preferences::SketchPreferences::SetDimensionLabel ( NXOpen::Preferences::SketchPreferences::DimensionLabelType dimensionLabel )

Sets the dimension label.

Controls how expressions in sketch dimensions are displayed
Created in NX3.0.0.

License requirements : None

Parameters

dimensionLabel dimension label

void NXOpen::Preferences::SketchPreferences::SetDisplayObjectColor ( bool displayObjectColor )

Sets the toggle that controls whether objects are displayed in their actual color in sketch
Created in NX4.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

displayObjectColor display object color

void NXOpen::Preferences::SketchPreferences::SetDisplayObjectName ( bool displayObjectName )

Sets the toggle that controls whether objects are displayed with their names in sketch
Created in NX9.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

displayObjectName displayobjectname

void NXOpen::Preferences::SketchPreferences::SetFixedTextSize ( double fixedTextSize )

Sets the fixed text size.

It is the visible dimension size when text size fixed is enabled.
Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

fixedTextSize fixed text size

void NXOpen::Preferences::SketchPreferences::SetSolvingTolerance ( double tolerance )

Sets the sketch solving tolerance.

This specifies the maximum allowable distance between two objects when solving the sketch constraints for the given sketch. The tolerance value must be greater than 1e-08.
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

tolerance tolerance

void NXOpen::Preferences::SketchPreferences::SetTextSizeFixed ( bool textSizeFixed )

Sets the option that controls if the text size should be fixed.

Created in NX6.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

textSizeFixed text size fixed

void NXOpen::Preferences::SketchPreferences::SetUseSolvingTolerance ( bool useTolerance )

Sets the sketch solving tolerance flag.

Controls whether to use user input for sketch tolerance
Created in NX8.5.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

useTolerance usetolerance

double NXOpen::Preferences::SketchPreferences::SolvingTolerance ( )

Returns the sketch solving tolerance.

This specifies the maximum allowable distance between two objects when solving the sketch constraints for the given sketch. The tolerance value must be greater than 1e-08.
Created in NX8.5.0.

License requirements : None

tag_t NXOpen::Preferences::SketchPreferences::Tag ( ) const

Returns the tag of this object.

bool NXOpen::Preferences::SketchPreferences::TextSizeFixed ( )

Returns the option that controls if the text size should be fixed.

Created in NX6.0.0.

License requirements : None

bool NXOpen::Preferences::SketchPreferences::UseSolvingTolerance ( )

Returns the sketch solving tolerance flag.

Controls whether to use user input for sketch tolerance
Created in NX8.5.0.

License requirements : None

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

Preferences_SketchPreferences.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation