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

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

List of all members.

Public Types

enum  DimensionLabelType { DimensionLabelTypeExpression, DimensionLabelTypeName, DimensionLabelTypeValue }
 Describes the available dimension labels. More...

Public Member Functions

void ApplySketchPreferences (int dimDisplayFlag)
 Applies sketch preferences set by user.
bool ContinuousAutoDimensioningSetting ()
 Returns the state of continuous auto dimensioning in a sketch.
bool CreateInferredConstraints ()
 Returns the create inferred constraints.
double DecimalPlaces ()
 Returns the decimal places.
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.
double FixedTextSize ()
 Returns the fixed text size.
void SetContinuousAutoDimensioningSetting (bool autoDim)
 Sets the state of continuous auto dimensioning in a sketch.
void SetCreateInferredConstraints (bool createInferredConstraints)
 Sets the create inferred constraints.
void SetDecimalPlaces (double decimalPlaces)
 Sets the decimal places.
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 SetFixedTextSize (double fixedTextSize)
 Sets the fixed text size.
void SetTextHeight (double textHeight)
 Sets the text height.
void SetTextSizeFixed (bool textSizeFixed)
 Sets the text size fixed.
tag_t Tag () const
 Returns the tag of this object.
double TextHeight ()
 Returns the text height.
bool TextSizeFixed ()
 Returns the text size fixed.

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

Describes the available 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

Applies sketch preferences set by user.


Created in NX3.0.0.

License requirements : None

Parameters:
dimDisplayFlagdim display flag

Returns the state of continuous auto dimensioning in a sketch.

If it is ON then auto dimensioner will be automatically ran right after individual curve was created.
Created in NX7.5.0.

License requirements : None

Returns the create inferred constraints.

Controls whether to create inferred constraints
Created in NX6.0.0.

License requirements : None

Returns the decimal places.

Defines the number of digits to display after the decimal point on sketch dimensions (dimensional constraints). The default value is three. NX6 - The decimal places preference has been removed from sketches. Each sketch dimension's decimal places will be controlled via its own annotation preferences. get function - will always return the annotation preferences- dimension- decimal places. set function - will apply the preference to each dimension in the sketch. The annotation preference can be asked or set by Preferences::AnnotationPreferences::SetDimensionPreferences and Preferences::AnnotationPreferences::GetDimensionPreferences

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the dimension label.

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

License requirements : None

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



License requirements : None

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

Sets the state of continuous auto dimensioning in a sketch.

If it is ON then auto dimensioner will be automatically ran right after individual curve was created.
Created in NX7.5.0.

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

Parameters:
autoDimauto dim

Sets the create inferred constraints.

Controls whether to create inferred constraints
Created in NX6.0.0.

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

Parameters:
createInferredConstraintscreate inferred constraints

Sets the decimal places.

Defines the number of digits to display after the decimal point on sketch dimensions (dimensional constraints). The default value is three. NX6 - The decimal places preference has been removed from sketches. Each sketch dimension's decimal places will be controlled via its own annotation preferences. get function - will always return the annotation preferences- dimension- decimal places. set function - will apply the preference to each dimension in the sketch. The annotation preference can be asked or set by Preferences::AnnotationPreferences::SetDimensionPreferences and Preferences::AnnotationPreferences::GetDimensionPreferences

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
decimalPlacesdecimal places

Sets the dimension label.

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

License requirements : None

Parameters:
dimensionLabeldimension label

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:
displayObjectColordisplay object color

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:
fixedTextSizefixed text size

Sets the text height.

It is size of text displayed in sketch dimensions. The default is 0.125 NX6 - The text height preference has been removed from sketches. Each sketch dimension's text height will be controlled via its own annotation preferences. get function - will always return the annotation preferences- letter prefs- dimension- text height. set function - will apply the preference to each dimension in the sketch. The annotation preference can be asked or set by Preferences::AnnotationPreferences::SetLetteringPreferences and Preferences::AnnotationPreferences::GetLetteringPreferences


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
textHeighttext height

Sets the text size fixed.

Controls whether to fix text size
Created in NX6.0.0.

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

Parameters:
textSizeFixedtext size fixed

Returns the tag of this object.

Returns the text height.

It is size of text displayed in sketch dimensions. The default is 0.125 NX6 - The text height preference has been removed from sketches. Each sketch dimension's text height will be controlled via its own annotation preferences. get function - will always return the annotation preferences- letter prefs- dimension- text height. set function - will apply the preference to each dimension in the sketch. The annotation preference can be asked or set by Preferences::AnnotationPreferences::SetLetteringPreferences and Preferences::AnnotationPreferences::GetLetteringPreferences


Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the text size fixed.

Controls whether to fix text size
Created in NX6.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.