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

Represents the set of sketch preferences applicable to entire session
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX3.0.0. More...

List of all members.

Public Types

enum  BackgroundType { BackgroundTypeInherit, BackgroundTypePlain }
 Describes the available sketch background types. More...
enum  OriginType { OriginTypeInferFromPlaneSelection, OriginTypeProjectWorkPartOrigin }
 Describes the available sketch origin types. More...

Public Member Functions

bool AutoDimensionsToArcCenter ()
 Returns the flag of auto-dimensions to arc centre.
NXOpen::Preferences::SessionSketch::BackgroundType BackgroundOption ()
 Returns the background option
Created in NX5.0.0.
bool ChangeViewOrientation ()
 Returns the change view orientation flag.
bool ContinuousAutoDimensioning ()
 Returns the continuous auto dimensioning state in sketch preferences.
bool CreateInferredConstraints ()
 Returns the create inferred constraints
Created in NX6.0.0.
int DecimalPlaces ()
 Returns the decimal places NX6 - The decimal places preference has been removed from sketches.
NXString DefaultArcNamePrefix ()
 Returns the default arc name prefix
Created in NX3.0.0.
NXString DefaultConicNamePrefix ()
 Returns the default conic name prefix
Created in NX3.0.0.
NXString DefaultLineNamePrefix ()
 Returns the default line name prefix
Created in NX3.0.0.
NXString DefaultSketchNamePrefix ()
 Returns the default sketch name prefix
Created in NX3.0.0.
NXString DefaultSplineNamePrefix ()
 Returns the default spline name prefix
Created in NX3.0.0.
NXString DefaultVertexNamePrefix ()
 Returns the default vertex name prefix
Created in NX3.0.0.
bool DelayEvaluation ()
 Returns the delay evaluation preference.
NXOpen::Preferences::SketchPreferences::DimensionLabelType DimensionLabel ()
 Returns the dimension label
Created in NX3.0.0.
bool DisplayDOFArrows ()
 Returns the displays DOF arrows flag.
bool DisplayObjectColor ()
 Returns the display object color
Created in NX6.0.0.
bool DisplaySectionMappingWarning ()
 Returns the display section mapping warning flag.
bool DynamicConstraintDisplay ()
 Returns the dynamic constraints display flag.
double FixedTextSize ()
 Returns the dimension text size when the text size fixed flag is set.
bool MaintainBlankStatus ()
 Returns the maintain blank status flag.
bool MaintainLayerStatus ()
 Returns the maintain layer status flag.
NXOpen::Preferences::SessionSketch::OriginType OriginOption ()
 Returns the origin option

bool RetainDimensions ()
 Returns the retain dimensions flag.
void SetAutoDimensionsToArcCenter (bool toArcCenter)
 Sets the flag of auto-dimensions to arc centre.
void SetBackgroundOption (NXOpen::Preferences::SessionSketch::BackgroundType backgroundType)
 Sets the background option
Created in NX5.0.0.
void SetChangeViewOrientation (bool changeViewOrientation)
 Sets the change view orientation flag.
void SetContinuousAutoDimensioning (bool continAutoDim)
 Sets the continuous auto dimensioning state in sketch preferences.
void SetCreateInferredConstraints (bool createInferredConstraints)
 Sets the create inferred constraints
Created in NX6.0.0.
void SetDecimalPlaces (int decimalPlaces)
 Sets the decimal places NX6 - The decimal places preference has been removed from sketches.
void SetDefaultArcNamePrefix (const NXString &defaultArcNamePrefix)
 Sets the default arc name prefix
Created in NX3.0.0.
void SetDefaultConicNamePrefix (const NXString &defaultConicNamePrefix)
 Sets the default conic name prefix
Created in NX3.0.0.
void SetDefaultLineNamePrefix (const NXString &defaultLineNamePrefix)
 Sets the default line name prefix
Created in NX3.0.0.
void SetDefaultSketchNamePrefix (const NXString &defaultSketchNamePrefix)
 Sets the default sketch name prefix
