nxopen.preferences

Interface SketchPreferences

All Superinterfaces:

Remote

public interface SketchPreferences
extends Remote

Represents the set of sketch preferences applicable on Sketch object
To obtain an instance of this class, refer to Sketch

Created in NX3.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SketchPreferences.DimensionLabelType Describes the different options for displaying dimension labels.

Method Summary

Modifier and Type	Method and Description
void	applySketchPreferences(int dimDisplayFlag) Applies sketch preferences set by user.
double	constraintSymbolSize() Returns the constraint symbol size License requirements: None.
boolean	continuousAutoDimensioningSetting() Returns the option to set continuous auto dimensioning in a sketch on or off.
boolean	createInferredConstraints() Returns the option to control if inferred constraints are automatically created when curves and points are created in the sketch.
SketchPreferences.DimensionLabelType	dimensionLabel() Returns the dimension label.
boolean	displayObjectColor() Returns the toggle that controls whether objects are displayed in their actual color in sketch License requirements: None.
boolean	displayObjectName() Returns the toggle that controls whether objects are displayed with their names in sketch License requirements: None.
double	fixedTextSize() Returns the fixed text size.
void	setConstraintSymbolSize(double constraintSize) Sets the constraint symbol size License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") .
void	setContinuousAutoDimensioningSetting(boolean autoDim) Sets the option to set continuous auto dimensioning in a sketch on or off.
void	setCreateInferredConstraints(boolean createInferredConstraints) Sets the option to control if inferred constraints are automatically created when curves and points are created in the sketch.
void	setDimensionLabel(SketchPreferences.DimensionLabelType dimensionLabel) Sets the dimension label.
void	setDisplayObjectColor(boolean displayObjectColor) Sets the toggle that controls whether objects are displayed in their actual color in sketch License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") .
void	setDisplayObjectName(boolean displayObjectName) Sets the toggle that controls whether objects are displayed with their names in sketch License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") .
void	setFixedTextSize(double fixedTextSize) Sets the fixed text size.
void	setSolvingTolerance(double tolerance) Sets the sketch solving tolerance.
void	setTextSizeFixed(boolean textSizeFixed) Sets the option that controls if the text size should be fixed.
void	setUseSolvingTolerance(boolean useTolerance) Sets the sketch solving tolerance flag.
double	solvingTolerance() Returns the sketch solving tolerance.
boolean	textSizeFixed() Returns the option that controls if the text size should be fixed.
boolean	useSolvingTolerance() Returns the sketch solving tolerance flag.

Method Detail

constraintSymbolSize

double constraintSymbolSize()
                     throws NXException,
                            RemoteException

Returns the constraint symbol size
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setConstraintSymbolSize

void setConstraintSymbolSize(double constraintSize)
                      throws NXException,
                             RemoteException

Sets the constraint symbol size
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
.
Created in NX8.5.0

Parameters:

constraintSize -

Throws:

NXException

RemoteException

dimensionLabel

SketchPreferences.DimensionLabelType dimensionLabel()
                                             throws NXException,
                                                    RemoteException

Returns the dimension label. Controls how expressions in sketch dimensions are displayed
License requirements: None.

Created in NX3.0.0

Throws:

NXException

RemoteException

setDimensionLabel

void setDimensionLabel(SketchPreferences.DimensionLabelType dimensionLabel)
                throws NXException,
                       RemoteException

Sets the dimension label. Controls how expressions in sketch dimensions are displayed
License requirements: None.

Created in NX3.0.0

Parameters:

dimensionLabel -

Throws:

NXException

RemoteException

applySketchPreferences

void applySketchPreferences(int dimDisplayFlag)
                     throws NXException,
                            RemoteException

Applies sketch preferences set by user. The dimDisplayFlag is the API version of the UI setting of Retain Dimensions which was last available for use in NX 6. The setting still exists in the UI for legacy parts that have a sketch with Retain Dimensions enabled. However, once the setting is turned off, it cannot be turned on again. This functionality is replaced by AnnotationManager.makePmi(Annotation) in an active sketch or EditDimensionBuilder.displayAsPmi() and EditDimensionBuilder.setDisplayAsPmi(boolean) when not in an active sketch.
License requirements: None.

Created in NX3.0.0

Parameters:

dimDisplayFlag - If sketch dimensions are already displayed outside of an active sketch, Set 0 to turn off the display of dimensions outside of the active sketch.

Throws:

NXException

RemoteException

displayObjectColor

boolean displayObjectColor()
                    throws NXException,
                           RemoteException

