LightCollection Class

class NXOpen.LightCollection

Bases: object

Represents a collection of :py:class:`NXOpen.Light`s.

To obtain an instance of this class, refer to NXOpen.BasePart

New in version NX4.0.0.

Methods

Method	Description
FindObject	Finds the NXOpen.Light with the given identifier as recorded in a journal.
SetLightIntensities	Modifies the intensities of a set of lights.

Method Detail

FindObject

LightCollection.FindObject

Finds the NXOpen.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.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Identifier of the Light to be found Returns:Light with this identifier Return type:NXOpen.Light

New in version NX4.0.0.

License requirements: None.

SetLightIntensities

LightCollection.SetLightIntensities

Modifies the intensities of a set of lights.

This is generally preferable to multiple consecutive invocations of NXOpen.Light.Intensity(), as with this method the graphics screen is only updated once, while for NXOpen.Light.Intensity() it would be updated once per call.

Signature SetLightIntensities(lights, intensities)

Parameters:

• lights (list of NXOpen.Light) –
• intensities (list of float) –

New in version NX4.0.0.

License requirements: None.