Created in NX3.0.0.
void SetDefaultSplineNamePrefix (const NXString &defaultSplineNamePrefix)
 Sets the default spline name prefix
Created in NX3.0.0.
void SetDefaultVertexNamePrefix (const NXString &defaultVertexNamePrefix)
 Sets the default vertex name prefix
Created in NX3.0.0.
void SetDelayEvaluation (bool delayEvaluation)
 Sets the delay evaluation preference.
void SetDimensionLabel (NXOpen::Preferences::SketchPreferences::DimensionLabelType dimensionLabel)
 Sets the dimension label
Created in NX3.0.0.
void SetDisplayDOFArrows (bool displayDOFArrows)
 Sets the displays DOF arrows flag.
void SetDisplayObjectColor (bool displayObjColor)
 Sets the display object color
Created in NX6.0.0.
void SetDisplaySectionMappingWarning (bool displaySectionMappingWarning)
 Sets the display section mapping warning flag.
void SetDynamicConstraintDisplay (bool dynamicConstraintDisplay)
 Sets the dynamic constraints display flag.
void SetFixedTextSize (double fixedTextSize)
 Sets the dimension text size when the text size fixed flag is set.
void SetMaintainBlankStatus (bool keepBlank)
 Sets the maintain blank status flag.
void SetMaintainLayerStatus (bool maintainLayerStatus)
 Sets the maintain layer status flag.
void SetOriginOption (NXOpen::Preferences::SessionSketch::OriginType originType)
 Sets the origin option

void SetRetainDimensions (bool retainDimensions)
 Sets the retain dimensions flag.
void SetSnapAngle (double snapAngle)
 Sets the snap angle.
void SetTextHeight (double textHeight)
 Sets the text height NX6 - The text height preference has been removed from sketches.
void SetTextSizeFixed (bool textSizeFixed)
 Sets the text size fixed flag.
void SetUpdateSketchOnly (bool delayModelUpdate)
 Sets the update sketch only preference.
double SnapAngle ()
 Returns the snap angle.
tag_t Tag () const
 Returns the tag of this object.
double TextHeight ()
 Returns the text height NX6 - The text height preference has been removed from sketches.
bool TextSizeFixed ()
 Returns the text size fixed flag.
bool UpdateSketchOnly ()
 Returns the update sketch only preference.

Detailed Description

Represents the set of sketch preferences applicable to entire session
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX3.0.0.



Member Enumeration Documentation

Describes the available sketch background types.

Enumerator:
BackgroundTypeInherit 

Sketch background color is inherited from the parent application.

BackgroundTypePlain 

Sketch background color is forced to the plain background color.

Describes the available sketch origin types.

Enumerator:
OriginTypeInferFromPlaneSelection 

Sketch origin is inferred from placement face.

OriginTypeProjectWorkPartOrigin 

Sketch origin is the projection of the work part origin.


Member Function Documentation

Returns the flag of auto-dimensions to arc centre.

If it is set to true, then we will infer auto-dimensions to arc centre when running auto-dimension
Created in NX7.5.0.

License requirements : None

Returns the background option
Created in NX5.0.0.



License requirements : None

Returns the change view orientation flag.

If true, when a sketch is activated, the view will be changed to align with the sketch
Created in NX3.0.0.

License requirements : None

Returns the continuous auto dimensioning state in sketch preferences.

Newly created sketch gets continuous auto dimensioning state from sketch preference.
Created in NX7.5.0.

License requirements : None

Returns the create inferred constraints
Created in NX6.0.0.



License requirements : None

Returns the decimal places 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 do nothing. The annotation preference can be asked or set by Preferences::AnnotationPreferences::SetDimensionPreferences and Preferences::AnnotationPreferences::SetDimensionPreferences

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Returns the default arc name prefix
Created in NX3.0.0.



License requirements : None

Returns the default conic name prefix
Created in NX3.0.0.



