NXOpen.Display.Lighting Class Reference

Represents a NXOpen.Display.Lighting Lights are used to illuminate the scene in Shaded and Studio rendering styles, as well as in High Quality Images. More...

Inheritance diagram for NXOpen.Display.Lighting:

Public Types
enum	LightingCollectionType {   Lighting1, Lighting2, Lighting3, Lighting4,   Lighting5, UserDefined }
	lighting collection mode in Shaded Views More...

Public Member Functions
unsafe NXOpen.Display.LightBuilder	GetLightBuilderFromList (int index)
	Returns a light builder, given by the index, in the array of lights assigned to the work view More...
unsafe int	GetNumLightBuilders ()
	Returns the total number of light builders in the given lighting list More...
unsafe void	RemoveLightBuilderInList (string lightName)
	Removes a light builder by light name More...
unsafe void	SetLightBuilderInList (int index, NXOpen.Display.LightBuilder light)
	Sets a light builder in the array at the given index More...
unsafe void	SetLightBuilderInList (string lightName, double lightIntensity)
	Sets a light builder in the array at the given light name and intensity More...
Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...
unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...
unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...
void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...
override string	ToString ()
	Returns a String that represents the current Object. More...
Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...
IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Display.Lighting.LightingCollectionType	LightsShadedViewsLightingCollection [get, set]
	Returns or sets the Shaded Views lighting collection More...
unsafe double	LightsShadedViewsSceneDimmerValue [get, set]
	Returns or sets the scene dimmer value More...
Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder [get]
	Returns the preview builder subobject. More...
Properties inherited from NXOpen.TaggedObject
Tag	Tag [get]
	Returns the tag of this object. More...
Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink [get]
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.Display.Lighting Lights are used to illuminate the scene in Shaded and Studio rendering styles, as well as in High Quality Images.

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 a null reference (Nothing in Visual Basic).

To create a new instance of this class, use NXOpen.ViewCollection.CreateLighting

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.Display.Lighting.LightingCollectionType

lighting collection mode in Shaded Views

Enumerator
Lighting1
Lighting2
Lighting3
Lighting4
Lighting5
UserDefined

Member Function Documentation

unsafe NXOpen.Display.LightBuilder NXOpen.Display.Lighting.GetLightBuilderFromList ( int  index )

inline

Returns a light builder, given by the index, in the array of lights assigned to the work view

Created in NX5.0.0

License requirements: None.

Parameters

index

index to the array of light builders

Returns

the light builder

unsafe int NXOpen.Display.Lighting.GetNumLightBuilders ( )

inline

Returns the total number of light builders in the given lighting list

Created in NX5.0.0

License requirements: None.

Returns

total lights in the light builder array

unsafe void NXOpen.Display.Lighting.RemoveLightBuilderInList ( string  lightName )

inline

Removes a light builder by light name

Created in NX1899.0.0

License requirements: None.

Parameters

lightName

unsafe void NXOpen.Display.Lighting.SetLightBuilderInList ( int  index, NXOpen.Display.LightBuilder  light  )

inline

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

unsafe void NXOpen.Display.Lighting.SetLightBuilderInList ( string  lightName, double  lightIntensity  )

inline

Sets a light builder in the array at the given light name and intensity

Created in NX1899.0.0

License requirements: None.

Parameters

lightName
lightIntensity

Property Documentation

unsafe NXOpen.Display.Lighting.LightingCollectionType NXOpen.Display.Lighting.LightsShadedViewsLightingCollection

getset

Returns or sets the Shaded Views lighting collection

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.Lighting.LightsShadedViewsSceneDimmerValue

getset

Returns or sets the scene dimmer value

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

---

The documentation for this class was generated from the following file:

• Display_Lighting.cs