Scene Class¶
-
class
NXOpen.Display.Scene¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.SceneA scene is comprised of background, stage, reflection, lights and image-based lighting subobjects.You optionally specify a scene for display in Studio rendering style and 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.CreateScene()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Background | Returns the background - use to define how background pixels are displayed |
| EnvironmentBuilder | Returns the environment_builder - use to define the environment |
| ImageBasedLighting | Returns the image-based lighting - optionally use to by-pass lights with image-based lighting, where lighting effects are derived from a given image file |
| Lighting | Returns the lights - use to define light settings for the given lights |
| Reflection | Returns the reflection - use to define what will be reflected in shiny objects |
| Stage | Returns the stage - use to optionally define a box that can have between one and six visible walls |
| 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. |
Property Detail¶
Background¶
-
Scene.Background¶ Returns the background - use to define how background pixels are displayed
-------------------------------------Getter Method
Signature
BackgroundReturns: Return type: NXOpen.Display.BackgroundNew in version NX5.0.0.
License requirements: None.
EnvironmentBuilder¶
-
Scene.EnvironmentBuilder¶ Returns the environment_builder - use to define the environment
-------------------------------------Getter Method
Signature
EnvironmentBuilderReturns: Return type: NXOpen.Display.EnvironmentBuilderNew in version NX10.0.2.
License requirements: None.
ImageBasedLighting¶
-
Scene.ImageBasedLighting¶ Returns the image-based lighting - optionally use to by-pass lights with image-based lighting, where lighting effects are derived from a given image file
-------------------------------------Getter Method
Signature
ImageBasedLightingReturns: Return type: NXOpen.Display.ImageBasedLightingNew in version NX5.0.0.
License requirements: None.
Lighting¶
-
Scene.Lighting¶ Returns the lights - use to define light settings for the given lights
-------------------------------------Getter Method
Signature
LightingReturns: Return type: NXOpen.Display.LightingNew in version NX5.0.0.
License requirements: None.
Reflection¶
-
Scene.Reflection¶ Returns the reflection - use to define what will be reflected in shiny objects
-------------------------------------Getter Method
Signature
ReflectionReturns: Return type: NXOpen.Display.ReflectionNew in version NX5.0.0.
License requirements: None.
Stage¶
-
Scene.Stage¶ Returns the stage - use to optionally define a box that can have between one and six visible “walls”
-------------------------------------Getter Method
Signature
StageReturns: Return type: NXOpen.Display.StageNew in version NX5.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
Scene.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.