DeviationGaugeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DeviationGaugeBuilder Class

class `NXOpen.GeometricAnalysis.``DeviationGaugeBuilder`

  Bases: `NXOpen.Builder`

  DeviationGaugeBuilder class

  To create a new instance of this class, use `NXOpen.GeometricAnalysis.AnalysisObjectCollection.CreateDeviationGaugeBuilder()`

  Default values.

  Property | Value
  --- | ---
  ColorPlotType | Blend
  CurveRangeControl.AnchorPosition | Start
  DeviationIntervals | 5
  HasAbsoluteColorPlot | 0
  HasAdditionalValuesLabel | None
  HasMaximumValueLabel | 1
  HasMinimumValueLabel | 0
  InnerTolerance | 0.1
  IsLabelDisplayed | 0
  IsMarkerDisplayed | 0
  IsNeedlePlotDisplayed | 1
  MaxCheckingAngle | 5
  MaxCheckingDistance | 1 (millimeters part), 0.5 (inches part)
  MeasurementMethod | ThreeDim
  MeasurementSamples | 20
  MinMaxOption | Minmax
  NeedleScale | 1.0
  NegativeInnerTolerance | -0.001
  NegativeOuterTolerance | -0.001
  OuterTolerance | 0.1
  PositiveInnerTolerance | 0.001
  PositiveOuterTolerance | 0.001
  ReportingPerType | AnalysisObject
  SpatialResolution | 0.1
  SurfaceRangeControl.AnchorPosition | Vertex1
  XyzDirection | X

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
ColorPlotType | Returns or sets the color plot type
ConstraintManager | Returns the constraint manager
CurveRangeControl | Returns the curve range
DeviationIntervals | Returns or sets the number of deviation intervals
HasAbsoluteColorPlot | Returns or sets a value indicating whether to plot using absolute value
HasAdditionalValuesLabel | Returns or sets a value indicating whether to add additional values label
HasCrossCurveDeviationLabel | Returns or sets a value indicating whether to display cross_curve deviation label
HasInfoLabel | Returns or sets a value indicating whether to enable floating info label
HasInnerToleranceLabel | Returns or sets a value indicating whether to display inner tolerance label
HasMaximumValueLabel | Returns or sets a value indicating whether to display maximum value label
HasMinimumValueLabel | Returns or sets a value indicating whether to display minimum value label
InnerTolerance | Returns or sets the inner tolerance
IsColorMapDisplayed | Returns or sets a value indicating whether to display color map
IsDirectionReversed | Returns or sets a value indicating whether to reverse the direction
IsLabelDisplayed | Returns or sets a value indicating whether to display label
IsMarkerDisplayed | Returns or sets a value indicating whether to display marker
IsNeedlePlotDisplayed | Returns or sets a value indicating whether to display needle plot
MaxCheckingAngle | Returns or sets the maximum checking angle
MaxCheckingDistance | Returns or sets the maximum checking distance
MeasurementMethod | Returns or sets the measurement method
MeasurementSamples | Returns or sets the number of measurement samples
MinMaxOption | Returns or sets the min_max type
NeedleScale | Returns or sets the needle scale
NegativeInnerTolerance | Returns or sets the negative inner tolerance
NegativeOuterTolerance | Returns or sets the negative outer tolerance
OuterTolerance | Returns or sets the outer tolerance
Plane | Returns or sets the plane for measurement direction
PositiveInnerTolerance | Returns or sets the positive inner tolerance
PositiveOuterTolerance | Returns or sets the positive outer tolerance
ReferenceObjects | Returns the reference object
ReportingPerType | Returns or sets the reporting per option
SpatialResolution | Returns or sets the maximum checking angle
SuggestScaleFactor | Returns or sets a value indicating whether to use automatic scale factor
SurfaceRangeControl | Returns the surface range
Tag | Returns the Tag for this object.
TargetObjects | Returns the target object
UseDefiningPoints | Returns or sets a value indicating whether to use defining points.
VectorComponentDirection | Returns or sets the direction vector.
XyzDirection | Returns or sets the xyz direction

# Methods

