Represents a collection of Light s. More...
Classes | |
| class | iterator |
| Iterator for accessing the contents of the collection. More... | |
Public Member Functions | |
| iterator | begin () |
| Returns an iterator addressing the first element. | |
| iterator | end () |
| Returns an iterator addressing one past the last element. | |
| NXOpen::Light * | FindObject (const NXString &journalIdentifier) |
| Finds the Light with the given identifier as recorded in a journal. | |
| NXOpen::Light * | FindObject (const char *journalIdentifier) |
| Finds the Light with the given identifier as recorded in a journal. | |
| void | SetLightIntensities (const std::vector< NXOpen::Light * > &lights, const std::vector< double > &intensities) |
| Modifies the intensities of a set of lights. | |
| tag_t | Tag () const |
| Returns the tag of this object. | |
Detailed Description
Represents a collection of Light s.
To obtain an instance of this class, refer to BasePart
Created in NX4.0.0.
Member Function Documentation
| iterator NXOpen::LightCollection::begin | ( | ) |
Returns an iterator addressing the first element.
| iterator NXOpen::LightCollection::end | ( | ) |
Returns an iterator addressing one past the last element.
| NXOpen::Light* NXOpen::LightCollection::FindObject | ( | const NXString & | journalIdentifier | ) |
Finds the Light with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However, newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
- Returns
- Light with this identifier
Created in NX4.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier of the Light to be found
| NXOpen::Light* NXOpen::LightCollection::FindObject | ( | const char * | journalIdentifier | ) |
Finds the Light with the given identifier as recorded in a journal.
An object may not return the same value as its JournalIdentifier in different versions of the software. However, newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
- Returns
- Light with this identifier
Created in NX4.0.0.
License requirements : None
- Parameters
-
journalIdentifier Identifier of the Light to be found
| void NXOpen::LightCollection::SetLightIntensities | ( | const std::vector< NXOpen::Light * > & | lights, |
| const std::vector< double > & | intensities | ||
| ) |
Modifies the intensities of a set of lights.
This is generally preferable to multiple consecutive invocations of Light::SetIntensity , as with this method the graphics screen is only updated once, while for Light::SetIntensity it would be updated once per call.
Created in NX4.0.0.
License requirements : None
- Parameters
-
lights lights intensities intensities
| tag_t NXOpen::LightCollection::Tag | ( | ) | const |
Returns the tag of this object.
The documentation for this class was generated from the following file:
- LightCollection.hxx