Represents a Display::Lighting Lights are used to illuminate the scene in Shaded and Studio rendering styles, as well as in High Quality Images. More...
Public Member Functions | |
| NXOpen::Display::LightBuilder * | GetLightBuilderFromList (int index) |
| Returns a light builder, given by the index, in the array of lights assigned to the work view. | |
| int | GetNumLightBuilders () |
| Returns the total number of light builders in the given lighting list. | |
| void | SetLightBuilderInList (int index, NXOpen::Display::LightBuilder *light) |
| Sets a light builder in the array at the given index Created in NX5.0.0. | |
 Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
Represents a Display::Lighting Lights are used to illuminate the scene in Shaded and Studio rendering styles, as well as in High Quality Images.
<br> 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 ViewCollection::CreateLighting
Created in NX5.0.0.
Member Function Documentation
| NXOpen::Display::LightBuilder* NXOpen::Display::Lighting::GetLightBuilderFromList | ( | int | index | ) |
Returns a light builder, given by the index, in the array of lights assigned to the work view.
- Returns
- the light builder
Created in NX5.0.0.
License requirements : None
- Parameters
-
index index to the array of light builders
| int NXOpen::Display::Lighting::GetNumLightBuilders | ( | ) |
Returns the total number of light builders in the given lighting list.
- Returns
- total lights in the light builder array
Created in NX5.0.0.
License requirements : None
| void NXOpen::Display::Lighting::SetLightBuilderInList | ( | int | index, |
| NXOpen::Display::LightBuilder * | light | ||
| ) |
Sets a light builder in the array at the given index
Created in NX5.0.0.
License requirements : None
- Parameters
-
index index to the array of light builders light the light builder
The documentation for this class was generated from the following file:
- Display_Lighting.hxx