SessionSketch Class¶
-
class
NXOpen.Preferences.SessionSketch¶ Bases:
objectRepresents the set of sketch preferences applicable to entire session
To obtain an instance of this class, refer to
NXOpen.Preferences.SessionPreferencesNew in version NX3.0.0.
Properties¶
| Property | Description |
|---|---|
| AutoDimensionsToArcCenter | Returns or sets the setting that controls whether or not auto-dimensions are created to arc centers. |
| BackgroundOption | Returns or sets the background option |
| ChangeViewOrientation | Returns or sets the setting that controls whether the view orientation will be changed to align with the sketch when the sketch is activated. |
| ConstraintSymbolSize | Returns or sets the constraint symbol size. |
| ContinuousAutoDimensioning | Returns or sets the setting that controls whether or not to continuously create auto dimensions in a sketch. |
| CreateInferredConstraints | Returns or sets the setting that controls whether or not to create inferred constraints |
| DefaultArcNamePrefix | Returns or sets the default arc name prefix |
| DefaultConicNamePrefix | Returns or sets the default conic name prefix |
| DefaultLineNamePrefix | Returns or sets the default line name prefix |
| DefaultSketchNamePrefix | Returns or sets the default sketch name prefix |
| DefaultSplineNamePrefix | Returns or sets the default spline name prefix |
| DefaultVertexNamePrefix | Returns or sets the default vertex name prefix |
| DelayEvaluation | Returns or sets the setting that controls whether or not the sketch should be evaluated when a constraint is added to the sketch. |
| DimensionLabel | Returns or sets the dimension label |
| DisplayAutoDimensions | Returns or sets the setting that controls whether or not to display auto dimensions |
| DisplayConstraintSymbols | Returns or sets the setting that controls whether or not to display constraint symbols |
| DisplayDOFArrows | Returns or sets the setting that controls whether or not the degree of freedom arrows are displayed. |
| DisplayObjectColor | Returns or sets the setting that controls whether or not sketch objects should be displayed in their true color |
| DisplayObjectName | Returns or sets the setting that controls whether or not objects are displayed with their names in sketch. |
| DisplayParenthesesOnReferenceDimensions | Returns or sets the setting that controls whether or not to display parentheses on reference dimensions |
| DisplayReferenceGeometry | Returns or sets the setting that controls whether or not the reference geometry are displayed on inactive sketches. |
| DisplaySectionMappingWarning | Returns or sets the display section mapping warning flag. |
| DisplayVertices | Returns or sets the setting that controls whether or not to display sketch vertices. |
| DynamicConstraintDisplay | Returns or sets the setting that controls whether or not constraint symbols are displayed if the associated geometry is very small. |
| FixedTextSize | Returns or sets the dimension text size when the text size fixed flag is set. |
| GroupConstraintOption | Returns or sets the sketch group external constraint management option |
| MaintainBlankStatus | Returns or sets the setting that controls whether or not previously blanked objects will be visible when a sketch is activated |
| MaintainLayerStatus | Returns or sets the setting that controls whether or not the work layer remains the same or returns to its previous value when a sketch is deactivated. |
| OriginOption | Returns or sets the origin option |
| RetainDimensions | Returns or sets the retain dimensions flag. |
| RigidSetConstraintOption | Returns or sets the rigid set external constraint management option |
| ScaleOnFirstDrivingDimension | Returns or sets the setting that controls whether or not the entire active sketch is scaled about the sketch origin when the first non-angular driving dimension is applied. |
| SnapAngle | Returns or sets the snap angle. |
| SolvingTolerance | Returns or sets the sketch solving tolerance. |
| TextSizeFixed | Returns or sets the setting that controls whether or not dimension text size is fixed. |
| UpdateSketchOnly | Returns or sets the setting that controls whether or not to update only the sketch while sketching using Direct Sketch. |
| UseSolvingTolerance | Returns or sets the setting that controls whether or not to use user input for sketch solving tolerance. |
Methods¶
Enumerations¶
| SessionSketchBackgroundType Enumeration | Describes the available sketch background types. |
| SessionSketchGroupConstraintType Enumeration | Represents the constraint management option when creating a rigid or scalable sketch group. |
| SessionSketchOriginType Enumeration | Describes the available sketch origin types. |
| SessionSketchRigidSetConstraintType Enumeration | Represents the constraint management option when creating a rigid sketch group. |
Property Detail¶
AutoDimensionsToArcCenter¶
-
SessionSketch.AutoDimensionsToArcCenter¶ Returns or sets the setting that controls whether or not auto-dimensions are created to arc centers.
-------------------------------------Getter Method
Signature
AutoDimensionsToArcCenterReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AutoDimensionsToArcCenterParameters: toArcCenter (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
BackgroundOption¶
-
SessionSketch.BackgroundOption¶ Returns or sets the background option
-------------------------------------Getter Method
Signature
BackgroundOptionReturns: Return type: NXOpen.Preferences.SessionSketchBackgroundTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BackgroundOptionParameters: backgroundType ( NXOpen.Preferences.SessionSketchBackgroundType) –New in version NX5.0.0.
License requirements: None.
ChangeViewOrientation¶
-
SessionSketch.ChangeViewOrientation¶ Returns or sets the setting that controls whether the view orientation will be changed to align with the sketch when the sketch is activated.
-------------------------------------Getter Method
Signature
ChangeViewOrientationReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ChangeViewOrientationParameters: changeViewOrientation (bool) – New in version NX3.0.0.
License requirements: None.
ConstraintSymbolSize¶
-
SessionSketch.ConstraintSymbolSize¶ Returns or sets the constraint symbol size.
-------------------------------------Getter Method
Signature
ConstraintSymbolSizeReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ConstraintSymbolSizeParameters: constraintSymbolSize (float) – New in version NX8.5.0.
License requirements: None.
ContinuousAutoDimensioning¶
-
SessionSketch.ContinuousAutoDimensioning¶ Returns or sets the setting that controls whether or not to continuously create auto dimensions in a sketch.
-------------------------------------Getter Method
Signature
ContinuousAutoDimensioningReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ContinuousAutoDimensioningParameters: continAutoDim (bool) – New in version NX7.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
CreateInferredConstraints¶
-
SessionSketch.CreateInferredConstraints¶ Returns or sets the setting that controls whether or not to create inferred constraints
-------------------------------------Getter Method
Signature
CreateInferredConstraintsReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CreateInferredConstraintsParameters: createInferredConstraints (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DefaultArcNamePrefix¶
-
SessionSketch.DefaultArcNamePrefix¶ Returns or sets the default arc name prefix
-------------------------------------Getter Method
Signature
DefaultArcNamePrefixReturns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultArcNamePrefixParameters: defaultArcNamePrefix (str) – New in version NX3.0.0.
License requirements: None.
DefaultConicNamePrefix¶
-
SessionSketch.DefaultConicNamePrefix¶ Returns or sets the default conic name prefix
-------------------------------------Getter Method
Signature
DefaultConicNamePrefixReturns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultConicNamePrefixParameters: defaultConicNamePrefix (str) – New in version NX3.0.0.
License requirements: None.
DefaultLineNamePrefix¶
-
SessionSketch.DefaultLineNamePrefix¶ Returns or sets the default line name prefix
-------------------------------------Getter Method
Signature
DefaultLineNamePrefixReturns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultLineNamePrefixParameters: defaultLineNamePrefix (str) – New in version NX3.0.0.
License requirements: None.
DefaultSketchNamePrefix¶
-
SessionSketch.DefaultSketchNamePrefix¶ Returns or sets the default sketch name prefix
-------------------------------------Getter Method
Signature
DefaultSketchNamePrefixReturns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultSketchNamePrefixParameters: defaultSketchNamePrefix (str) – New in version NX3.0.0.
License requirements: None.
DefaultSplineNamePrefix¶
-
SessionSketch.DefaultSplineNamePrefix¶ Returns or sets the default spline name prefix
-------------------------------------Getter Method
Signature
DefaultSplineNamePrefixReturns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultSplineNamePrefixParameters: defaultSplineNamePrefix (str) – New in version NX3.0.0.
License requirements: None.
DefaultVertexNamePrefix¶
-
SessionSketch.DefaultVertexNamePrefix¶ Returns or sets the default vertex name prefix
-------------------------------------Getter Method
Signature
DefaultVertexNamePrefixReturns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultVertexNamePrefixParameters: defaultVertexNamePrefix (str) – New in version NX3.0.0.
License requirements: None.
DelayEvaluation¶
-
SessionSketch.DelayEvaluation¶ Returns or sets the setting that controls whether or not the sketch should be evaluated when a constraint is added to the sketch.
-------------------------------------Getter Method
Signature
DelayEvaluationReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DelayEvaluationParameters: delayEvaluation (bool) – New in version NX3.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
DimensionLabel¶
-
SessionSketch.DimensionLabel¶ Returns or sets the dimension label
-------------------------------------Getter Method
Signature
DimensionLabelReturns: Return type: NXOpen.Preferences.SketchPreferencesDimensionLabelTypeNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DimensionLabelParameters: dimensionLabel ( NXOpen.Preferences.SketchPreferencesDimensionLabelType) –New in version NX3.0.0.
License requirements: None.
DisplayAutoDimensions¶
-
SessionSketch.DisplayAutoDimensions¶ Returns or sets the setting that controls whether or not to display auto dimensions
-------------------------------------Getter Method
Signature
DisplayAutoDimensionsReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayAutoDimensionsParameters: displayAutoDimensions (bool) – New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DisplayConstraintSymbols¶
-
SessionSketch.DisplayConstraintSymbols¶ Returns or sets the setting that controls whether or not to display constraint symbols
-------------------------------------Getter Method
Signature
DisplayConstraintSymbolsReturns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayConstraintSymbolsParameters: displayConstraintSymbols (bool) – New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DisplayDOFArrows¶
-
SessionSketch.DisplayDOFArrows¶ Returns or sets the setting that controls whether or not the degree of freedom arrows are displayed.
-------------------------------------Getter Method
Signature
DisplayDOFArrowsReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayDOFArrowsParameters: displayDOFArrows (bool) – New in version NX3.0.0.
License requirements: None.
DisplayObjectColor¶
-
SessionSketch.DisplayObjectColor¶ Returns or sets the setting that controls whether or not sketch objects should be displayed in their true color
-------------------------------------Getter Method
Signature
DisplayObjectColorReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayObjectColorParameters: displayObjColor (bool) – New in version NX6.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DisplayObjectName¶
-
SessionSketch.DisplayObjectName¶ Returns or sets the setting that controls whether or not objects are displayed with their names in sketch.
-------------------------------------Getter Method
Signature
DisplayObjectNameReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayObjectNameParameters: displayObjectName (bool) – New in version NX9.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DisplayParenthesesOnReferenceDimensions¶
-
SessionSketch.DisplayParenthesesOnReferenceDimensions¶ Returns or sets the setting that controls whether or not to display parentheses on reference dimensions
-------------------------------------Getter Method
Signature
DisplayParenthesesOnReferenceDimensionsReturns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayParenthesesOnReferenceDimensionsParameters: displayParentheses (bool) – New in version NX11.0.1.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DisplayReferenceGeometry¶
-
SessionSketch.DisplayReferenceGeometry¶ Returns or sets the setting that controls whether or not the reference geometry are displayed on inactive sketches.
-------------------------------------Getter Method
Signature
DisplayReferenceGeometryReturns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayReferenceGeometryParameters: displayReferenceGeometry (bool) – New in version NX11.0.1.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DisplaySectionMappingWarning¶
-
SessionSketch.DisplaySectionMappingWarning¶ Returns or 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
-------------------------------------Getter Method
Signature
DisplaySectionMappingWarningReturns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplaySectionMappingWarningParameters: displaySectionMappingWarning (bool) – New in version NX7.5.0.
License requirements: None.
DisplayVertices¶
-
SessionSketch.DisplayVertices¶ Returns or sets the setting that controls whether or not to display sketch vertices.
-------------------------------------Getter Method
Signature
DisplayVerticesReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayVerticesParameters: displayVertices (bool) – New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
DynamicConstraintDisplay¶
-
SessionSketch.DynamicConstraintDisplay¶ Returns or sets the setting that controls whether or not constraint symbols are displayed if the associated geometry is very small.
-------------------------------------Getter Method
Signature
DynamicConstraintDisplayReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DynamicConstraintDisplayParameters: dynamicConstraintDisplay (bool) – New in version NX3.0.0.
License requirements: None.
FixedTextSize¶
-
SessionSketch.FixedTextSize¶ Returns or sets the dimension text size when the text size fixed flag is set.
-------------------------------------Getter Method
Signature
FixedTextSizeReturns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FixedTextSizeParameters: fixedTextSize (float) – New in version NX6.0.0.
License requirements: None.
GroupConstraintOption¶
-
SessionSketch.GroupConstraintOption¶ Returns or sets the sketch group external constraint management option
-------------------------------------Getter Method
Signature
GroupConstraintOptionReturns: Return type: NXOpen.Preferences.SessionSketchGroupConstraintTypeNew in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
GroupConstraintOptionParameters: constraintType ( NXOpen.Preferences.SessionSketchGroupConstraintType) –New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
MaintainBlankStatus¶
-
SessionSketch.MaintainBlankStatus¶ Returns or sets the setting that controls whether or not previously blanked objects will be visible when a sketch is activated
-------------------------------------Getter Method
Signature
MaintainBlankStatusReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaintainBlankStatusParameters: keepBlank (bool) – New in version NX6.0.0.
License requirements: None.
MaintainLayerStatus¶
-
SessionSketch.MaintainLayerStatus¶ Returns or sets the setting that controls whether or not the work layer remains the same or returns to its previous value when a sketch is deactivated.
-------------------------------------Getter Method
Signature
MaintainLayerStatusReturns: Return type: bool New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaintainLayerStatusParameters: maintainLayerStatus (bool) – New in version NX3.0.0.
License requirements: None.
OriginOption¶
-
SessionSketch.OriginOption¶ Returns or sets the origin option
-------------------------------------Getter Method
Signature
OriginOptionReturns: Return type: NXOpen.Preferences.SessionSketchOriginTypeNew in version NX5.0.0.
Deprecated since version NX8.0.0: Use
SketchInPlaceBuilder.ProjectWorkPartOrigin()andSketchInPlaceBuilder.MakeOriginAssociative()andSketchInPlaceBuilder.SketchOrigin()instead.License requirements: None.
-------------------------------------Setter Method
Signature
OriginOptionParameters: originType ( NXOpen.Preferences.SessionSketchOriginType) –New in version NX5.0.0.
Deprecated since version NX8.0.0: Use
SketchInPlaceBuilder.ProjectWorkPartOrigin()andSketchInPlaceBuilder.MakeOriginAssociative()andSketchInPlaceBuilder.SketchOrigin()instead.License requirements: None.
RetainDimensions¶
-
SessionSketch.RetainDimensions¶ Returns or sets the retain dimensions flag.
If it is True, sketch dimensions continue to display after a sketch is deactivated.
-------------------------------------Getter Method
Signature
RetainDimensionsReturns: Return type: bool New in version NX3.0.0.
Deprecated since version NX8.0.1: Use
Annotations.AnnotationManager.MakePmi()andAnnotations.AnnotationManager.RemovePmi()with individual dimensions instead.License requirements: None.
-------------------------------------Setter Method
Signature
RetainDimensionsParameters: retainDimensions (bool) – New in version NX3.0.0.
Deprecated since version NX8.0.1: Use
Annotations.AnnotationManager.MakePmi()andAnnotations.AnnotationManager.RemovePmi()with individual dimensions instead.License requirements: None.
RigidSetConstraintOption¶
-
SessionSketch.RigidSetConstraintOption¶ Returns or sets the rigid set external constraint management option
-------------------------------------Getter Method
Signature
RigidSetConstraintOptionReturns: Return type: NXOpen.Preferences.SessionSketchRigidSetConstraintTypeNew in version NX9.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.Preferences.SessionSketch.GroupConstraintOption()instead.License requirements: None.
-------------------------------------Setter Method
Signature
RigidSetConstraintOptionParameters: constraintType ( NXOpen.Preferences.SessionSketchRigidSetConstraintType) –New in version NX9.0.0.
Deprecated since version NX11.0.0: Use
NXOpen.Preferences.SessionSketch.GroupConstraintOption()instead.License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
ScaleOnFirstDrivingDimension¶
-
SessionSketch.ScaleOnFirstDrivingDimension¶ Returns or sets the setting that controls whether or not the entire active sketch is scaled about the sketch origin when the first non-angular driving dimension is applied.
-------------------------------------Getter Method
Signature
ScaleOnFirstDrivingDimensionReturns: Return type: bool New in version NX11.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScaleOnFirstDrivingDimensionParameters: scaleOnFirstDrivingDimension (bool) – New in version NX11.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
SnapAngle¶
-
SessionSketch.SnapAngle¶ Returns or 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
-------------------------------------Getter Method
Signature
SnapAngleReturns: Return type: float New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SnapAngleParameters: snapAngle (float) – New in version NX3.0.0.
License requirements: None.
SolvingTolerance¶
-
SessionSketch.SolvingTolerance¶ Returns or sets the sketch solving tolerance.
This specifies the maximum allowable distance when solving the sketch constraints. The tolerance value must be greater than 1e-08.
-------------------------------------Getter Method
Signature
SolvingToleranceReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SolvingToleranceParameters: tolerance (float) – New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)
TextSizeFixed¶
-
SessionSketch.TextSizeFixed¶ Returns or sets the setting that controls whether or not dimension text size is fixed.
If it is True, text size adjusts opposite of zoom scale so that dimensions appear a constant size.
-------------------------------------Getter Method
Signature
TextSizeFixedReturns: Return type: bool New in version NX4.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TextSizeFixedParameters: textSizeFixed (bool) – New in version NX4.0.0.
License requirements: None.
UpdateSketchOnly¶
-
SessionSketch.UpdateSketchOnly¶ Returns or sets the setting that controls whether or not to update only the sketch while sketching using Direct Sketch.
When this preference is set to false, an update will propagate through the whole model
-------------------------------------Getter Method
Signature
UpdateSketchOnlyReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UpdateSketchOnlyParameters: delayModelUpdate (bool) – New in version NX8.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”)
UseSolvingTolerance¶
-
SessionSketch.UseSolvingTolerance¶ Returns or sets the setting that controls whether or not to use user input for sketch solving tolerance.
-------------------------------------Getter Method
Signature
UseSolvingToleranceReturns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseSolvingToleranceParameters: useTolerance (bool) – New in version NX8.5.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)