Returns the toggle that controls whether objects are displayed in their actual color in sketch
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setDisplayObjectColor

void setDisplayObjectColor(boolean displayObjectColor)
                    throws NXException,
                           RemoteException

Sets the toggle that controls whether objects are displayed in their actual color in sketch
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
.
Created in NX4.0.0

Parameters:

displayObjectColor -

Throws:

NXException

RemoteException

createInferredConstraints

boolean createInferredConstraints()
                           throws NXException,
                                  RemoteException

Returns the option to control if inferred constraints are automatically created when curves and points are created in the sketch.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setCreateInferredConstraints

void setCreateInferredConstraints(boolean createInferredConstraints)
                           throws NXException,
                                  RemoteException

Sets the option to control if inferred constraints are automatically created when curves and points are created in the sketch.
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")

Created in NX6.0.0

Parameters:

createInferredConstraints -

Throws:

NXException

RemoteException

textSizeFixed

boolean textSizeFixed()
               throws NXException,
                      RemoteException

Returns the option that controls if the text size should be fixed.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setTextSizeFixed

void setTextSizeFixed(boolean textSizeFixed)
               throws NXException,
                      RemoteException

Sets the option that controls if the text size should be fixed.
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")

Created in NX6.0.0

Parameters:

textSizeFixed -

Throws:

NXException

RemoteException

fixedTextSize

double fixedTextSize()
              throws NXException,
                     RemoteException

Returns the fixed text size. It is the visible dimension size when text size fixed is enabled.
License requirements: None.

Created in NX6.0.0

Throws:

NXException

RemoteException

setFixedTextSize

void setFixedTextSize(double fixedTextSize)
               throws NXException,
                      RemoteException

Sets the fixed text size. It is the visible dimension size when text size fixed is enabled.
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")

Created in NX6.0.0

Parameters:

fixedTextSize -

Throws:

NXException

RemoteException

continuousAutoDimensioningSetting

boolean continuousAutoDimensioningSetting()
                                   throws NXException,
                                          RemoteException

Returns the option to set continuous auto dimensioning in a sketch on or off. If the option is true (On) then the auto dimensioner will be automatically executed right after an individual curve is created in a sketch.
License requirements: None.

Created in NX7.5.0

Throws:

NXException

RemoteException

setContinuousAutoDimensioningSetting

void setContinuousAutoDimensioningSetting(boolean autoDim)
                                   throws NXException,
                                          RemoteException

Sets the option to set continuous auto dimensioning in a sketch on or off. If the option is true (On) then the auto dimensioner will be automatically executed right after an individual curve is created in a sketch.
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")

Created in NX7.5.0

Parameters:

autoDim -

Throws:

NXException

RemoteException

useSolvingTolerance

boolean useSolvingTolerance()
                     throws NXException,
                            RemoteException

Returns the sketch solving tolerance flag. Controls whether to use user input for sketch tolerance
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setUseSolvingTolerance

void setUseSolvingTolerance(boolean useTolerance)
                     throws NXException,
                            RemoteException

Sets the sketch solving tolerance flag. Controls whether to use user input for sketch tolerance
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")

Created in NX8.5.0

Parameters:

useTolerance -

Throws:

NXException

RemoteException

solvingTolerance

double solvingTolerance()
                 throws NXException,
                        RemoteException

Returns the sketch solving tolerance. This specifies the maximum allowable distance between two objects when solving the sketch constraints for the given sketch. The tolerance value must be greater than 1e-08.
License requirements: None.

Created in NX8.5.0

Throws:

NXException

RemoteException

setSolvingTolerance

void setSolvingTolerance(double tolerance)
                  throws NXException,
                         RemoteException

Sets the sketch solving tolerance. This specifies the maximum allowable distance between two objects when solving the sketch constraints for the given sketch. The tolerance value must be greater than 1e-08.
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")

Created in NX8.5.0

Parameters:

tolerance -

Throws:

NXException

RemoteException

displayObjectName

boolean displayObjectName()
                   throws NXException,
                          RemoteException

Returns the toggle that controls whether objects are displayed with their names in sketch
License requirements: None.

Created in NX9.0.0

Throws:

NXException

RemoteException

setDisplayObjectName

void setDisplayObjectName(boolean displayObjectName)
                   throws NXException,
                          RemoteException

Sets the toggle that controls whether objects are displayed with their names in sketch
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT")
.
Created in NX9.0.0

Parameters:

displayObjectName -

Throws:

NXException

RemoteException