Method | Description
--- | ---
AddDynamicPoints | Adds dynamic points to the Deviation Gauge.
AddPMILabel | Add a PMI label in specified position to represent the deviation value.
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DeviationGaugeBuilderAdditionalValuesLabelType Enumeration | This enum represents the Deviation Gauge Analysis Object additional values label type
DeviationGaugeBuilderColorPlotTypes Enumeration | This enum represents the Deviation Gauge Analysis Object color plot types
DeviationGaugeBuilderMeasurementMethodType Enumeration | This enum represents the Deviation Gauge Analysis Object evaluation types
DeviationGaugeBuilderMinMaxType Enumeration | This enum represents the Deviation Gauge Analysis Object min max type
DeviationGaugeBuilderReportingPerTypes Enumeration | This enum represents the Deviation Gauge Analysis Object reporting per setting
DeviationGaugeBuilderXyzDirectionType Enumeration | This enum represents the Deviation Gauge Analysis Object X, Y, Z direction options

# Property Detail

## ColorPlotType

`DeviationGaugeBuilder.``ColorPlotType`

  Returns or sets the color plot type

  `-------------------------------------`

  Getter Method

  Signature `ColorPlotType`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.DeviationGaugeBuilderColorPlotTypes`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `ColorPlotType`

  Parameters: | colorPlotType (`NXOpen.GeometricAnalysis.DeviationGaugeBuilderColorPlotTypes`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ConstraintManager

`DeviationGaugeBuilder.``ConstraintManager`

  Returns the constraint manager

  `-------------------------------------`

  Getter Method

  Signature `ConstraintManager`

  Returns: |
  Return type: | `NXOpen.Features.GeometricConstraintDataManager`

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## CurveRangeControl

`DeviationGaugeBuilder.``CurveRangeControl`

  Returns the curve range

  `-------------------------------------`

  Getter Method

  Signature `CurveRangeControl`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.CurveRangeBuilder`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## DeviationIntervals

