SessionSketch Class

class NXOpen.Preferences.SessionSketch

Bases: object

Represents the set of sketch preferences applicable to entire session

To obtain an instance of this class, refer to NXOpen.Preferences.SessionPreferences

New in version NX3.0.0.

Properties

Property	Description
AutoDimensionsToArcCenter	Returns or sets the flag of auto-dimensions to arc centre.
BackgroundOption	Returns or sets the background option
ChangeViewOrientation	Returns or sets the change view orientation flag.
ConstraintSymbolSize	Returns or sets the constraint symbol size.
ContinuousAutoDimensioning	Returns or sets the continuous auto dimensioning state in sketch preferences.
CreateInferredConstraints	Returns or sets the 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 delay evaluation preference.
DimensionLabel	Returns or sets the dimension label
DisplayAutoDimensions	Returns or sets the display auto dimensions preference
DisplayConstraintSymbols	Returns or sets the display constraint symbols preference
DisplayDOFArrows	Returns or sets the displays DOF arrows flag.
DisplayObjectColor	Returns or sets the display object color
DisplayObjectName	Returns or sets the display object name
DisplaySectionMappingWarning	Returns or sets the display section mapping warning flag.
DisplayVertices	Returns or sets the display sketch vertices toggle
DynamicConstraintDisplay	Returns or sets the dynamic constraints display flag.
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 maintain blank status flag.
MaintainLayerStatus	Returns or sets the maintain layer status flag.
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 scale on first driving dimension option
SnapAngle	Returns or sets the snap angle.
SolvingTolerance	Returns or sets the sketch solving tolerance.
TextSizeFixed	Returns or sets the text size fixed flag.
UpdateSketchOnly	Returns or sets the update sketch only preference.
UseSolvingTolerance	Returns or sets the sketch solving tolerance flag.

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

-------------------------------------

Getter Method

Signature AutoDimensionsToArcCenter()

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AutoDimensionsToArcCenter(toArcCenter)

Parameters: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 BackgroundOption()

Returns: Return type:NXOpen.Preferences.SessionSketchBackgroundType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BackgroundOption(backgroundType)

Parameters:backgroundType (NXOpen.Preferences.SessionSketchBackgroundType) –

New in version NX5.0.0.

License requirements: None.

ChangeViewOrientation

SessionSketch.ChangeViewOrientation

Returns or sets the change view orientation flag.

If true, when a sketch is activated, the view will be changed to align with the sketch

-------------------------------------

Getter Method

Signature ChangeViewOrientation()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ChangeViewOrientation(changeViewOrientation)

Parameters:changeViewOrientation (bool) –

New in version NX3.0.0.

License requirements: None.

ConstraintSymbolSize

SessionSketch.ConstraintSymbolSize

Returns or sets the constraint symbol size.

-------------------------------------

Getter Method

Signature ConstraintSymbolSize()

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ConstraintSymbolSize(constraintSymbolSize)

Parameters:constraintSymbolSize (float) –

New in version NX8.5.0.

License requirements: None.

ContinuousAutoDimensioning

SessionSketch.ContinuousAutoDimensioning

Returns or sets the continuous auto dimensioning state in sketch preferences.

Newly created sketch gets continuous auto dimensioning state from sketch preference.

-------------------------------------

Getter Method

Signature ContinuousAutoDimensioning()

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ContinuousAutoDimensioning(continAutoDim)

Parameters: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 create inferred constraints

-------------------------------------

Getter Method

Signature CreateInferredConstraints()

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateInferredConstraints(createInferredConstraints)

Parameters: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 DefaultArcNamePrefix()

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultArcNamePrefix(defaultArcNamePrefix)

Parameters: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 DefaultConicNamePrefix()

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultConicNamePrefix(defaultConicNamePrefix)

Parameters: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 DefaultLineNamePrefix()

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultLineNamePrefix(defaultLineNamePrefix)

Parameters: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 DefaultSketchNamePrefix()

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultSketchNamePrefix(defaultSketchNamePrefix)

Parameters: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 DefaultSplineNamePrefix()

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultSplineNamePrefix(defaultSplineNamePrefix)

Parameters: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 DefaultVertexNamePrefix()

Returns: Return type:str

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DefaultVertexNamePrefix(defaultVertexNamePrefix)

Parameters:defaultVertexNamePrefix (str) –

New in version NX3.0.0.

License requirements: None.

DelayEvaluation

SessionSketch.DelayEvaluation

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

-------------------------------------

Getter Method

Signature DelayEvaluation()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DelayEvaluation(delayEvaluation)

Parameters: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 DimensionLabel()

Returns: Return type:NXOpen.Preferences.SketchPreferencesDimensionLabelType

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DimensionLabel(dimensionLabel)

Parameters:dimensionLabel (NXOpen.Preferences.SketchPreferencesDimensionLabelType) –

New in version NX3.0.0.

License requirements: None.

DisplayAutoDimensions

SessionSketch.DisplayAutoDimensions

Returns or sets the display auto dimensions preference

-------------------------------------

Getter Method

Signature DisplayAutoDimensions()

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayAutoDimensions(displayAutoDimensions)

Parameters: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 display constraint symbols preference

-------------------------------------

Getter Method

Signature DisplayConstraintSymbols()

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayConstraintSymbols(displayConstraintSymbols)

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

-------------------------------------

