ScaleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ScaleBuilder Class

class `NXOpen.Features.``ScaleBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.Scale` builder.

  Inputs to this class can be convergent objects.

  To create a new instance of this class, use `NXOpen.Features.FeatureCollection.CreateScaleBuilder()`

  Default values.

  Property | Value
  --- | ---
  ScaleAlongAxis.Value | 1.0
  ScaleOtherDirection.Value | 1.0
  ScaleXdirection.Value | 1.0
  ScaleYdirection.Value | 1.0
  ScaleZdirection.Value | 1.0
  UniformFactor.Value | 1.0

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
BodyCollector | Returns or sets the collector as `NXOpen.ScCollector`
BodyToScale | Returns the bodyToScale
Csys | Returns or sets the csys as `NXOpen.CoordinateSystem`
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
Point | Returns or sets the point as `NXOpen.Point`
ScaleAlongAxis | Returns the scale along axis
ScaleOtherDirection | Returns the scale other direction
ScaleXdirection | Returns the scale xdirection
ScaleYdirection | Returns the scale ydirection
ScaleZdirection | Returns the scale zdirection
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
Type | Returns or sets the scale type `NXOpen.Features.ScaleBuilderTypes`
UniformFactor | Returns the uniform factor
Vector | Returns or sets the vector as `NXOpen.Direction`

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ScaleBuilderTypes Enumeration | Scale type

# Property Detail

## BodyCollector

`ScaleBuilder.``BodyCollector`

  Returns or sets the collector as `NXOpen.ScCollector`

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

  Getter Method

  Signature `BodyCollector`

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

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `BodyCollector`

  Parameters: | scaleBody (`NXOpen.ScCollector`) –

  New in version NX11.0.1.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## BodyToScale

`ScaleBuilder.``BodyToScale`

  Returns the bodyToScale

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

  Getter Method

  Signature `BodyToScale`

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

  New in version NX5.0.0.

  License requirements: None.

## Csys

`ScaleBuilder.``Csys`

  Returns or sets the csys as `NXOpen.CoordinateSystem`

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

  Getter Method

  Signature `Csys`

  Returns: | Returns the reference Co-ordinate system from which scaling has to be done
  Return type: | `NXOpen.CoordinateSystem`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Csys`

  Parameters: | csys (`NXOpen.CoordinateSystem`) – Set the reference Co-ordinate system from which scaling has to be done

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Point

`ScaleBuilder.``Point`

  Returns or sets the point as `NXOpen.Point`

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

  Getter Method

  Signature `Point`

  Returns: | Returns the referance point from which scaling has to be done
  Return type: | `NXOpen.Point`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Point`

  Parameters: | point (`NXOpen.Point`) – Set the referance point from which scaling has to be done

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## ScaleAlongAxis

`ScaleBuilder.``ScaleAlongAxis`

  Returns the scale along axis

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

  Getter Method

  Signature `ScaleAlongAxis`

  Returns: | Scale factor along axis
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## ScaleOtherDirection

`ScaleBuilder.``ScaleOtherDirection`

  Returns the scale other direction

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

  Getter Method

  Signature `ScaleOtherDirection`

  Returns: | Scale factor along other direction
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## ScaleXdirection

`ScaleBuilder.``ScaleXdirection`

  Returns the scale xdirection

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

  Getter Method

  Signature `ScaleXdirection`

  Returns: | Scale factor along X Direction
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## ScaleYdirection

`ScaleBuilder.``ScaleYdirection`

  Returns the scale ydirection

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

  Getter Method

  Signature `ScaleYdirection`

  Returns: | Scale factor along Y Direction
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## ScaleZdirection

`ScaleBuilder.``ScaleZdirection`

  Returns the scale zdirection

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

  Getter Method

  Signature `ScaleZdirection`

  Returns: | Scale factor along Z Direction
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## Type

`ScaleBuilder.``Type`

  Returns or sets the scale type `NXOpen.Features.ScaleBuilderTypes`

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

  Getter Method

  Signature `Type`

  Returns: | Returns the type of the scale method
  Return type: | `NXOpen.Features.ScaleBuilderTypes`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Features.ScaleBuilderTypes`) – Gets the type of the scale method

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## UniformFactor

`ScaleBuilder.``UniformFactor`

  Returns the uniform factor

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

  Getter Method

  Signature `UniformFactor`

  Returns: | Uniform Scale factor
  Return type: | `NXOpen.Expression`

  New in version NX5.0.0.

  License requirements: None.

## Vector

`ScaleBuilder.``Vector`

  Returns or sets the vector as `NXOpen.Direction`

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

  Getter Method

  Signature `Vector`

  Returns: | Returns the reference Axis along which scaling has to be done
  Return type: | `NXOpen.Direction`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Vector`

  Parameters: | vector (`NXOpen.Direction`) – Set the reference Axis along which scaling has to be done

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

# Method Detail

## Validate

`ScaleBuilder.``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.