License requirements : None

Returns the default line name prefix
Created in NX3.0.0.



License requirements : None

Returns the default sketch name prefix
Created in NX3.0.0.



License requirements : None

Returns the default spline name prefix
Created in NX3.0.0.



License requirements : None

Returns the default vertex name prefix
Created in NX3.0.0.



License requirements : None

Returns the delay evaluation preference.

This preference is used in the UI to indicate whether the sketch should be evaluated when a constraint is added to the sketch.
Created in NX3.0.0.

License requirements : None

Returns the dimension label
Created in NX3.0.0.



License requirements : None

Returns the displays DOF arrows flag.

Controls the display of the degree of freedom arrows. When this flag is set as False, the display of the arrows is turned OFF.
Created in NX3.0.0.

License requirements : None

Returns the display object color
Created in NX6.0.0.



License requirements : None

Returns the display section mapping warning flag.

If this is true, when user exits sketcher, would get a warning that some dependent feature section may require mapping
Created in NX7.5.0.

License requirements : None

Returns the dynamic constraints display flag.

If it is True, constraint symbols do not display if the associated geometry is very small.
Created in NX3.0.0.

License requirements : None

Returns the dimension text size when the text size fixed flag is set.


Created in NX6.0.0.

License requirements : None

Returns the maintain blank status flag.

If true, when a sketch is activated, previously blanked objects will not be visible
Created in NX6.0.0.

License requirements : None

Returns the maintain layer status flag.

Controls whether the work layer remains the same or returns to its previous value when a sketch is deactivated.
Created in NX3.0.0.

License requirements : None

Returns the origin option

Deprecated:
Deprecated in NX8.0.0.



Created in NX5.0.0.

License requirements : None

Returns the retain dimensions flag.

If it is True, sketch dimensions continue to display after a sketch is deactivated.

Deprecated:
Deprecated in NX8.0.1. Use Annotations::AnnotationManager::MakePmi and Annotations::AnnotationManager::RemovePmi with individual dimensions instead.


Created in NX3.0.0.

License requirements : None

Sets the flag of auto-dimensions to arc centre.

If it is set to true, then we will infer auto-dimensions to arc centre when running auto-dimension
Created in NX7.5.0.

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

Parameters:
toArcCentertoarccenter

Sets the background option
Created in NX5.0.0.



License requirements : None

Parameters:
backgroundTypebackground type

Sets the change view orientation flag.

If true, when a sketch is activated, the view will be changed to align with the sketch
Created in NX3.0.0.

License requirements : None

Parameters:
changeViewOrientationchange view orientation

Sets the continuous auto dimensioning state in sketch preferences.

Newly created sketch gets continuous auto dimensioning state from sketch preference.
Created in NX7.5.0.

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

Parameters:
continAutoDimcontin auto dim
void NXOpen::Preferences::SessionSketch::SetCreateInferredConstraints ( bool  createInferredConstraints)

Sets the 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 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 do nothing. The annotation preference can be asked or set by Preferences::AnnotationPreferences::SetDimensionPreferences and Preferences::AnnotationPreferences::SetDimensionPreferences

Deprecated:
Deprecated in NX6.0.0.


Created in NX3.0.0.

License requirements : None

Parameters:
decimalPlacesdecimal places

Sets the default arc name prefix
Created in NX3.0.0.



License requirements : None

Parameters:
defaultArcNamePrefixdefault arc name prefix

Sets the default conic name prefix
Created in NX3.0.0.



License requirements : None

Parameters:
defaultConicNamePrefixdefault conic name prefix

Sets the default line name prefix
Created in NX3.0.0.



License requirements : None

Parameters:
defaultLineNamePrefixdefault line name prefix

Sets the default sketch name prefix
Created in NX3.0.0.



License requirements : None

Parameters:
defaultSketchNamePrefixdefault sketch name prefix

Sets the default spline name prefix
Created in NX3.0.0.



License requirements : None

