|
NX Open C++ Reference Guide
|
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 setting that controls whether or not to continuously create auto dimensions in a sketch. More... | |
| bool | CreateInferredConstraints () |
| Returns the setting that controls whether or not 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 setting that controls whether or not objects are displayed in their actual color in sketch Created in NX4.0.0. More... | |
| bool | DisplayObjectName () |
| Returns the setting that controls whether or not objects are displayed with their names in sketch. More... | |
| bool | DisplayParenthesesOnReferenceDimensions () |
| Returns the setting that controls whether or not parentheses are displayed on reference dimensions. More... | |
| bool | DisplayReferenceGeometry () |
| Returns the setting that controls whether or not the reference geometry are displayed on inactive sketches Created in NX11.0.1. More... | |
| bool | DisplayVertices () |
| Returns the setting that controls whether or not vertices are displayed in an active sketch. 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 setting that controls whether or not to continuously create auto dimensions in a sketch. More... | |
| void | SetCreateInferredConstraints (bool createInferredConstraints) |
| Sets the setting that controls whether or not 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 setting that controls whether or not objects are displayed in their actual color in sketch Created in NX4.0.0. More... | |
| void | SetDisplayObjectName (bool displayObjectName) |
| Sets the setting that controls whether or not objects are displayed with their names in sketch. More... | |
| void | SetDisplayParenthesesOnReferenceDimensions (bool displayParentheses) |
| Sets the setting that controls whether or not parentheses are displayed on reference dimensions. More... | |
| void | SetDisplayReferenceGeometry (bool displayReferenceGeometry) |
| Sets the setting that controls whether or not the reference geometry are displayed on inactive sketches Created in NX11.0.1. More... | |
| void | SetDisplayVertices (bool displayVertices) |
| Sets the setting that controls whether or not vertices are displayed in an active sketch. 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 setting that controls whether or not the dimension text size should be fixed. More... | |
| void | SetUseSolvingTolerance (bool useTolerance) |
| Sets the setting that controls whether or not to use user input for sketch solving tolerance. More... | |
| double | SolvingTolerance () |
| Returns the sketch solving tolerance. More... | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
| bool | TextSizeFixed () |
| Returns the setting that controls whether or not the dimension text size should be fixed. More... | |
| bool | UseSolvingTolerance () |
| Returns the setting that controls whether or not to use user input for sketch solving tolerance. More... | |
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.
Describes the different options for displaying dimension labels.
| 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
| 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 setting that controls whether or not to continuously create auto dimensions in a sketch.
If the option is true (On) then the auto dimensioner will be automatically executed after an individual curve is created in a sketch.
Created in NX7.5.0.
License requirements : None
| bool NXOpen::Preferences::SketchPreferences::CreateInferredConstraints | ( | ) |
Returns the setting that controls whether or not 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 setting that controls whether or not objects are displayed in their actual color in sketch
Created in NX4.0.0.
License requirements : None
| bool NXOpen::Preferences::SketchPreferences::DisplayObjectName | ( | ) |
Returns the setting that controls whether or not objects are displayed with their names in sketch.
Created in NX9.0.0.
License requirements : None
| bool NXOpen::Preferences::SketchPreferences::DisplayParenthesesOnReferenceDimensions | ( | ) |
Returns the setting that controls whether or not parentheses are displayed on reference dimensions.
Created in NX11.0.1.
License requirements : None
| bool NXOpen::Preferences::SketchPreferences::DisplayReferenceGeometry | ( | ) |
Returns the setting that controls whether or not the reference geometry are displayed on inactive sketches
Created in NX11.0.1.
License requirements : None
| bool NXOpen::Preferences::SketchPreferences::DisplayVertices | ( | ) |
Returns the setting that controls whether or not vertices are displayed in an active sketch.
Created in NX11.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")
| constraintSize | constraint size |
| void NXOpen::Preferences::SketchPreferences::SetContinuousAutoDimensioningSetting | ( | bool | autoDim | ) |
Sets the setting that controls whether or not to continuously create auto dimensions in a sketch.
If the option is true (On) then the auto dimensioner will be automatically executed 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")
| autoDim | auto dim |
| void NXOpen::Preferences::SketchPreferences::SetCreateInferredConstraints | ( | bool | createInferredConstraints | ) |
Sets the setting that controls whether or not 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")
| 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
| dimensionLabel | dimension label |
| void NXOpen::Preferences::SketchPreferences::SetDisplayObjectColor | ( | bool | displayObjectColor | ) |
Sets the setting that controls whether or not 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")
| displayObjectColor | display object color |
| void NXOpen::Preferences::SketchPreferences::SetDisplayObjectName | ( | bool | displayObjectName | ) |
Sets the setting that controls whether or not 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")
| displayObjectName | displayobjectname |
| void NXOpen::Preferences::SketchPreferences::SetDisplayParenthesesOnReferenceDimensions | ( | bool | displayParentheses | ) |
Sets the setting that controls whether or not parentheses are displayed on reference dimensions.
Created in NX11.0.1.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
| displayParentheses | displayparentheses |
| void NXOpen::Preferences::SketchPreferences::SetDisplayReferenceGeometry | ( | bool | displayReferenceGeometry | ) |
Sets the setting that controls whether or not the reference geometry are displayed on inactive sketches
Created in NX11.0.1.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
| displayReferenceGeometry | displayreferencegeometry |
| void NXOpen::Preferences::SketchPreferences::SetDisplayVertices | ( | bool | displayVertices | ) |
Sets the setting that controls whether or not vertices are displayed in an active sketch.
Created in NX11.0.0.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
| displayVertices | displayvertices |
| 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")
| 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") OR geometric_tol ("GDT")
| tolerance | tolerance |
| void NXOpen::Preferences::SketchPreferences::SetTextSizeFixed | ( | bool | textSizeFixed | ) |
Sets the setting that controls whether or not the dimension text size should be fixed.
Created in NX6.0.0.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
| textSizeFixed | text size fixed |
| void NXOpen::Preferences::SketchPreferences::SetUseSolvingTolerance | ( | bool | useTolerance | ) |
Sets the setting that controls whether or not to use user input for sketch solving tolerance.
Created in NX8.5.0.
License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
| 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 setting that controls whether or not the dimension text size should be fixed.
Created in NX6.0.0.
License requirements : None
| bool NXOpen::Preferences::SketchPreferences::UseSolvingTolerance | ( | ) |
Returns the setting that controls whether or not to use user input for sketch solving tolerance.
Created in NX8.5.0.
License requirements : None