Getter Method

Signature DisplayDOFArrows()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayDOFArrows(displayDOFArrows)

Parameters:displayDOFArrows (bool) –

New in version NX3.0.0.

License requirements: None.

DisplayObjectColor

SessionSketch.DisplayObjectColor

Returns or sets the display object color

-------------------------------------

Getter Method

Signature DisplayObjectColor()

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayObjectColor(displayObjColor)

Parameters: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 display object name

-------------------------------------

Getter Method

Signature DisplayObjectName()

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayObjectName(displayObjectName)

Parameters:displayObjectName (bool) –

New in version NX9.0.0.

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 DisplaySectionMappingWarning()

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplaySectionMappingWarning(displaySectionMappingWarning)

Parameters:displaySectionMappingWarning (bool) –

New in version NX7.5.0.

License requirements: None.

DisplayVertices

SessionSketch.DisplayVertices

Returns or sets the display sketch vertices toggle

-------------------------------------

Getter Method

Signature DisplayVertices()

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DisplayVertices(displayVertices)

Parameters: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 dynamic constraints display flag.

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

-------------------------------------

Getter Method

Signature DynamicConstraintDisplay()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DynamicConstraintDisplay(dynamicConstraintDisplay)

Parameters: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 FixedTextSize()

Returns: Return type:float

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FixedTextSize(fixedTextSize)

Parameters: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 GroupConstraintOption()

Returns: Return type:NXOpen.Preferences.SessionSketchGroupConstraintType

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GroupConstraintOption(constraintType)

Parameters: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 maintain blank status flag.

If true, when a sketch is activated, previously blanked objects will not be visible

-------------------------------------

Getter Method

Signature MaintainBlankStatus()

Returns: Return type:bool

New in version NX6.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MaintainBlankStatus(keepBlank)

Parameters:keepBlank (bool) –

New in version NX6.0.0.

License requirements: None.

MaintainLayerStatus

SessionSketch.MaintainLayerStatus

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

-------------------------------------

Getter Method

Signature MaintainLayerStatus()

Returns: Return type:bool

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MaintainLayerStatus(maintainLayerStatus)

Parameters:maintainLayerStatus (bool) –

New in version NX3.0.0.

License requirements: None.

OriginOption

SessionSketch.OriginOption

Returns or sets the origin option

-------------------------------------

Getter Method

Signature OriginOption()

Returns: Return type:NXOpen.Preferences.SessionSketchOriginType

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use SketchInPlaceBuilder.ProjectWorkPartOrigin() and SketchInPlaceBuilder.MakeOriginAssociative() and SketchInPlaceBuilder.SketchOrigin() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature OriginOption(originType)

Parameters:originType (NXOpen.Preferences.SessionSketchOriginType) –

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use SketchInPlaceBuilder.ProjectWorkPartOrigin() and SketchInPlaceBuilder.MakeOriginAssociative() and SketchInPlaceBuilder.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 RetainDimensions()

Returns: Return type:bool

New in version NX3.0.0.

Deprecated since version NX8.0.1: Use Annotations.AnnotationManager.MakePmi() and Annotations.AnnotationManager.RemovePmi() with individual dimensions instead.

License requirements: None.

-------------------------------------

Setter Method

Signature RetainDimensions(retainDimensions)

Parameters:retainDimensions (bool) –

New in version NX3.0.0.

Deprecated since version NX8.0.1: Use Annotations.AnnotationManager.MakePmi() and Annotations.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 RigidSetConstraintOption()

Returns: Return type:NXOpen.Preferences.SessionSketchRigidSetConstraintType

New in version NX9.0.0.

Deprecated since version NX11.0.0: Use NXOpen.Preferences.SessionSketch.GroupConstraintOption() instead.

License requirements: None.

-------------------------------------

Setter Method

Signature RigidSetConstraintOption(constraintType)

Parameters: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 scale on first driving dimension option

-------------------------------------

Getter Method

Signature ScaleOnFirstDrivingDimension()

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ScaleOnFirstDrivingDimension(scaleOnFirstDrivingDimension)

Parameters: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 SnapAngle()

Returns: Return type:float

New in version NX3.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SnapAngle(snapAngle)

Parameters: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 SolvingTolerance()

Returns: Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature SolvingTolerance(tolerance)

Parameters: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 text size fixed flag.

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

-------------------------------------

Getter Method

Signature TextSizeFixed()

Returns: Return type:bool

New in version NX4.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TextSizeFixed(textSizeFixed)

Parameters:textSizeFixed (bool) –

New in version NX4.0.0.

License requirements: None.

UpdateSketchOnly

SessionSketch.UpdateSketchOnly

Returns or 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

-------------------------------------

Getter Method

Signature UpdateSketchOnly()

Returns: Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UpdateSketchOnly(delayModelUpdate)

Parameters:delayModelUpdate (bool) –

New in version NX8.0.0.

License requirements: solid_modeling (“SOLIDS MODELING”)

UseSolvingTolerance

SessionSketch.UseSolvingTolerance

Returns or sets the sketch solving tolerance flag.

Controls whether to use user input for sketch tolerance

-------------------------------------

Getter Method

Signature UseSolvingTolerance()

Returns: Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseSolvingTolerance(useTolerance)

Parameters:useTolerance (bool) –

New in version NX8.5.0.

License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR geometric_tol (“GDT”)