NXOpen .NET Reference  12.0.0
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.LightCollection Class Reference

Represents a collection of NXOpen.Light s. More...

Inheritance diagram for NXOpen.LightCollection:

Public Member Functions

NXOpen.Light[] ToArray ()
 Returns an array of NXOpen.Light objects. More...
 
unsafe NXOpen.Light FindObject (string journalIdentifier)
 Finds the NXOpen.Light with the given identifier as recorded in a journal. More...
 
unsafe void SetLightIntensities (NXOpen.Light[] lights, double[] intensities)
 Modifies the intensities of a set of lights. More...
 

Protected Member Functions

override int EnumerateMoveNext (ref Tag currentTag, byte[] state)
 Advances the enumerator to the next element of the collection. More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of NXOpen.Light s.

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

Created in NX4.0.0

Member Function Documentation

override int NXOpen.LightCollection.EnumerateMoveNext ( ref Tag  currentTag,
byte[]  state 
)
protected

Advances the enumerator to the next element of the collection.

unsafe NXOpen.Light NXOpen.LightCollection.FindObject ( string  journalIdentifier)

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.

Created in NX4.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier of the Light to be found
Returns
Light with this identifier
unsafe void NXOpen.LightCollection.SetLightIntensities ( NXOpen.Light[]  lights,
double[]  intensities 
)

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.

Created in NX4.0.0

License requirements: None.

Parameters
lights
intensities
NXOpen.Light [] NXOpen.LightCollection.ToArray ( )

Returns an array of NXOpen.Light objects.

Property Documentation

Tag NXOpen.LightCollection.Tag
get

Returns the tag of this object.


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