ConvertToFromReferenceBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ConvertToFromReferenceBuilder Class

class `NXOpen.``ConvertToFromReferenceBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.ConvertToFromReferenceBuilder`

  To create a new instance of this class, use `NXOpen.SketchCollection.CreateConvertToFromReferenceBuilder()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
InputObjects | Returns the input objects.
OutputState | Returns or sets the output type.
SelectAllProjectFeatureCurves | Returns or sets the projected curve flag.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
AddProjectFeatureCurves | Adds all output entities belonging to the project feature that contains the input tag to the input objects list of the command.
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.
RemoveProjectFeatureCurves | Removes all output entities belonging to the project feature that contains the input tag from the input objects list of the command.
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

ConvertToFromReferenceBuilderOutputType Enumeration | Represents the output type.

# Property Detail

## InputObjects

`ConvertToFromReferenceBuilder.``InputObjects`

  Returns the input objects.

  The input objects must belong to the active sketch. Only curves and dimensions can be added to this list.

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

  Getter Method

  Signature `InputObjects`

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

  New in version NX5.0.0.

  License requirements: None.

## OutputState

`ConvertToFromReferenceBuilder.``OutputState`

  Returns or sets the output type.

  If the output type is set to Active, all the selected curves and dimensions will get their reference status as active and if the output type is set to reference, they will get their reference status as reference.

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

  Getter Method

  Signature `OutputState`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputState`

  Parameters: | outputState (`NXOpen.ConvertToFromReferenceBuilderOutputType`) –

  New in version NX5.0.0.

  License requirements: None.

## SelectAllProjectFeatureCurves

`ConvertToFromReferenceBuilder.``SelectAllProjectFeatureCurves`

  Returns or sets the projected curve flag.

  If this flag is ON and if at least one of the output curves of a sketch project feature are selected, all output curves of the sketch project feature will be selected.

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

  Getter Method

  Signature `SelectAllProjectFeatureCurves`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectAllProjectFeatureCurves`

  Parameters: | selectAllProjectFeatureCurves (bool) –

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## AddProjectFeatureCurves

`ConvertToFromReferenceBuilder.``AddProjectFeatureCurves`

  Adds all output entities belonging to the project feature that contains the input tag to the input objects list of the command.

  The SelectAllProjectFeatureCurves flag must be set to true before this function is called.

  Signature `AddProjectFeatureCurves(entity)`

  Parameters: | entity (`NXOpen.Curve`) – The input curve tag.

  New in version NX5.0.0.

  License requirements: None.

## RemoveProjectFeatureCurves

`ConvertToFromReferenceBuilder.``RemoveProjectFeatureCurves`

  Removes all output entities belonging to the project feature that contains the input tag from the input objects list of the command.

  The SelectAllProjectFeatureCurves flag must be set to true before this function is called.

  Signature `RemoveProjectFeatureCurves(entity)`

  Parameters: | entity (`NXOpen.Curve`) – The input curve tag.

  New in version NX5.0.0.

  License requirements: None.

## Validate

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