public interface SessionSketch extends Remote
SessionPreferences
Modifier and Type | Interface and Description |
---|---|
static class |
SessionSketch.BackgroundType
Describes the available sketch background types.
|
static class |
SessionSketch.GroupConstraintType
Represents the constraint management option when creating a rigid or scalable sketch group.
|
static class |
SessionSketch.OriginType
Describes the available sketch origin types.
|
static class |
SessionSketch.RigidSetConstraintType
Deprecated.
Deprecated in NX11.0.0. Use
SessionSketch.GroupConstraintType instead.
|
Modifier and Type | Method and Description |
---|---|
boolean |
autoDimensionsToArcCenter()
Returns the setting that controls whether or not auto-dimensions are created to arc centers.
|
SessionSketch.BackgroundType |
backgroundOption()
Returns the background option
License requirements: None. |
boolean |
changeViewOrientation()
Returns the setting that controls whether the view orientation will be changed to align with the sketch when the sketch is activated.
|
double |
constraintSymbolSize()
Returns the constraint symbol size.
|
boolean |
continuousAutoDimensioning()
Returns the setting that controls whether or not to continuously create auto dimensions in a sketch.
|
boolean |
createInferredConstraints()
Returns the setting that controls whether or not to create inferred constraints
License requirements: None. |
String |
defaultArcNamePrefix()
Returns the default arc name prefix
License requirements: None. |
String |
defaultConicNamePrefix()
Returns the default conic name prefix
License requirements: None. |
String |
defaultLineNamePrefix()
Returns the default line name prefix
License requirements: None. |
String |
defaultSketchNamePrefix()
Returns the default sketch name prefix
License requirements: None. |
String |
defaultSplineNamePrefix()
Returns the default spline name prefix
License requirements: None. |
String |
defaultVertexNamePrefix()
Returns the default vertex name prefix
License requirements: None. |
boolean |
delayEvaluation()
Returns the setting that controls whether or not the sketch should be evaluated when a constraint is
added to the sketch.
|
SketchPreferences.DimensionLabelType |
dimensionLabel()
Returns the dimension label
License requirements: None. |
boolean |
displayAutoDimensions()
Returns the setting that controls whether or not to display auto dimensions
License requirements: None. |
boolean |
displayConstraintSymbols()
Returns the setting that controls whether or not to display constraint symbols
License requirements: None. |
boolean |
displayDOFArrows()
Returns the setting that controls whether or not the degree of freedom arrows are displayed.
|
boolean |
displayObjectColor()
Returns the setting that controls whether or not sketch objects should be displayed in their true color
License requirements: None. |
boolean |
displayObjectName()
Returns the setting that controls whether or not objects are displayed with their names in sketch.
|
boolean |
displayParenthesesOnReferenceDimensions()
Returns the setting that controls whether or not to display parentheses on reference dimensions
License requirements: None. |
boolean |
displayReferenceGeometry()
Returns the setting that controls whether or not the reference geometry are displayed on inactive sketches.
|
boolean |
displaySectionMappingWarning()
Returns the display section mapping warning flag.
|
boolean |
displayVertices()
Returns the setting that controls whether or not to display sketch vertices.
|
boolean |
dynamicConstraintDisplay()
Returns the setting that controls whether or not constraint symbols are displayed if the associated geometry is very small.
|
double |
fixedTextSize()
Returns the dimension text size when the text size fixed flag is set.
|
SessionSketch.GroupConstraintType |
groupConstraintOption()
Returns the sketch group external constraint management option
License requirements: None. |
boolean |
maintainBlankStatus()
Returns the setting that controls whether or not previously blanked objects will be visible when a sketch is activated
License requirements: None. |
boolean |
maintainLayerStatus()
Returns the setting that controls whether or not the work layer remains the same or returns to its previous
value when a sketch is deactivated.
|
SessionSketch.OriginType |
originOption()
Deprecated.
Deprecated in NX8.0.0. Use
SketchInPlaceBuilder.setProjectWorkPartOrigin(boolean) and SketchInPlaceBuilder.setMakeOriginAssociative(boolean) and SketchInPlaceBuilder.setSketchOrigin(nxopen.Point) instead.
|
boolean |
retainDimensions()
Deprecated.
Deprecated in NX8.0.1. Use
AnnotationManager.makePmi(nxopen.annotations.Annotation) and AnnotationManager.removePmi(nxopen.annotations.Annotation) with individual dimensions instead.
|
SessionSketch.RigidSetConstraintType |
rigidSetConstraintOption()
Deprecated.
Deprecated in NX11.0.0. Use
setGroupConstraintOption(nxopen.preferences.SessionSketch.GroupConstraintType) instead.
|
boolean |
scaleOnFirstDrivingDimension()
Returns 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.
|
void |
setAutoDimensionsToArcCenter(boolean toArcCenter)
Sets the setting that controls whether or not auto-dimensions are created to arc centers.
|
void |
setBackgroundOption(SessionSketch.BackgroundType backgroundType)
Sets the background option
License requirements: None. |
void |
setChangeViewOrientation(boolean changeViewOrientation)
Sets the setting that controls whether the view orientation will be changed to align with the sketch when the sketch is activated.
|
void |
setConstraintSymbolSize(double constraintSymbolSize)
Sets the constraint symbol size.
|
void |
setContinuousAutoDimensioning(boolean continAutoDim)
Sets the setting that controls whether or not to continuously create auto dimensions in a sketch.
|
void |
setCreateInferredConstraints(boolean createInferredConstraints)
Sets the setting that controls whether or not to create inferred constraints
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setDefaultArcNamePrefix(String defaultArcNamePrefix)
Sets the default arc name prefix
License requirements: None. |
void |
setDefaultConicNamePrefix(String defaultConicNamePrefix)
Sets the default conic name prefix
License requirements: None. |
void |
setDefaultLineNamePrefix(String defaultLineNamePrefix)
Sets the default line name prefix
License requirements: None. |
void |
setDefaultSketchNamePrefix(String defaultSketchNamePrefix)
Sets the default sketch name prefix
License requirements: None. |
void |
setDefaultSplineNamePrefix(String defaultSplineNamePrefix)
Sets the default spline name prefix
License requirements: None. |
void |
setDefaultVertexNamePrefix(String defaultVertexNamePrefix)
Sets the default vertex name prefix
License requirements: None. |
void |
setDelayEvaluation(boolean delayEvaluation)
Sets the setting that controls whether or not the sketch should be evaluated when a constraint is
added to the sketch.
|
void |
setDimensionLabel(SketchPreferences.DimensionLabelType dimensionLabel)
Sets the dimension label
License requirements: None. |
void |
setDisplayAutoDimensions(boolean displayAutoDimensions)
Sets the setting that controls whether or not to display auto dimensions
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setDisplayConstraintSymbols(boolean displayConstraintSymbols)
Sets the setting that controls whether or not to display constraint symbols
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setDisplayDOFArrows(boolean displayDOFArrows)
Sets the setting that controls whether or not the degree of freedom arrows are displayed.
|
void |
setDisplayObjectColor(boolean displayObjColor)
Sets the setting that controls whether or not sketch objects should be displayed in their true color
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setDisplayObjectName(boolean displayObjectName)
Sets the setting that controls whether or not objects are displayed with their names in sketch.
|
void |
setDisplayParenthesesOnReferenceDimensions(boolean displayParentheses)
Sets the setting that controls whether or not to display parentheses on reference dimensions
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setDisplayReferenceGeometry(boolean displayReferenceGeometry)
Sets the setting that controls whether or not the reference geometry are displayed on inactive sketches.
|
void |
setDisplaySectionMappingWarning(boolean displaySectionMappingWarning)
Sets the display section mapping warning flag.
|
void |
setDisplayVertices(boolean displayVertices)
Sets the setting that controls whether or not to display sketch vertices.
|
void |
setDynamicConstraintDisplay(boolean dynamicConstraintDisplay)
Sets the setting that controls whether or not constraint symbols are displayed if the associated geometry is very small.
|
void |
setFixedTextSize(double fixedTextSize)
Sets the dimension text size when the text size fixed flag is set.
|
void |
setGroupConstraintOption(SessionSketch.GroupConstraintType constraintType)
Sets the sketch group external constraint management option
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") OR geometric_tol ("GDT") . |
void |
setMaintainBlankStatus(boolean keepBlank)
Sets the setting that controls whether or not previously blanked objects will be visible when a sketch is activated
License requirements: None. |
void |
setMaintainLayerStatus(boolean maintainLayerStatus)
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.
|
void |
setOriginOption(SessionSketch.OriginType originType)
Deprecated.
Deprecated in NX8.0.0. Use
SketchInPlaceBuilder.setProjectWorkPartOrigin(boolean) and SketchInPlaceBuilder.setMakeOriginAssociative(boolean) and SketchInPlaceBuilder.setSketchOrigin(nxopen.Point) instead.
|
void |
setRetainDimensions(boolean retainDimensions)
Deprecated.
Deprecated in NX8.0.1. Use
AnnotationManager.makePmi(nxopen.annotations.Annotation) and AnnotationManager.removePmi(nxopen.annotations.Annotation) with individual dimensions instead.
|
void |
setRigidSetConstraintOption(SessionSketch.RigidSetConstraintType constraintType)
Deprecated.
Deprecated in NX11.0.0. Use
setGroupConstraintOption(nxopen.preferences.SessionSketch.GroupConstraintType) instead.
|
void |
setScaleOnFirstDrivingDimension(boolean scaleOnFirstDrivingDimension)
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.
|
void |
setSnapAngle(double snapAngle)
Sets the snap angle.
|
void |
setSolvingTolerance(double tolerance)
Sets the sketch solving tolerance.
|
void |
setTextSizeFixed(boolean textSizeFixed)
Sets the setting that controls whether or not dimension text size is fixed.
|
void |
setUpdateSketchOnly(boolean delayModelUpdate)
Sets the setting that controls whether or not to update only the sketch while sketching using Direct Sketch.
|
void |
setUseSolvingTolerance(boolean useTolerance)
Sets the setting that controls whether or not to use user input for sketch solving tolerance.
|
double |
snapAngle()
Returns the snap angle.
|
double |
solvingTolerance()
Returns the sketch solving tolerance.
|
boolean |
textSizeFixed()
Returns the setting that controls whether or not dimension text size is fixed.
|
boolean |
updateSketchOnly()
Returns the setting that controls whether or not to update only the sketch while sketching using Direct Sketch.
|
boolean |
useSolvingTolerance()
Returns the setting that controls whether or not to use user input for sketch solving tolerance.
|
double snapAngle() throws NXException, RemoteException
NXException
RemoteException
void setSnapAngle(double snapAngle) throws NXException, RemoteException
snapAngle
- NXException
RemoteException
boolean changeViewOrientation() throws NXException, RemoteException
NXException
RemoteException
void setChangeViewOrientation(boolean changeViewOrientation) throws NXException, RemoteException
changeViewOrientation
- NXException
RemoteException
boolean maintainBlankStatus() throws NXException, RemoteException
NXException
RemoteException
void setMaintainBlankStatus(boolean keepBlank) throws NXException, RemoteException
keepBlank
- NXException
RemoteException
boolean maintainLayerStatus() throws NXException, RemoteException
NXException
RemoteException
void setMaintainLayerStatus(boolean maintainLayerStatus) throws NXException, RemoteException
maintainLayerStatus
- NXException
RemoteException
boolean displayDOFArrows() throws NXException, RemoteException
NXException
RemoteException
void setDisplayDOFArrows(boolean displayDOFArrows) throws NXException, RemoteException
displayDOFArrows
- NXException
RemoteException
boolean dynamicConstraintDisplay() throws NXException, RemoteException
NXException
RemoteException
void setDynamicConstraintDisplay(boolean dynamicConstraintDisplay) throws NXException, RemoteException
dynamicConstraintDisplay
- NXException
RemoteException
boolean textSizeFixed() throws NXException, RemoteException
NXException
RemoteException
void setTextSizeFixed(boolean textSizeFixed) throws NXException, RemoteException
textSizeFixed
- NXException
RemoteException
double fixedTextSize() throws NXException, RemoteException
NXException
RemoteException
void setFixedTextSize(double fixedTextSize) throws NXException, RemoteException
fixedTextSize
- NXException
RemoteException
double constraintSymbolSize() throws NXException, RemoteException
NXException
RemoteException
void setConstraintSymbolSize(double constraintSymbolSize) throws NXException, RemoteException
constraintSymbolSize
- NXException
RemoteException
boolean displaySectionMappingWarning() throws NXException, RemoteException
NXException
RemoteException
void setDisplaySectionMappingWarning(boolean displaySectionMappingWarning) throws NXException, RemoteException
displaySectionMappingWarning
- NXException
RemoteException
boolean retainDimensions() throws NXException, RemoteException
AnnotationManager.makePmi(nxopen.annotations.Annotation)
and AnnotationManager.removePmi(nxopen.annotations.Annotation)
with individual dimensions instead.
NXException
RemoteException
void setRetainDimensions(boolean retainDimensions) throws NXException, RemoteException
AnnotationManager.makePmi(nxopen.annotations.Annotation)
and AnnotationManager.removePmi(nxopen.annotations.Annotation)
with individual dimensions instead.
retainDimensions
- NXException
RemoteException
SessionSketch.OriginType originOption() throws NXException, RemoteException
SketchInPlaceBuilder.setProjectWorkPartOrigin(boolean)
and SketchInPlaceBuilder.setMakeOriginAssociative(boolean)
and SketchInPlaceBuilder.setSketchOrigin(nxopen.Point)
instead.
NXException
RemoteException
void setOriginOption(SessionSketch.OriginType originType) throws NXException, RemoteException
SketchInPlaceBuilder.setProjectWorkPartOrigin(boolean)
and SketchInPlaceBuilder.setMakeOriginAssociative(boolean)
and SketchInPlaceBuilder.setSketchOrigin(nxopen.Point)
instead.
originType
- NXException
RemoteException
SessionSketch.BackgroundType backgroundOption() throws NXException, RemoteException
NXException
RemoteException
void setBackgroundOption(SessionSketch.BackgroundType backgroundType) throws NXException, RemoteException
backgroundType
- NXException
RemoteException
String defaultSketchNamePrefix() throws NXException, RemoteException
NXException
RemoteException
void setDefaultSketchNamePrefix(String defaultSketchNamePrefix) throws NXException, RemoteException
defaultSketchNamePrefix
- NXException
RemoteException
String defaultVertexNamePrefix() throws NXException, RemoteException
NXException
RemoteException
void setDefaultVertexNamePrefix(String defaultVertexNamePrefix) throws NXException, RemoteException
defaultVertexNamePrefix
- NXException
RemoteException
String defaultLineNamePrefix() throws NXException, RemoteException
NXException
RemoteException
void setDefaultLineNamePrefix(String defaultLineNamePrefix) throws NXException, RemoteException
defaultLineNamePrefix
- NXException
RemoteException
String defaultArcNamePrefix() throws NXException, RemoteException
NXException
RemoteException
void setDefaultArcNamePrefix(String defaultArcNamePrefix) throws NXException, RemoteException
defaultArcNamePrefix
- NXException
RemoteException
String defaultConicNamePrefix() throws NXException, RemoteException
NXException
RemoteException
void setDefaultConicNamePrefix(String defaultConicNamePrefix) throws NXException, RemoteException
defaultConicNamePrefix
- NXException
RemoteException
String defaultSplineNamePrefix() throws NXException, RemoteException
NXException
RemoteException
void setDefaultSplineNamePrefix(String defaultSplineNamePrefix) throws NXException, RemoteException
defaultSplineNamePrefix
- NXException
RemoteException
SketchPreferences.DimensionLabelType dimensionLabel() throws NXException, RemoteException
NXException
RemoteException
void setDimensionLabel(SketchPreferences.DimensionLabelType dimensionLabel) throws NXException, RemoteException
dimensionLabel
- NXException
RemoteException
boolean delayEvaluation() throws NXException, RemoteException
NXException
RemoteException
void setDelayEvaluation(boolean delayEvaluation) throws NXException, RemoteException
delayEvaluation
- NXException
RemoteException
boolean displayObjectColor() throws NXException, RemoteException
NXException
RemoteException
void setDisplayObjectColor(boolean displayObjColor) throws NXException, RemoteException
displayObjColor
- NXException
RemoteException
boolean continuousAutoDimensioning() throws NXException, RemoteException
NXException
RemoteException
void setContinuousAutoDimensioning(boolean continAutoDim) throws NXException, RemoteException
continAutoDim
- NXException
RemoteException
boolean createInferredConstraints() throws NXException, RemoteException
NXException
RemoteException
void setCreateInferredConstraints(boolean createInferredConstraints) throws NXException, RemoteException
createInferredConstraints
- NXException
RemoteException
boolean autoDimensionsToArcCenter() throws NXException, RemoteException
NXException
RemoteException
void setAutoDimensionsToArcCenter(boolean toArcCenter) throws NXException, RemoteException
toArcCenter
- NXException
RemoteException
boolean updateSketchOnly() throws NXException, RemoteException
NXException
RemoteException
void setUpdateSketchOnly(boolean delayModelUpdate) throws NXException, RemoteException
delayModelUpdate
- NXException
RemoteException
boolean displayConstraintSymbols() throws NXException, RemoteException
NXException
RemoteException
void setDisplayConstraintSymbols(boolean displayConstraintSymbols) throws NXException, RemoteException
displayConstraintSymbols
- NXException
RemoteException
boolean displayAutoDimensions() throws NXException, RemoteException
NXException
RemoteException
void setDisplayAutoDimensions(boolean displayAutoDimensions) throws NXException, RemoteException
displayAutoDimensions
- NXException
RemoteException
boolean displayReferenceGeometry() throws NXException, RemoteException
NXException
RemoteException
void setDisplayReferenceGeometry(boolean displayReferenceGeometry) throws NXException, RemoteException
displayReferenceGeometry
- NXException
RemoteException
boolean useSolvingTolerance() throws NXException, RemoteException
NXException
RemoteException
void setUseSolvingTolerance(boolean useTolerance) throws NXException, RemoteException
useTolerance
- NXException
RemoteException
double solvingTolerance() throws NXException, RemoteException
NXException
RemoteException
void setSolvingTolerance(double tolerance) throws NXException, RemoteException
tolerance
- NXException
RemoteException
SessionSketch.RigidSetConstraintType rigidSetConstraintOption() throws NXException, RemoteException
setGroupConstraintOption(nxopen.preferences.SessionSketch.GroupConstraintType)
instead.
NXException
RemoteException
void setRigidSetConstraintOption(SessionSketch.RigidSetConstraintType constraintType) throws NXException, RemoteException
setGroupConstraintOption(nxopen.preferences.SessionSketch.GroupConstraintType)
instead.
constraintType
- NXException
RemoteException
boolean displayObjectName() throws NXException, RemoteException
NXException
RemoteException
void setDisplayObjectName(boolean displayObjectName) throws NXException, RemoteException
displayObjectName
- NXException
RemoteException
SessionSketch.GroupConstraintType groupConstraintOption() throws NXException, RemoteException
NXException
RemoteException
void setGroupConstraintOption(SessionSketch.GroupConstraintType constraintType) throws NXException, RemoteException
constraintType
- NXException
RemoteException
boolean displayVertices() throws NXException, RemoteException
NXException
RemoteException
void setDisplayVertices(boolean displayVertices) throws NXException, RemoteException
displayVertices
- NXException
RemoteException
boolean displayParenthesesOnReferenceDimensions() throws NXException, RemoteException
NXException
RemoteException
void setDisplayParenthesesOnReferenceDimensions(boolean displayParentheses) throws NXException, RemoteException
displayParentheses
- NXException
RemoteException
boolean scaleOnFirstDrivingDimension() throws NXException, RemoteException
NXException
RemoteException
void setScaleOnFirstDrivingDimension(boolean scaleOnFirstDrivingDimension) throws NXException, RemoteException
scaleOnFirstDrivingDimension
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.