Reflection Class — NXOpen Python API Reference 12.0.0 documentation

# Reflection Class

class `NXOpen.Display.``Reflection`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Display.Reflection` Reflection defines the source of reflection in shiny objects for Studio rendering style or High Quality Images.

  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.CreateReflection()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
Image | Returns or sets the reflections’s image builder
ImageFilename | Returns or sets the reflection’s image filename
ReflectionMap | Returns or sets the reflection type
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.
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

ReflectionType Enumeration | where the reflections for rendering will be obtained

# Property Detail

## Image

`Reflection.``Image`

  Returns or sets the reflections’s image builder

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

  Getter Method

  Signature `Image`

  Returns: |
  Return type: | `NXOpen.Display.Image`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Image`

  Parameters: | imageBuilder (`NXOpen.Display.Image`) –

  New in version NX5.0.0.

  License requirements: None.

## ImageFilename

`Reflection.``ImageFilename`

  Returns or sets the reflection’s image filename

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

  Getter Method

  Signature `ImageFilename`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ImageFilename`

  Parameters: | imageFileName (str) –

  New in version NX5.0.0.

  License requirements: None.

## ReflectionMap

`Reflection.``ReflectionMap`

  Returns or sets the reflection type

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

  Getter Method

  Signature `ReflectionMap`

  Returns: |
  Return type: | `NXOpen.Display.ReflectionType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ReflectionMap`

  Parameters: | reflectionMap (`NXOpen.Display.ReflectionType`) –

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## Validate

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