NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Display::Scene Class Reference

Represents a NXOpen::Display::Scene A scene is comprised of background, stage, reflection, lights and image-based lighting subobjects. More...

Inheritance diagram for NXOpen::Display::Scene:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXOpen::Display::BackgroundBackground ()
 Returns the background - use to define how background pixels are displayed
Created in NX5.0.0. More...
 
NXOpen::Display::EnvironmentBuilderEnvironmentBuilder ()
 Returns the environment_builder - use to define the environment
Created in NX10.0.2. More...
 
NXOpen::Display::ImageBasedLightingImageBasedLighting ()
 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
Created in NX5.0.0. More...
 
NXOpen::Display::LightingLighting ()
 Returns the lights - use to define light settings for the given lights
Created in NX5.0.0. More...
 
NXOpen::Display::ReflectionReflection ()
 Returns the reflection - use to define what will be reflected in shiny objects
Created in NX5.0.0. More...
 
NXOpen::Display::StageStage ()
 Returns the stage - use to optionally define a box that can have between one and six visible "walls"
Created in NX5.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Display::Scene A 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 NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateScene

Created in NX5.0.0.

Member Function Documentation

NXOpen::Display::Background* NXOpen::Display::Scene::Background ( )

Returns the background - use to define how background pixels are displayed
Created in NX5.0.0.



License requirements : None

NXOpen::Display::EnvironmentBuilder* NXOpen::Display::Scene::EnvironmentBuilder ( )

Returns the environment_builder - use to define the environment
Created in NX10.0.2.



License requirements : None

NXOpen::Display::ImageBasedLighting* NXOpen::Display::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
Created in NX5.0.0.



License requirements : None

NXOpen::Display::Lighting* NXOpen::Display::Scene::Lighting ( )

Returns the lights - use to define light settings for the given lights
Created in NX5.0.0.



License requirements : None

NXOpen::Display::Reflection* NXOpen::Display::Scene::Reflection ( )

Returns the reflection - use to define what will be reflected in shiny objects
Created in NX5.0.0.



License requirements : None

NXOpen::Display::Stage* NXOpen::Display::Scene::Stage ( )

Returns the stage - use to optionally define a box that can have between one and six visible "walls"
Created in NX5.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.