nxopen

Interface LightCollection

All Superinterfaces:

Remote, TaggedObjectCollection

public interface LightCollection
extends TaggedObjectCollection

Represents a collection of Light s.
To obtain an instance of this class, refer to BasePart

Created in NX4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface nxopen.TaggedObjectCollection

TaggedObjectCollection.Iterator

Method Summary

Modifier and Type	Method and Description
Light	findObject(String journalIdentifier) Finds the Light with the given identifier as recorded in a journal.
void	setLightIntensities(Light[] lights, double[] intensities) Modifies the intensities of a set of lights.

Methods inherited from interface nxopen.TaggedObjectCollection

_find_next, iterator

Method Detail

findObject

Light findObject(String journalIdentifier)
          throws NXException,
                 RemoteException

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.
License requirements: None.

Created in NX4.0.0

Parameters:

journalIdentifier - Identifier of the Light to be found

Returns:

Light with this identifier

Throws:

NXException

RemoteException

setLightIntensities

void setLightIntensities(Light[] lights,
                         double[] intensities)
                  throws NXException,
                         RemoteException

Modifies the intensities of a set of lights. This is generally preferable to multiple consecutive invocations of Light.setIntensity(double) , as with this method the graphics screen is only updated once, while for Light.setIntensity(double) it would be updated once per call.
License requirements: None.

Created in NX4.0.0

Parameters:

lights -

intensities -

Throws:

NXException

RemoteException