NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Preferences::SketchPreferences Class Reference

Represents the set of sketch preferences applicable on NXOpen::Sketch object
To obtain an instance of this class, refer to NXOpen::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. More...
 
double ConstraintSymbolSize ()
 Returns the constraint symbol size
Created in NX8.5.0. More...
 
bool ContinuousAutoDimensioningSetting ()
 Returns the option to set continuous auto dimensioning in a sketch on or off. More...
 
bool CreateInferredConstraints ()
 Returns the option to control if inferred constraints are automatically created when curves and points are created in the sketch. More...
 
NXOpen::Preferences::SketchPreferences::DimensionLabelType DimensionLabel ()
 Returns the dimension label. More...
 
bool DisplayObjectColor ()
 Returns the toggle that controls whether objects are displayed in their actual color in sketch
Created in NX4.0.0. More...
 
bool DisplayObjectName ()
 Returns the toggle that controls whether objects are displayed with their names in sketch
Created in NX9.0.0. More...
 
double FixedTextSize ()
 Returns the fixed text size. More...
 
void SetConstraintSymbolSize (double constraintSize)
 Sets the constraint symbol size
Created in NX8.5.0. More...
 
void SetContinuousAutoDimensioningSetting (bool autoDim)
 Sets the option to set continuous auto dimensioning in a sketch on or off. More...
 
void SetCreateInferredConstraints (bool createInferredConstraints)
 Sets the option to control if inferred constraints are automatically created when curves and points are created in the sketch. More...
 
void SetDimensionLabel (NXOpen::Preferences::SketchPreferences::DimensionLabelType dimensionLabel)
 Sets the dimension label. More...
 
void SetDisplayObjectColor (bool displayObjectColor)
 Sets the toggle that controls whether objects are displayed in their actual color in sketch
Created in NX4.0.0. More...
 
void SetDisplayObjectName (bool displayObjectName)
 Sets the toggle that controls whether objects are displayed with their names in sketch
Created in NX9.0.0. More...
 
void SetFixedTextSize (double fixedTextSize)
 Sets the fixed text size. More...
 
void SetSolvingTolerance (double tolerance)
 Sets the sketch solving tolerance. More...
 
void SetTextSizeFixed (bool textSizeFixed)
 Sets the option that controls if the text size should be fixed. More...
 
void SetUseSolvingTolerance (bool useTolerance)
 Sets the sketch solving tolerance flag. More...
 
double SolvingTolerance ()
 Returns the sketch solving tolerance. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
bool TextSizeFixed ()
 Returns the option that controls if the text size should be fixed. More...
 
bool UseSolvingTolerance ()
 Returns the sketch solving tolerance flag. More...
 

Detailed Description

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

Created in NX3.0.0.


Member Enumeration Documentation

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 NXOpen::Annotations::AnnotationManager::MakePmi in an active sketch or NXOpen::Features::EditDimensionBuilder::DisplayAsPmi and NXOpen::Features::EditDimensionBuilder::SetDisplayAsPmi when not in an active sketch.
Created in NX3.0.0.

License requirements : None

Parameters
dimDisplayFlagIf 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") OR geometric_tol ("GDT")

Parameters
constraintSizeconstraint 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") OR geometric_tol ("GDT")

Parameters
autoDimauto 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") OR geometric_tol ("GDT")

Parameters
createInferredConstraintscreate 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
dimensionLabeldimension 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") OR geometric_tol ("GDT")

Parameters
displayObjectColordisplay 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") OR geometric_tol ("GDT")

Parameters
displayObjectNamedisplayobjectname
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") OR geometric_tol ("GDT")

Parameters
fixedTextSizefixed 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") OR geometric_tol ("GDT")

Parameters
tolerancetolerance
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") OR geometric_tol ("GDT")

Parameters
textSizeFixedtext 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") OR geometric_tol ("GDT")

Parameters
useToleranceusetolerance
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:
Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.