Parameters:
defaultSplineNamePrefixdefault spline name prefix

Sets the default vertex name prefix
Created in NX3.0.0.



License requirements : None

Parameters:
defaultVertexNamePrefixdefault vertex name prefix

Sets the delay evaluation preference.

This preference is used in the UI to indicate whether the sketch should be evaluated when a constraint is added to the sketch.
Created in NX3.0.0.

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

Parameters:
delayEvaluationdelay evaluation

Sets the dimension label
Created in NX3.0.0.



License requirements : None

Parameters:
dimensionLabeldimension label

Sets the displays DOF arrows flag.

Controls the display of the degree of freedom arrows. When this flag is set as False, the display of the arrows is turned OFF.
Created in NX3.0.0.

License requirements : None

Parameters:
displayDOFArrowsdisplay d o f arrows

Sets the display object color
Created in NX6.0.0.



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

Parameters:
displayObjColordisplay obj color
void NXOpen::Preferences::SessionSketch::SetDisplaySectionMappingWarning ( bool  displaySectionMappingWarning)

Sets the display section mapping warning flag.

If this is true, when user exits sketcher, would get a warning that some dependent feature section may require mapping
Created in NX7.5.0.

License requirements : None

Parameters:
displaySectionMappingWarningdisplaysectionmappingwarning
void NXOpen::Preferences::SessionSketch::SetDynamicConstraintDisplay ( bool  dynamicConstraintDisplay)

Sets the dynamic constraints display flag.

If it is True, constraint symbols do not display if the associated geometry is very small.
Created in NX3.0.0.

License requirements : None

Parameters:
dynamicConstraintDisplaydynamic constraint display

Sets the dimension text size when the text size fixed flag is set.


Created in NX6.0.0.

License requirements : None

Parameters:
fixedTextSizefixed text size

Sets the maintain blank status flag.

If true, when a sketch is activated, previously blanked objects will not be visible
Created in NX6.0.0.

License requirements : None

Parameters:
keepBlankkeep blank

Sets the maintain layer status flag.

Controls whether the work layer remains the same or returns to its previous value when a sketch is deactivated.
Created in NX3.0.0.

License requirements : None

Parameters:
maintainLayerStatusmaintain layer status

Sets the origin option

Deprecated:
Deprecated in NX8.0.0.



Created in NX5.0.0.

License requirements : None

Parameters:
originTypeorigin type

Sets the retain dimensions flag.

If it is True, sketch dimensions continue to display after a sketch is deactivated.

Deprecated:
Deprecated in NX8.0.1.


Created in NX3.0.0.

License requirements : None

Parameters:
retainDimensionsretain dimensions

Sets the snap angle.

This is snap angle tolerance for vertical, horizontal, parallel, and perpendicular lines.The default value is 3 and maximum value is 20
Created in NX3.0.0.

License requirements : None

Parameters:
snapAnglesnap angle

Sets the text height 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 do nothing. 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 flag.

If it is True, text size adjusts opposite of zoom scale so that dimensions appear a constant size.
Created in NX4.0.0.

License requirements : None

Parameters:
textSizeFixedtext size fixed

Sets the update sketch only preference.

This preference is used to indicate whether only the sketch should be updated while sketching using Direct Sketch. When this preference is set to false, an update will propagate through the whole model
Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
delayModelUpdatedelay model update

Returns the snap angle.

This is snap angle tolerance for vertical, horizontal, parallel, and perpendicular lines.The default value is 3 and maximum value is 20
Created in NX3.0.0.

License requirements : None

Returns the tag of this object.

Returns the text height 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 do nothing. 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 flag.

If it is True, text size adjusts opposite of zoom scale so that dimensions appear a constant size.
Created in NX4.0.0.

License requirements : None

Returns the update sketch only preference.

This preference is used to indicate whether only the sketch should be updated while sketching using Direct Sketch. When this preference is set to false, an update will propagate through the whole model
Created in NX8.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.