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

Represents the set of Modeling 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  BodyTypeOption { BodyTypeOptionSolid, BodyTypeOptionSheet }
 Describes whether the body type is solid or sheet. More...
enum  BooleanFacePropertiesInheritance { BooleanFacePropertiesInheritanceTargetBody, BooleanFacePropertiesInheritanceToolBody }
 Describes whether the display of Boolean Face properties inherits from target body or tool body. More...
enum  CurveFitMethodType { CurveFitMethodTypeCubic, CurveFitMethodTypeQuintic, CurveFitMethodTypeAdvanced }
 Describes whether the Curve Fit Method type is selected as cubic or quintic or advanced. More...
enum  DynamicUpdateType { DynamicUpdateTypeNone, DynamicUpdateTypeIncremental, DynamicUpdateTypeContinuous }
 Describes whether the Dynamic Update type is not selected or selected as incremental or continuous. More...
enum  FreeFormConstructionResultType { FreeFormConstructionResultTypePlane, FreeFormConstructionResultTypeBSurface }
 Describes whether the Free Form Construction Result is plane or B Surface. More...
enum  ImmediateChildrenType { ImmediateChildrenTypeFirstLevel, ImmediateChildrenTypeAll }
 Describes whether the Immediate Children type is selected for first level or for all. More...
enum  LinkedAndExtractedGeometryPropertiesInheritance { LinkedAndExtractedGeometryPropertiesInheritanceParentObject, LinkedAndExtractedGeometryPropertiesInheritancePartDefault }
 Describes whether the display of linked and extracted geometry properties inherits from parent object or part default. More...
enum  NewFacePropertiesInheritance { NewFacePropertiesInheritanceBody, NewFacePropertiesInheritancePartDefault }
 Describes whether the display of New Face properties inherits from body or part default. More...
enum  PoleDisplayStyleType {
  PoleDisplayStyleTypeNone, PoleDisplayStyleTypeOpenCircle, PoleDisplayStyleTypeFilledCircle, PoleDisplayStyleTypePlusSign,
  PoleDisplayStyleTypeCross
}
 Styles for display poles of B curves and B surfaces. More...
enum  PoleEditStyleType {
  PoleEditStyleTypeSphere3d, PoleEditStyleTypeOpenCircle, PoleEditStyleTypeFilledCircle, PoleEditStyleTypePlusSign,
  PoleEditStyleTypeCross
}
 Styles for edit poles of B curves and B surfaces. More...
enum  PolylineStyleType {
  PolylineStyleTypeSolid = 1, PolylineStyleTypeDashed, PolylineStyleTypePhantom, PolylineStyleTypeCenterline,
  PolylineStyleTypeDotted, PolylineStyleTypeLongdashed, PolylineStyleTypeDotteddashed
}
 Styles for polylines of B curves and B surfaces. More...
enum  PreviewResolutionType {
  PreviewResolutionTypeNone, PreviewResolutionTypeCoarse, PreviewResolutionTypeStandard, PreviewResolutionTypeFine,
  PreviewResolutionTypeExtraFine, PreviewResolutionTypeSuperFine, PreviewResolutionTypeUltraFine
}
 Freeform preview resolutions. More...
enum  SketchDefaultActionType { SketchDefaultActionTypeEditWithRollback, SketchDefaultActionTypeEdit }
 Double click action for sketches. More...
enum  SketchEditType { SketchEditTypeInTaskEnvironment, SketchEditTypeDirect }
 Edit option for sketches. More...
enum  SplineDefaultActionTypes { SplineDefaultActionTypesStudioSpline, SplineDefaultActionTypesXform }
 Specifies the command that should be invoked when double-clicking on a spline. More...

Public Member Functions

int AccelerationColor ()
 Returns the acceleration color
