Represents a NXOpen.Display.LightBuilder More...

Inheritance diagram for NXOpen.Display.LightBuilder:

Public Types
enum	LightMode { FixedToObserver, FixedToThePart }
	light_mode More...

enum	ShadowType { None, SoftEdged, HardEdged, TranslucentHard }
	shadow types More...

Properties
unsafe double	ConeAngle `[get, set]`
	Returns or sets the cone angle - only applicable to spot light types More...

unsafe NXOpen.Point	DestinationPosition `[get, set]`
	Returns or sets the destination position - only applicable to spot light types More...

unsafe double	Intensity `[get, set]`
	Returns or sets the brightness intensity for a given light More...

unsafe NXOpen.Display.LightBuilder.ShadowType	LightShadowType `[get, set]`
	Returns or sets the light shadow type - not applicable to ambient or eye light types More...

unsafe NXOpen.LightType	LightType `[get, set]`
	Returns or sets the light type for a particular light More...

unsafe NXOpen.Point	SourcePosition `[get, set]`
	Returns or sets the source position - only applicable to spot and point light types More...

unsafe bool	UseWithAdvancedStudioImageBasedLighting `[get, set]`
	Returns or sets the flag to indicate whether the given light is to be used with image based lighting in the advanced studio display. More...

unsafe bool	UseWithIbl `[get, set]`
	Returns or sets the use_with_ibl flag for a given light More...

unsafe bool	UseWithRayTracedImageBasedLighting `[get, set]`
	Returns or sets the flag to indicate whether the given light is to be used with image based lighting in ray traced rendering. 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
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...

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

Detailed Description

Represents a NXOpen.Display.LightBuilder

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.CreateLightBuilder

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.Display.LightBuilder.LightMode

light_mode

Enumerator
FixedToObserver
FixedToThePart

enum NXOpen.Display.LightBuilder.ShadowType

shadow types

Enumerator
None	No shadows will be produced.
SoftEdged	Soft-edged,approximated shadows will be generated using a shadow mapping algorithm.
HardEdged	Hard-edged, precise shadows will be generated using a ray-tracing algorithm.
TranslucentHard	Hard-edged, precise shadows will be generated using a ray-tracing algorithm. Shadows from translucent objects will also be generated and their color will be determined by the transparent object's color.

Property Documentation

unsafe double NXOpen.Display.LightBuilder.ConeAngle

getset

Returns or sets the cone angle - only applicable to spot light types

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.LightBuilder.DestinationPosition

getset

Returns or sets the destination position - only applicable to spot light types

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.LightBuilder.Intensity

getset

Returns or sets the brightness intensity for a given light

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.LightBuilder.ShadowType NXOpen.Display.LightBuilder.LightShadowType

getset

Returns or sets the light shadow type - not applicable to ambient or eye light types

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.LightType NXOpen.Display.LightBuilder.LightType

getset

Returns or sets the light type for a particular light

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Point NXOpen.Display.LightBuilder.SourcePosition

getset

Returns or sets the source position - only applicable to spot and point light types

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.LightBuilder.UseWithAdvancedStudioImageBasedLighting

getset

Returns or sets the flag to indicate whether the given light is to be used with image based lighting in the advanced studio display.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.LightBuilder.UseWithIbl

getset

Returns or sets the use_with_ibl flag for a given light

Created in NX5.0.0

Deprecated in NX10.0.0. This funcationality is no longer supported.

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.LightBuilder.UseWithRayTracedImageBasedLighting

getset

Returns or sets the flag to indicate whether the given light is to be used with image based lighting in ray traced rendering.

Created in NX10.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_LightBuilder.cs

Public Types

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Property Documentation