`DeviationGaugeBuilder.``DeviationIntervals`

  Returns or sets the number of deviation intervals

  `-------------------------------------`

  Getter Method

  Signature `DeviationIntervals`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `DeviationIntervals`

  Parameters: | deviationIntervals (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasAbsoluteColorPlot

`DeviationGaugeBuilder.``HasAbsoluteColorPlot`

  Returns or sets a value indicating whether to plot using absolute value

  `-------------------------------------`

  Getter Method

  Signature `HasAbsoluteColorPlot`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasAbsoluteColorPlot`

  Parameters: | absoluteColorPlot (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasAdditionalValuesLabel

`DeviationGaugeBuilder.``HasAdditionalValuesLabel`

  Returns or sets a value indicating whether to add additional values label

  `-------------------------------------`

  Getter Method

  Signature `HasAdditionalValuesLabel`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.DeviationGaugeBuilderAdditionalValuesLabelType`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasAdditionalValuesLabel`

  Parameters: | additionalValuesLabel (`NXOpen.GeometricAnalysis.DeviationGaugeBuilderAdditionalValuesLabelType`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasCrossCurveDeviationLabel

`DeviationGaugeBuilder.``HasCrossCurveDeviationLabel`

  Returns or sets a value indicating whether to display cross_curve deviation label

  `-------------------------------------`

  Getter Method

  Signature `HasCrossCurveDeviationLabel`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasCrossCurveDeviationLabel`

  Parameters: | crossCurveDeviationLabel (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasInfoLabel

`DeviationGaugeBuilder.``HasInfoLabel`

  Returns or sets a value indicating whether to enable floating info label

  `-------------------------------------`

  Getter Method

  Signature `HasInfoLabel`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasInfoLabel`

  Parameters: | infoLabel (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasInnerToleranceLabel

`DeviationGaugeBuilder.``HasInnerToleranceLabel`

  Returns or sets a value indicating whether to display inner tolerance label

  `-------------------------------------`

  Getter Method

  Signature `HasInnerToleranceLabel`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasInnerToleranceLabel`

  Parameters: | innerToleranceLabel (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasMaximumValueLabel

`DeviationGaugeBuilder.``HasMaximumValueLabel`

  Returns or sets a value indicating whether to display maximum value label

  `-------------------------------------`

  Getter Method

  Signature `HasMaximumValueLabel`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasMaximumValueLabel`

  Parameters: | maximumValueLabel (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## HasMinimumValueLabel

`DeviationGaugeBuilder.``HasMinimumValueLabel`

  Returns or sets a value indicating whether to display minimum value label

  `-------------------------------------`

  Getter Method

  Signature `HasMinimumValueLabel`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `HasMinimumValueLabel`

  Parameters: | minimumValueLabel (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## InnerTolerance

`DeviationGaugeBuilder.``InnerTolerance`

  Returns or sets the inner tolerance

  `-------------------------------------`

  Getter Method

  Signature `InnerTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `InnerTolerance`

  Parameters: | innerTolerance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsColorMapDisplayed

`DeviationGaugeBuilder.``IsColorMapDisplayed`

  Returns or sets a value indicating whether to display color map

  `-------------------------------------`

  Getter Method

  Signature `IsColorMapDisplayed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `IsColorMapDisplayed`

  Parameters: | isColorMapDisplayed (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsDirectionReversed

`DeviationGaugeBuilder.``IsDirectionReversed`

  Returns or sets a value indicating whether to reverse the direction

  `-------------------------------------`

  Getter Method

  Signature `IsDirectionReversed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `IsDirectionReversed`

  Parameters: | reverseDirection (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsLabelDisplayed

`DeviationGaugeBuilder.``IsLabelDisplayed`

  Returns or sets a value indicating whether to display label

  `-------------------------------------`

  Getter Method

  Signature `IsLabelDisplayed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `IsLabelDisplayed`

  Parameters: | labelDisplayed (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsMarkerDisplayed

`DeviationGaugeBuilder.``IsMarkerDisplayed`

  Returns or sets a value indicating whether to display marker

  `-------------------------------------`

  Getter Method

  Signature `IsMarkerDisplayed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `IsMarkerDisplayed`

  Parameters: | isMarkerDisplayed (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## IsNeedlePlotDisplayed

`DeviationGaugeBuilder.``IsNeedlePlotDisplayed`

  Returns or sets a value indicating whether to display needle plot

  `-------------------------------------`

  Getter Method

  Signature `IsNeedlePlotDisplayed`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `IsNeedlePlotDisplayed`

  Parameters: | isNeedlePlotDisplayed (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MaxCheckingAngle

`DeviationGaugeBuilder.``MaxCheckingAngle`

  Returns or sets the maximum checking angle

  `-------------------------------------`

  Getter Method

  Signature `MaxCheckingAngle`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `MaxCheckingAngle`

  Parameters: | maxCheckingAngle (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MaxCheckingDistance

`DeviationGaugeBuilder.``MaxCheckingDistance`

  Returns or sets the maximum checking distance

  `-------------------------------------`

  Getter Method

  Signature `MaxCheckingDistance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `MaxCheckingDistance`

  Parameters: | maxCheckingDistance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MeasurementMethod

`DeviationGaugeBuilder.``MeasurementMethod`

  Returns or sets the measurement method

  `-------------------------------------`

  Getter Method

  Signature `MeasurementMethod`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.DeviationGaugeBuilderMeasurementMethodType`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `MeasurementMethod`

  Parameters: | measurementMethod (`NXOpen.GeometricAnalysis.DeviationGaugeBuilderMeasurementMethodType`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MeasurementSamples

`DeviationGaugeBuilder.``MeasurementSamples`

  Returns or sets the number of measurement samples

  `-------------------------------------`

  Getter Method

  Signature `MeasurementSamples`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `MeasurementSamples`

  Parameters: | measurementSamples (int) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## MinMaxOption

`DeviationGaugeBuilder.``MinMaxOption`

  Returns or sets the min_max type

  `-------------------------------------`

  Getter Method

  Signature `MinMaxOption`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.DeviationGaugeBuilderMinMaxType`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `MinMaxOption`

  Parameters: | minMax (`NXOpen.GeometricAnalysis.DeviationGaugeBuilderMinMaxType`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## NeedleScale

`DeviationGaugeBuilder.``NeedleScale`

  Returns or sets the needle scale

  `-------------------------------------`

  Getter Method

  Signature `NeedleScale`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `NeedleScale`

  Parameters: | needleScale (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## NegativeInnerTolerance

`DeviationGaugeBuilder.``NegativeInnerTolerance`

  Returns or sets the negative inner tolerance

  `-------------------------------------`

  Getter Method

  Signature `NegativeInnerTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `NegativeInnerTolerance`

  Parameters: | negativennerTolerance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## NegativeOuterTolerance

`DeviationGaugeBuilder.``NegativeOuterTolerance`

  Returns or sets the negative outer tolerance

  `-------------------------------------`

  Getter Method

  Signature `NegativeOuterTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `NegativeOuterTolerance`

  Parameters: | negativeOuterTolerance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## OuterTolerance

`DeviationGaugeBuilder.``OuterTolerance`

  Returns or sets the outer tolerance

  `-------------------------------------`

  Getter Method

  Signature `OuterTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `OuterTolerance`

  Parameters: | outerTolerance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## Plane

`DeviationGaugeBuilder.``Plane`

  Returns or sets the plane for measurement direction

  `-------------------------------------`

  Getter Method

  Signature `Plane`

  Returns: |
  Return type: | `NXOpen.Plane`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `Plane`

  Parameters: | plane (`NXOpen.Plane`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PositiveInnerTolerance

`DeviationGaugeBuilder.``PositiveInnerTolerance`

  Returns or sets the positive inner tolerance

  `-------------------------------------`

  Getter Method

  Signature `PositiveInnerTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `PositiveInnerTolerance`

  Parameters: | positiveInnerTolerance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## PositiveOuterTolerance

`DeviationGaugeBuilder.``PositiveOuterTolerance`

  Returns or sets the positive outer tolerance

  `-------------------------------------`

  Getter Method

  Signature `PositiveOuterTolerance`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `PositiveOuterTolerance`

  Parameters: | positiveOuterTolerance (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ReferenceObjects

`DeviationGaugeBuilder.``ReferenceObjects`

  Returns the reference object

  `-------------------------------------`

  Getter Method

  Signature `ReferenceObjects`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## ReportingPerType

`DeviationGaugeBuilder.``ReportingPerType`

  Returns or sets the reporting per option

  `-------------------------------------`

  Getter Method

  Signature `ReportingPerType`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.DeviationGaugeBuilderReportingPerTypes`

  New in version NX8.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `ReportingPerType`

  Parameters: | reportingPerType (`NXOpen.GeometricAnalysis.DeviationGaugeBuilderReportingPerTypes`) –

  New in version NX8.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## SpatialResolution

`DeviationGaugeBuilder.``SpatialResolution`

  Returns or sets the maximum checking angle

  `-------------------------------------`

  Getter Method

  Signature `SpatialResolution`

  Returns: |
  Return type: | float

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `SpatialResolution`

  Parameters: | spatialResolution (float) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## SuggestScaleFactor

`DeviationGaugeBuilder.``SuggestScaleFactor`

  Returns or sets a value indicating whether to use automatic scale factor

  `-------------------------------------`

  Getter Method

  Signature `SuggestScaleFactor`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `SuggestScaleFactor`

  Parameters: | suggestScaleFactor (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## SurfaceRangeControl

`DeviationGaugeBuilder.``SurfaceRangeControl`

  Returns the surface range

  `-------------------------------------`

  Getter Method

  Signature `SurfaceRangeControl`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.SurfaceRangeBuilder`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## TargetObjects

`DeviationGaugeBuilder.``TargetObjects`

  Returns the target object

  `-------------------------------------`

  Getter Method

  Signature `TargetObjects`

  Returns: |
  Return type: | `NXOpen.SelectNXObjectList`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## UseDefiningPoints

`DeviationGaugeBuilder.``UseDefiningPoints`

  Returns or sets a value indicating whether to use defining points.

  Available only if target is curve with defining points

  `-------------------------------------`

  Getter Method

  Signature `UseDefiningPoints`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `UseDefiningPoints`

  Parameters: | useDefiningPoints (bool) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## VectorComponentDirection

`DeviationGaugeBuilder.``VectorComponentDirection`

  Returns or sets the direction vector.

  Not used if the measurement method is ThreeDim or Plane

  `-------------------------------------`

  Getter Method

  Signature `VectorComponentDirection`

  Returns: |
  Return type: | `NXOpen.Direction`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `VectorComponentDirection`

  Parameters: | vectorComponentDirection (`NXOpen.Direction`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## XyzDirection

`DeviationGaugeBuilder.``XyzDirection`

  Returns or sets the xyz direction

  `-------------------------------------`

  Getter Method

  Signature `XyzDirection`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.DeviationGaugeBuilderXyzDirectionType`

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

  `-------------------------------------`

  Setter Method

  Signature `XyzDirection`

  Parameters: | xyzDirection (`NXOpen.GeometricAnalysis.DeviationGaugeBuilderXyzDirectionType`) –

  New in version NX6.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

# Method Detail

## AddDynamicPoints

`DeviationGaugeBuilder.``AddDynamicPoints`

  Adds dynamic points to the Deviation Gauge.

  Signature `AddDynamicPoints()`

  New in version NX7.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## AddPMILabel

`DeviationGaugeBuilder.``AddPMILabel`

  Add a PMI label in specified position to represent the deviation value.

  Signature `AddPMILabel(snappedObject)`

  Parameters: | snappedObject (`NXOpen.NXObject`) – The face or curve which the PMI label pointed to.

  New in version NX9.0.0.

  License requirements: studio_free_form (“STUDIO FREE FORM”)

## Validate

`DeviationGaugeBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.