ExtractScene Class — NXOpen Python API Reference 12.0.0 documentation

# ExtractScene Class

class `NXOpen.Display.``ExtractScene`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.ExtractScene`

  This class is restricted to being called from a program running during an Interactive NX session. If run from a non-interactive session it will return None.

  To create a new instance of this class, use `NXOpen.ViewCollection.CreateExtractScene()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
SceneName | Returns or sets the scene name
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
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.
GetSceneDescription | Returns the scene description
ImageFileSelect | Gets an image file using file selection.
Information | The scene information
SetSceneDescription | Sets the scene description
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.

# Property Detail

## SceneName

`ExtractScene.``SceneName`

  Returns or sets the scene name

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

  Getter Method

  Signature `SceneName`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SceneName`

  Parameters: | sceneName (str) –

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## GetSceneDescription

`ExtractScene.``GetSceneDescription`

  Returns the scene description

  Signature `GetSceneDescription()`

  Returns: |
  Return type: | list of str

  New in version NX5.0.0.

  License requirements: None.

## ImageFileSelect

`ExtractScene.``ImageFileSelect`

  Gets an image file using file selection.

  Signature `ImageFileSelect()`

  New in version NX5.0.0.

  License requirements: None.

## Information

`ExtractScene.``Information`

  The scene information

  Signature `Information()`

  New in version NX5.0.0.

  License requirements: None.

## SetSceneDescription

`ExtractScene.``SetSceneDescription`

  Sets the scene description

  Signature `SetSceneDescription(sceneDescription)`

  Parameters: | sceneDescription (list of str) –

  New in version NX5.0.0.

  License requirements: None.

## Validate

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