Created in NX3.0.0.
bool AllowEditingOfDimensionOfInternalSketch ()
 Returns the option "allow_editing_of_dimension_of_internal_sketch" gives choice, whether or not the sketch dimensions will display and be possible to select and edit directly, without entering the Sketch task environment when a dialog (e.g.
bool AssociativeEditFreeForm ()
 Returns the associative edit free form option.
int BCurvePoleCurveColor ()
 Returns the B curve pole curve color.
NXOpen::Preferences::SessionModeling::BodyTypeOption BodyType ()
 Returns the body type.
NXOpen::Preferences::SessionModeling::BooleanFacePropertiesInheritance BooleanFaceProperties ()
 Returns the boolean face properties inheritance.
int BSurfacePoleFaceColor ()
 Returns the B surface pole face color.
int CurvatureColor ()
 Returns the curvature color
Created in NX3.0.0.
NXOpen::Preferences::SessionModeling::CurveFitMethodType CurveFitMethod ()
 Returns the curve fit method.
bool DisplayLegacyFeatureName ()
 Returns the toggle "Display Legacy Feature names" gives choice, how user wants feature name in "Name" Coulmn in Partnav checked toggled(True) will show old feature names in "Name" column in Partnav, while unchecked toggled(False) will show new translatable feature names in "Name" column in Partnav
Created in NX4.0.0.
NXOpen::Preferences::SessionModeling::DynamicUpdateType DynamicUpdate ()
 Returns the dynamic update.
bool EditWithRollbackUponDoubleClick ()
 Returns the option "Edit with Rollback upon Double-Click" gives choice of what action to be taken on feature upon Double clicking, either in partnavigator or in Graphics widow.
bool EnableTrimmedAnimation ()
 Returns the enable trimmed animation setting.
bool FeatureAlerts ()
 Returns the option "Feature Alerts" gives choice, whether the user wants the Diagnostic error and information prompts appear when features contain errors and/or information during feature creation, edit, and update.
NXOpen::Preferences::SessionModeling::FreeFormConstructionResultType FreeFormConstructionResult ()
 Returns the free form construction result.
NXOpen::Preferences::SessionModeling::ImmediateChildrenType ImmediateChildren ()
 Returns the immediate children.
bool InterruptUpdateOnError ()
 Returns the option "Interrupt Update on Error" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain errors during feature update/playback.
bool InterruptUpdateOnMissingReferences ()
 Returns the option "Interrupt Update on Missing References" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain missing references during feature update/playback.
bool InterruptUpdateOnWarning ()
 Returns the option "Interrupt Update on Warning" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain warnings during feature update/playback.
NXOpen::Preferences::SessionModeling::LinkedAndExtractedGeometryPropertiesInheritance LinkedAndExtractedGeometryProperties ()
 Returns the linked and extracted geometry properties inheritance.
bool MakeCurrentOnError ()
 Returns the option "Make Current on Error" gives choice, whether the user wants to make error feature current when features contain errors during feature update/playback.
bool MakeDatumsInternal ()
 Returns the option specifying whether to automatically make the datums internal during the sketch creation.
bool MakeSketchesInternal ()
 Returns the option specifying whether to automatically make sketch internal during feature creation.
NXOpen::Preferences::SessionModeling::NewFacePropertiesInheritance NewFaceProperties ()
 Returns the new face properties inheritance.
bool NotifyOnDelete ()
 Returns the option " Notify on Delete " gives choice, whether the user wants a notification message when a feature is being deleted will effect other features.
int PmarkFrequency ()
 Returns the features/mark.
int PoleDisplayColor ()
 Returns the color for display poles for B curves.
bool PoleDisplayInheritColor ()
 Returns the pole color inherit option, for display with B curves.
NXOpen::Preferences::SessionModeling::PoleDisplayStyleType PoleDisplayStyle ()
 Returns the style (3D ball, 2D disk, mark, etc.) of the poles for display of B curves.
int PoleEditColor ()
 Returns the color for editing poles for B curves and B surfaces.
bool PoleEditInheritColor ()
 Returns the pole color inherit option, for editing B curves and B surfaces.
NXOpen::Preferences::SessionModeling::PoleEditStyleType PoleEditStyle ()
 Returns the style (3D ball, 2D disk, mark, etc.) of the poles for editing B curves and B surfaces.
int PolylineDisplayColor ()
 Returns the color for display polylines for B curves and B surfaces
Created in NX7.5.0.
bool PolylineDisplayInheritColor ()
 Returns the polyline color inherit option, for display with B curves and B surfaces.
NXOpen::Preferences::SessionModeling::PolylineStyleType PolylineDisplayStyle ()
 Returns the style (solid, dashed, etc.) of the polylines display for B curves and B surfaces.
int PolylineEditColor ()
 Returns the color for editing polylines for B curves and B surfaces.
bool PolylineEditInheritColor ()
 Returns the polyline color inherit option, for editing B curves and B surfaces.
NXOpen::Preferences::SessionModeling::PolylineStyleType PolylineEditStyle ()
 Returns the style (solid, dashed, etc.) of the polylines for editing B curves and B surfaces.
int PositionColor ()
 Returns the position color
Created in NX3.0.0.
NXOpen::Preferences::SessionModeling::PreviewResolutionType PreviewResolution ()
 Returns the preview resolution setting.
bool SaveRollbackData ()
 Returns the option " Save Rollback Data " saves extra data with the part file for faster edits.
void SetAccelerationColor (int accelerationColor)
 Sets the acceleration color
Created in NX3.0.0.
void SetAllowEditingOfDimensionOfInternalSketch (bool allowEditingOfDimensionOfInternalSketch)
 Sets the option "allow_editing_of_dimension_of_internal_sketch" gives choice, whether or not the sketch dimensions will display and be possible to select and edit directly, without entering the Sketch task environment when a dialog (e.g.
void SetAssociativeEditFreeForm (bool associativeEditFreeForm)
 Sets the associative edit free form option.
void SetBCurvePoleCurveColor (int bCurvePoleColor)
 Sets the B curve pole curve color.
void SetBodyType (NXOpen::Preferences::SessionModeling::BodyTypeOption bodyType)
 Sets the body type.
void SetBooleanFaceProperties (NXOpen::Preferences::SessionModeling::BooleanFacePropertiesInheritance booleanFaceProperties)
 Sets the boolean face properties inheritance.
void SetBSurfacePoleFaceColor (int bSurfacePoleFaceColor)
 Sets the B surface pole face color.
void SetCurvatureColor (int curvatureColor)
 Sets the curvature color
Created in NX3.0.0.
void SetCurveFitMethod (NXOpen::Preferences::SessionModeling::CurveFitMethodType bodyType)
 Sets the curve fit method.
void SetDisplayLegacyFeatureName (bool displayLegacyFeatureName)
 Sets the toggle "Display Legacy Feature names" gives choice, how user wants feature name in "Name" Coulmn in Partnav checked toggled(True) will show old feature names in "Name" column in Partnav, while unchecked toggled(False) will show new translatable feature names in "Name" column in Partnav
Created in NX4.0.0.
void SetDynamicUpdate (NXOpen::Preferences::SessionModeling::DynamicUpdateType dynamicUpdate)
 Sets the dynamic update.
void SetEditWithRollbackUponDoubleClick (bool defaultEditOption)
 Sets the option "Edit with Rollback upon Double-Click" gives choice of what action to be taken on feature upon Double clicking, either in partnavigator or in Graphics widow.
void SetEnableTrimmedAnimation (bool enable)
 Sets the enable trimmed animation setting.
void SetFeatureAlerts (bool featureAlerts)
 Sets the option "Feature Alerts" gives choice, whether the user wants the Diagnostic error and information prompts appear when features contain errors and/or information during feature creation, edit, and update.
void SetFreeFormConstructionResult (NXOpen::Preferences::SessionModeling::FreeFormConstructionResultType freeFormConstrResult)
 Sets the free form construction result.
void SetImmediateChildren (NXOpen::Preferences::SessionModeling::ImmediateChildrenType immediateChildren)
 Sets the immediate children.
void SetInterruptUpdateOnError (bool interruptOnError)
 Sets the option "Interrupt Update on Error" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain errors during feature update/playback.
void SetInterruptUpdateOnMissingReferences (bool interruptOnMissingReferences)
 Sets the option "Interrupt Update on Missing References" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain missing references during feature update/playback.
void SetInterruptUpdateOnWarning (bool interruptOnWarning)
 Sets the option "Interrupt Update on Warning" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain warnings during feature update/playback.
void SetLinkedAndExtractedGeometryProperties (NXOpen::Preferences::SessionModeling::LinkedAndExtractedGeometryPropertiesInheritance linkedAndExtractedGeometryProperties)
 Sets the linked and extracted geometry properties inheritance.
void SetMakeCurrentOnError (bool currentOnError)
 Sets the option "Make Current on Error" gives choice, whether the user wants to make error feature current when features contain errors during feature update/playback.
void SetMakeDatumsInternal (bool makeDatumsInternal)
 Sets the option specifying whether to automatically make the datums internal during the sketch creation.
void SetMakeSketchesInternal (bool makeSketchesInternal)
 Sets the option specifying whether to automatically make sketch internal during feature creation.
void SetNewFaceProperties (NXOpen::Preferences::SessionModeling::NewFacePropertiesInheritance newFaceProperties)
 Sets the new face properties inheritance.
void SetNotifyOnDelete (bool notifyOnDelete)
 Sets the option " Notify on Delete " gives choice, whether the user wants a notification message when a feature is being deleted will effect other features.
void SetPmarkFrequency (int pmarkFrequency)
 Sets the features/mark.
void SetPoleDisplayColor (int poleDisplayColor)
 Sets the color for display poles for B curves.
void SetPoleDisplayInheritColor (bool poleDisplayInheritColor)
 Sets the pole color inherit option, for display with B curves.
void SetPoleDisplayStyle (NXOpen::Preferences::SessionModeling::PoleDisplayStyleType poleDisplayStyle)
 Sets the style (3D ball, 2D disk, mark, etc.) of the poles for display of B curves.
void SetPoleEditColor (int poleEditColor)
 Sets the color for editing poles for B curves and B surfaces.
void SetPoleEditInheritColor (bool poleEditInheritColor)
 Sets the pole color inherit option, for editing B curves and B surfaces.
void SetPoleEditStyle (NXOpen::Preferences::SessionModeling::PoleEditStyleType poleEditStyle)
 Sets the style (3D ball, 2D disk, mark, etc.) of the poles for editing B curves and B surfaces.
void SetPolylineDisplayColor (int polylineDisplayColor)
 Sets the color for display polylines for B curves and B surfaces
Created in NX7.5.0.
void SetPolylineDisplayInheritColor (bool polylineDisplayInheritColor)
 Sets the polyline color inherit option, for display with B curves and B surfaces.
void SetPolylineDisplayStyle (NXOpen::Preferences::SessionModeling::PolylineStyleType polylineDisplayStyle)
 Sets the style (solid, dashed, etc.) of the polylines display for B curves and B surfaces.
void SetPolylineEditColor (int polylineEditColor)
 Sets the color for editing polylines for B curves and B surfaces.
void SetPolylineEditInheritColor (bool polylineEditInheritColor)
 Sets the polyline color inherit option, for editing B curves and B surfaces.
void SetPolylineEditStyle (NXOpen::Preferences::SessionModeling::PolylineStyleType polylineEditStyle)
 Sets the style (solid, dashed, etc.) of the polylines for editing B curves and B surfaces.
void SetPositionColor (int positionColor)
 Sets the position color
Created in NX3.0.0.
void SetPreviewResolution (NXOpen::Preferences::SessionModeling::PreviewResolutionType resolution)
 Sets the preview resolution setting.
void SetSaveRollbackData (bool retainRollbackData)
 Sets the option " Save Rollback Data " saves extra data with the part file for faster edits.
void SetShowSimuationUiInModeling (bool showSimuationUiInModeling)
 Sets the option to specify whether simulation specific UI should show up in modeling
Created in NX7.5.0.
void SetSketchDefaultAction (NXOpen::Preferences::SessionModeling::SketchDefaultActionType sketchAction)
 Sets the sketch default action
Created in NX7.5.0.
void SetSketchEditOption (NXOpen::Preferences::SessionModeling::SketchEditType sketchEditOption)
 Sets the option that determines whether or not task environment is used to edit the sketch
Created in NX7.5.0.
void SetSplineDefaultActionType (NXOpen::Preferences::SessionModeling::SplineDefaultActionTypes action)
 Sets the value indicating the default action for a spline.
void SetTangentColor (int tangentColor)
 Sets the tangent color
Created in NX3.0.0.
void SetUpdateDelayed (bool option)
 Sets the update delayed option.
void SetUpdateFailureReportPreference (bool updateFailureReport)
 Sets the option "Update Failure Report" gives choice, whether the user wants the update failure report to be generated for the features that failed during current update cycle.
void SetUseCurveColor (bool useCurveColor)
 Sets the curve color option for B Curve.
void SetUseFaceColor (bool useFaceColor)
 Sets the face color option for B Surface.
void SetUseTriangularMesh (bool use)
 Sets the use triangular mesh setting setting.
bool ShowSimuationUiInModeling ()
 Returns the option to specify whether simulation specific UI should show up in modeling
Created in NX7.5.0.
NXOpen::Preferences::SessionModeling::SketchDefaultActionType SketchDefaultAction ()
 Returns the sketch default action
Created in NX7.5.0.
NXOpen::Preferences::SessionModeling::SketchEditType SketchEditOption ()
 Returns the option that determines whether or not task environment is used to edit the sketch
Created in NX7.5.0.
NXOpen::Preferences::SessionModeling::SplineDefaultActionTypes SplineDefaultActionType ()
 Returns the value indicating the default action for a spline.
tag_t Tag () const
 Returns the tag of this object.
int TangentColor ()
 Returns the tangent color
Created in NX3.0.0.
bool UpdateDelayed ()
 Returns the update delayed option.
bool UpdateFailureReportPreference ()
 Returns the option "Update Failure Report" gives choice, whether the user wants the update failure report to be generated for the features that failed during current update cycle.
bool UseCurveColor ()
 Returns the curve color option for B Curve.
bool UseFaceColor ()
 Returns the face color option for B Surface.
bool UseTriangularMesh ()
 Returns the use triangular mesh setting setting.

Detailed Description

Represents the set of Modeling 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 whether the body type is solid or sheet.

Enumerator:
BodyTypeOptionSolid 

Indicates Body Type is solid.

BodyTypeOptionSheet 

Indicates Body Type is solid.

Describes whether the display of Boolean Face properties inherits from target body or tool body.

Enumerator:
BooleanFacePropertiesInheritanceTargetBody 

Indicates that display of boolean face properties inherits from target body.

BooleanFacePropertiesInheritanceToolBody 

Indicates that display of boolean face properties inherits from tool body.

Describes whether the Curve Fit Method type is selected as cubic or quintic or advanced.

Enumerator:
CurveFitMethodTypeCubic 

Indicates the Curve Fit Method type is cubic.

CurveFitMethodTypeQuintic 

Indicates the Curve Fit Method type is quintic.

CurveFitMethodTypeAdvanced 

Indicates the Curve Fit Method type is advanced.

Describes whether the Dynamic Update type is not selected or selected as incremental or continuous.

Enumerator:
DynamicUpdateTypeNone 

Indicates that Dynamic Update type is not selected.

DynamicUpdateTypeIncremental 

Indicates that Dynamic Update type is incremental.

DynamicUpdateTypeContinuous 

Indicates that Dynamic Update type is continuous.

Describes whether the Free Form Construction Result is plane or B Surface.

Enumerator:
FreeFormConstructionResultTypePlane 

Indicates the construction result option is plane.

FreeFormConstructionResultTypeBSurface 

Indicates the construction result option is B Surface.

Describes whether the Immediate Children type is selected for first level or for all.

Enumerator:
ImmediateChildrenTypeFirstLevel 

Indicates that Immediate Children type is at first level.

ImmediateChildrenTypeAll 

Indicates that Immediate Children type is at all level.

Describes whether the display of linked and extracted geometry properties inherits from parent object or part default.

Enumerator:
LinkedAndExtractedGeometryPropertiesInheritanceParentObject 

Indicates that display of linked and extracted geometry properties inherits from parent object.

LinkedAndExtractedGeometryPropertiesInheritancePartDefault 

Indicates that display of linked and extracted geometry properties inherits from part default.

Describes whether the display of New Face properties inherits from body or part default.

Enumerator:
NewFacePropertiesInheritanceBody 

Indicates that display of new face properties inherits from body.

NewFacePropertiesInheritancePartDefault 

Indicates that display of new face properties inherits from part default.

Styles for display poles of B curves and B surfaces.

Enumerator:
PoleDisplayStyleTypeNone 

none

PoleDisplayStyleTypeOpenCircle 

open circle

PoleDisplayStyleTypeFilledCircle 

filled circle

PoleDisplayStyleTypePlusSign 

plus sign

PoleDisplayStyleTypeCross 

cross

Styles for edit poles of B curves and B surfaces.

Enumerator:
PoleEditStyleTypeSphere3d 

sphere3d

PoleEditStyleTypeOpenCircle 

open circle

PoleEditStyleTypeFilledCircle 

filled circle

PoleEditStyleTypePlusSign 

plus sign

PoleEditStyleTypeCross 

cross

Styles for polylines of B curves and B surfaces.

Enumerator:
PolylineStyleTypeDashed 

dashed

PolylineStyleTypePhantom 

phantom

PolylineStyleTypeCenterline 

centerline

PolylineStyleTypeDotted 

dotted

PolylineStyleTypeLongdashed 

longdashed

PolylineStyleTypeDotteddashed 

dotteddashed

Freeform preview resolutions.

Enumerator:
PreviewResolutionTypeNone 

none

PreviewResolutionTypeCoarse 

coarse

PreviewResolutionTypeStandard 

standard

PreviewResolutionTypeFine 

fine

PreviewResolutionTypeExtraFine 

extra fine

PreviewResolutionTypeSuperFine 

super fine

PreviewResolutionTypeUltraFine 

ultra fine

Double click action for sketches.

Enumerator:
SketchDefaultActionTypeEditWithRollback 

Edit sketch with rollback on double click.

SketchDefaultActionTypeEdit 

Edit sketch without rollback on double click.

Edit option for sketches.

Enumerator:
SketchEditTypeInTaskEnvironment 

Edit sketch in task environment.

SketchEditTypeDirect 

Edit sketch without entering task environment.

Specifies the command that should be invoked when double-clicking on a spline.

The option applies to non-associative splines and Studio Spline features in the Shape Studio application only.
Created in NX7.0.0.

Enumerator:
SplineDefaultActionTypesStudioSpline 

Specifies Studio Spline for editing a spline.

SplineDefaultActionTypesXform 

Specifies X-form for editing a spline.


Member Function Documentation

Returns the acceleration color
Created in NX3.0.0.



License requirements : None

Returns the option "allow_editing_of_dimension_of_internal_sketch" gives choice, whether or not the sketch dimensions will display and be possible to select and edit directly, without entering the Sketch task environment when a dialog (e.g.

Extrude, Revolve, Hole etc.) is active which allows editing on an internal sketch.
Created in NX7.5.0.

License requirements : None

Returns the associative edit free form option.

Specify whether the output of editing certain free form features remain as free form features or as unparameterized features.
Created in NX3.0.0.

License requirements : None

Returns the B curve pole curve color.

This is color of the pole control polygons for B-curves .

This property is deprecated. Use Preferences.SessionModeling.PoleDisplayColor or Preferences.SessionModeling.PoleEditColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Returns the body type.

Toggles between Solid and Sheet. When creating bodies through curves, the Body Type option provides control to the type of body (for example, solid body vs. sheet body) that is created.
Created in NX3.0.0.

License requirements : None

Returns the boolean face properties inheritance.

Specifies whether the boolean face properties inherit from target body or tool body
Created in NX3.0.0.

License requirements : None

Returns the B surface pole face color.

This is color of the pole control polygons for B-surface .

This property is deprecated. Use Preferences.SessionModeling.PoleDisplayColor or Preferences.SessionModeling.PoleEditColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Returns the curvature color
Created in NX3.0.0.



License requirements : None

Returns the curve fit method.

Controls the fitting method used when curves must be approximated by splines.
Created in NX3.0.0.

License requirements : None

Returns the toggle "Display Legacy Feature names" gives choice, how user wants feature name in "Name" Coulmn in Partnav checked toggled(True) will show old feature names in "Name" column in Partnav, while unchecked toggled(False) will show new translatable feature names in "Name" column in Partnav
Created in NX4.0.0.



License requirements : None

Returns the dynamic update.

Specifies that the system dynamically displays in real time with each updation of parent curves, splines, bridge curves, lines or arcs
Created in NX3.0.0.

License requirements : None

Returns the option "Edit with Rollback upon Double-Click" gives choice of what action to be taken on feature upon Double clicking, either in partnavigator or in Graphics widow.

if the option is true then edit with rollback will be happen upon Double-click. if the option is false then the previous default action will be executed
Created in NX4.0.0.

License requirements : None

Returns the enable trimmed animation setting.


Created in NX4.0.0.

License requirements : None

Returns the option "Feature Alerts" gives choice, whether the user wants the Diagnostic error and information prompts appear when features contain errors and/or information during feature creation, edit, and update.

if the option is true then the diagnostic prompts will appear. if the option is false then prompts will not appear.

This property is deprecated. Use Preferences.SessionUserInterfaceUI.DisplayAlertsOnWarnings, Preferences.SessionUserInterfaceUI.DisplayAlertsOnInformation instead. Alerts are always displayed for errors. Display of alerts on warnings/information can be changed by above mentioned properties. Use of deprecated method FeatureAlerts will always return true as the error alerts are always displayed. If SetFeatureAlerts has no effect on error, warning or information alerts. Use Preferences.SessionUserInterfaceUI.DisplayAlertsOnWarnings, Preferences.SessionUserInterfaceUI.DisplayAlertsOnInformation instead to control the display of warning/information alerts.

Deprecated:
Deprecated in NX7.5.0.


Created in NX5.0.0.

License requirements : None

Returns the free form construction result.

Controls free form feature creation when using the Through Curves, Through Curve Mesh, Swept, and Ruled options.
Created in NX3.0.0.

License requirements : None

Returns the immediate children.

Specifies to which level the dynamic updation is applicable.
Created in NX3.0.0.

License requirements : None

Returns the option "Interrupt Update on Error" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain errors during feature update/playback.

if the option is true then the dialog will appear. if the option is false then dialog will not appear during feature update.
Created in NX5.0.0.

License requirements : None

Returns the option "Interrupt Update on Missing References" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain missing references during feature update/playback.

if the option is true then the dialog will appear. if the option is false then dialog will not appear during feature update.
Created in NX7.5.0.

License requirements : None

Returns the option "Interrupt Update on Warning" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain warnings during feature update/playback.

if the option is true then the dialog will appear. if the option is false then dialog will not appear during feature update.
Created in NX5.0.0.

License requirements : None

Returns the linked and extracted geometry properties inheritance.

Specifies whether linked and extracted geometry properties inherits from parent object or part default
Created in NX6.0.0.

License requirements : None

Returns the option "Make Current on Error" gives choice, whether the user wants to make error feature current when features contain errors during feature update/playback.

If the option is true then the error feature will be made current. If the option is false then the error feature will not be made current feature during feature update.
Created in NX7.5.0.

License requirements : None

Returns the option specifying whether to automatically make the datums internal during the sketch creation.

If the option is true then datums are automatically made internal to child sketches, else datums are not automatically made internal to child sketches.
Created in NX7.0.0.

License requirements : None

Returns the option specifying whether to automatically make sketch internal during feature creation.

If the option is true then external sketches are automatically made internal to child features, else external sketches are not automatically made internal to child features.
Created in NX7.0.0.

License requirements : None

Returns the new face properties inheritance.

Specifies whether new face properties inherits from body or part default
Created in NX3.0.0.

License requirements : None

Returns the option " Notify on Delete " gives choice, whether the user wants a notification message when a feature is being deleted will effect other features.

if the option is true then it popup a notification message. if the option is true then it will not popup any notification message
Created in NX4.0.0.

License requirements : None

Returns the features/mark.

Controls how often, during feature creation and editing, the system sets internal marks used in updating. A Features/Mark value of 5, for example, means that one mark will be set after five features are created or edited.
Created in NX3.0.0.

License requirements : None

Returns the color for display poles for B curves.


Created in NX7.5.0.

License requirements : None

Returns the pole color inherit option, for display with B curves.


Created in NX7.5.0.

License requirements : None

Returns the style (3D ball, 2D disk, mark, etc.) of the poles for display of B curves.


Created in NX7.5.0.

License requirements : None

Returns the color for editing poles for B curves and B surfaces.


Created in NX3.0.0.

License requirements : None

Returns the pole color inherit option, for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Returns the style (3D ball, 2D disk, mark, etc.) of the poles for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Returns the color for display polylines for B curves and B surfaces
Created in NX7.5.0.



License requirements : None

Returns the polyline color inherit option, for display with B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Returns the style (solid, dashed, etc.) of the polylines display for B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Returns the color for editing polylines for B curves and B surfaces.


Created in NX3.0.0.

License requirements : None

Returns the polyline color inherit option, for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Returns the style (solid, dashed, etc.) of the polylines for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Returns the position color
Created in NX3.0.0.



License requirements : None

Returns the preview resolution setting.


Created in NX4.0.0.

License requirements : None

Returns the option " Save Rollback Data " saves extra data with the part file for faster edits.


Created in NX5.0.0.

License requirements : None

Sets the acceleration color
Created in NX3.0.0.



License requirements : None

Parameters:
accelerationColoracceleration color
void NXOpen::Preferences::SessionModeling::SetAllowEditingOfDimensionOfInternalSketch ( bool  allowEditingOfDimensionOfInternalSketch)

Sets the option "allow_editing_of_dimension_of_internal_sketch" gives choice, whether or not the sketch dimensions will display and be possible to select and edit directly, without entering the Sketch task environment when a dialog (e.g.

Extrude, Revolve, Hole etc.) is active which allows editing on an internal sketch.
Created in NX7.5.0.

License requirements : None

Parameters:
allowEditingOfDimensionOfInternalSketchallow sketch dim edit of internal sketch preference

Sets the associative edit free form option.

Specify whether the output of editing certain free form features remain as free form features or as unparameterized features.
Created in NX3.0.0.

License requirements : None

Parameters:
associativeEditFreeFormassociative edit free form

Sets the B curve pole curve color.

This is color of the pole control polygons for B-curves .

This property is deprecated. Use Preferences.SessionModeling.PoleDisplayColor or Preferences.SessionModeling.PoleEditColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Parameters:
bCurvePoleColorb curve pole color

Sets the body type.

Toggles between Solid and Sheet. When creating bodies through curves, the Body Type option provides control to the type of body (for example, solid body vs. sheet body) that is created.
Created in NX3.0.0.

License requirements : None

Parameters:
bodyTypebody type

Sets the boolean face properties inheritance.

Specifies whether the boolean face properties inherit from target body or tool body
Created in NX3.0.0.

License requirements : None

Parameters:
booleanFacePropertiesboolean face properties

Sets the B surface pole face color.

This is color of the pole control polygons for B-surface .

This property is deprecated. Use Preferences.SessionModeling.PoleDisplayColor or Preferences.SessionModeling.PoleEditColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Parameters:
bSurfacePoleFaceColorb surface pole face color

Sets the curvature color
Created in NX3.0.0.



License requirements : None

Parameters:
curvatureColorcurvature color

Sets the curve fit method.

Controls the fitting method used when curves must be approximated by splines.
Created in NX3.0.0.

License requirements : None

Parameters:
bodyTypebody type

Sets the toggle "Display Legacy Feature names" gives choice, how user wants feature name in "Name" Coulmn in Partnav checked toggled(True) will show old feature names in "Name" column in Partnav, while unchecked toggled(False) will show new translatable feature names in "Name" column in Partnav
Created in NX4.0.0.



License requirements : None

Parameters:
displayLegacyFeatureNamepreference to display_legacy_feature_name

Sets the dynamic update.

Specifies that the system dynamically displays in real time with each updation of parent curves, splines, bridge curves, lines or arcs
Created in NX3.0.0.

License requirements : None

Parameters:
dynamicUpdatedynamic update

Sets the option "Edit with Rollback upon Double-Click" gives choice of what action to be taken on feature upon Double clicking, either in partnavigator or in Graphics widow.

if the option is true then edit with rollback will be happen upon Double-click. if the option is false then the previous default action will be executed
Created in NX4.0.0.

License requirements : None

Parameters:
defaultEditOptionpreference to Edit with Rollback upon Double-Click

Sets the enable trimmed animation setting.


Created in NX4.0.0.

License requirements : None

Parameters:
enableenable

Sets the option "Feature Alerts" gives choice, whether the user wants the Diagnostic error and information prompts appear when features contain errors and/or information during feature creation, edit, and update.

if the option is true then the diagnostic prompts will appear. if the option is false then prompts will not appear.

This property is deprecated. Use Preferences.SessionUserInterfaceUI.DisplayAlertsOnWarnings, Preferences.SessionUserInterfaceUI.DisplayAlertsOnInformation instead. Alerts are always displayed for errors. Display of alerts on warnings/information can be changed by above mentioned properties. Use of deprecated method FeatureAlerts will always return true as the error alerts are always displayed. If SetFeatureAlerts has no effect on error, warning or information alerts. Use Preferences.SessionUserInterfaceUI.DisplayAlertsOnWarnings, Preferences.SessionUserInterfaceUI.DisplayAlertsOnInformation instead to control the display of warning/information alerts.

Deprecated:
Deprecated in NX7.5.0.


Created in NX5.0.0.

License requirements : None

Parameters:
featureAlertspreference to Feature Alerts

Sets the free form construction result.

Controls free form feature creation when using the Through Curves, Through Curve Mesh, Swept, and Ruled options.
Created in NX3.0.0.

License requirements : None

Parameters:
freeFormConstrResultfree form constr result

Sets the immediate children.

Specifies to which level the dynamic updation is applicable.
Created in NX3.0.0.

License requirements : None

Parameters:
immediateChildrenimmediate children

Sets the option "Interrupt Update on Error" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain errors during feature update/playback.

if the option is true then the dialog will appear. if the option is false then dialog will not appear during feature update.
Created in NX5.0.0.

License requirements : None

Parameters:
interruptOnErrorpreference to Interrupt Update on Error

Sets the option "Interrupt Update on Missing References" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain missing references during feature update/playback.

if the option is true then the dialog will appear. if the option is false then dialog will not appear during feature update.
Created in NX7.5.0.

License requirements : None

Parameters:
interruptOnMissingReferencespreference to Interrupt Update on Missing References

Sets the option "Interrupt Update on Warning" gives choice, whether the user wants the "Edit During Update" dialog to appear when features contain warnings during feature update/playback.

if the option is true then the dialog will appear. if the option is false then dialog will not appear during feature update.
Created in NX5.0.0.

License requirements : None

Parameters:
interruptOnWarningpreference to Interrupt Update on Warning

Sets the linked and extracted geometry properties inheritance.

Specifies whether linked and extracted geometry properties inherits from parent object or part default
Created in NX6.0.0.

License requirements : None

Parameters:
linkedAndExtractedGeometryPropertieslinked and extracted geometry properties

Sets the option "Make Current on Error" gives choice, whether the user wants to make error feature current when features contain errors during feature update/playback.

If the option is true then the error feature will be made current. If the option is false then the error feature will not be made current feature during feature update.
Created in NX7.5.0.

License requirements : None

Parameters:
currentOnErrorpreference to Make Error Feature Current on Error

Sets the option specifying whether to automatically make the datums internal during the sketch creation.

If the option is true then datums are automatically made internal to child sketches, else datums are not automatically made internal to child sketches.
Created in NX7.0.0.

License requirements : None

Parameters:
makeDatumsInternalFlag indicating whether to make datums internal

Sets the option specifying whether to automatically make sketch internal during feature creation.

If the option is true then external sketches are automatically made internal to child features, else external sketches are not automatically made internal to child features.
Created in NX7.0.0.

License requirements : None

Parameters:
makeSketchesInternalFlag indicating whether to make sketches internal

Sets the new face properties inheritance.

Specifies whether new face properties inherits from body or part default
Created in NX3.0.0.

License requirements : None

Parameters:
newFacePropertiesnew face properties

Sets the option " Notify on Delete " gives choice, whether the user wants a notification message when a feature is being deleted will effect other features.

if the option is true then it popup a notification message. if the option is true then it will not popup any notification message
Created in NX4.0.0.

License requirements : None

Parameters:
notifyOnDeletepreference to Notify on Delete

Sets the features/mark.

Controls how often, during feature creation and editing, the system sets internal marks used in updating. A Features/Mark value of 5, for example, means that one mark will be set after five features are created or edited.
Created in NX3.0.0.

License requirements : None

Parameters:
pmarkFrequencypmark frequency

Sets the color for display poles for B curves.


Created in NX7.5.0.

License requirements : None

Parameters:
poleDisplayColorpole display color

Sets the pole color inherit option, for display with B curves.


Created in NX7.5.0.

License requirements : None

Parameters:
poleDisplayInheritColorpole display inherit color

Sets the style (3D ball, 2D disk, mark, etc.) of the poles for display of B curves.


Created in NX7.5.0.

License requirements : None

Parameters:
poleDisplayStylepole display style

Sets the color for editing poles for B curves and B surfaces.


Created in NX3.0.0.

License requirements : None

Parameters:
poleEditColorpole edit color

Sets the pole color inherit option, for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Parameters:
poleEditInheritColorpole edit inherit color

Sets the style (3D ball, 2D disk, mark, etc.) of the poles for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Parameters:
poleEditStylepole edit style

Sets the color for display polylines for B curves and B surfaces
Created in NX7.5.0.



License requirements : None

Parameters:
polylineDisplayColorpolyline display color

Sets the polyline color inherit option, for display with B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Parameters:
polylineDisplayInheritColorpolyline display inherit color

Sets the style (solid, dashed, etc.) of the polylines display for B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Parameters:
polylineDisplayStylepolyline display style

Sets the color for editing polylines for B curves and B surfaces.


Created in NX3.0.0.

License requirements : None

Parameters:
polylineEditColorpolyline edit color

Sets the polyline color inherit option, for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Parameters:
polylineEditInheritColorpolyline edit inherit color

Sets the style (solid, dashed, etc.) of the polylines for editing B curves and B surfaces.


Created in NX7.5.0.

License requirements : None

Parameters:
polylineEditStylepolyline edit style

Sets the position color
Created in NX3.0.0.



License requirements : None

Parameters:
positionColorposition color

Sets the preview resolution setting.


Created in NX4.0.0.

License requirements : None

Parameters:
resolutionresolution

Sets the option " Save Rollback Data " saves extra data with the part file for faster edits.


Created in NX5.0.0.

License requirements : None

Parameters:
retainRollbackDatapreference to retain rollback data

Sets the option to specify whether simulation specific UI should show up in modeling
Created in NX7.5.0.



License requirements : None

Parameters:
showSimuationUiInModelingallow simulation specific UI in modeling

Sets the sketch default action
Created in NX7.5.0.



License requirements : None

Parameters:
sketchActiondefault action on sketches

Sets the option that determines whether or not task environment is used to edit the sketch
Created in NX7.5.0.



License requirements : None

Parameters:
sketchEditOptionedit option on sketches

Sets the value indicating the default action for a spline.


Created in NX7.0.0.

License requirements : None

Parameters:
actionaction

Sets the tangent color
Created in NX3.0.0.



License requirements : None

Parameters:
tangentColortangent color

Sets the update delayed option.

If the option is true, then an edited feature does not update until Update::DoUpdate is explicitly called. If the option is false, then the edited feature updates immediately. The default is false.
Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters:
optionoption

Sets the option "Update Failure Report" gives choice, whether the user wants the update failure report to be generated for the features that failed during current update cycle.

If the option is true then the update failure report will be launched at the end of every update cycle. It will list only those features that failed in that update cycle. If the option is false then no such report will be launched.
Created in NX5.0.0.

License requirements : None

Parameters:
updateFailureReportupdate failure report preference

Sets the curve color option for B Curve.

If true the user selected color is applied on curve .

This property is deprecated. Use Preferences.SessionModeling.PolepolyDisplayInheritColor or Preferences.SessionModeling.PolepolyEditInheritColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Parameters:
useCurveColoruse curve color

Sets the face color option for B Surface.

If true the user selected color is applied on face.

This property is deprecated. Use Preferences.SessionModeling.PolepolyDisplayInheritColor or Preferences.SessionModeling.PolepolyEditInheritColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Parameters:
useFaceColoruse face color

Sets the use triangular mesh setting setting.


Created in NX4.0.0.

License requirements : None

Parameters:
useuse

Returns the option to specify whether simulation specific UI should show up in modeling
Created in NX7.5.0.



License requirements : None

Returns the sketch default action
Created in NX7.5.0.



License requirements : None

Returns the option that determines whether or not task environment is used to edit the sketch
Created in NX7.5.0.



License requirements : None

Returns the value indicating the default action for a spline.


Created in NX7.0.0.

License requirements : None

Returns the tag of this object.

Returns the tangent color
Created in NX3.0.0.



License requirements : None

Returns the update delayed option.

If the option is true, then an edited feature does not update until Update::DoUpdate is explicitly called. If the option is false, then the edited feature updates immediately. The default is false.
Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Returns the option "Update Failure Report" gives choice, whether the user wants the update failure report to be generated for the features that failed during current update cycle.

If the option is true then the update failure report will be launched at the end of every update cycle. It will list only those features that failed in that update cycle. If the option is false then no such report will be launched.
Created in NX5.0.0.

License requirements : None

Returns the curve color option for B Curve.

If true the user selected color is applied on curve .

This property is deprecated. Use Preferences.SessionModeling.PolepolyDisplayInheritColor or Preferences.SessionModeling.PolepolyEditInheritColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Returns the face color option for B Surface.

If true the user selected color is applied on face.

This property is deprecated. Use Preferences.SessionModeling.PolepolyDisplayInheritColor or Preferences.SessionModeling.PolepolyEditInheritColor instead.

Deprecated:
Deprecated in NX7.5.0.


Created in NX3.0.0.

License requirements : None

Returns the use triangular mesh setting setting.


Created in NX4.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.