Represents a NXOpen.Display.ImageBasedLighting Image-based Lighting (IBL) is only performed in High Quality Image renderings. More...

Inheritance diagram for NXOpen.Display.ImageBasedLighting:

Public Types
enum	ImageBlurType { None, Low, Medium, High }
	lighting image blurr type More...

enum	ImagesType { Background, Stage, UserDefined, LightingOnly }
	images type - environment used for generating image-based lighting More...

enum	ImageUpVectorTypes { AlignWithFloorPlane, UserDefined }
	up vector type More...

enum	ShadowsType { None, SoftEdged, HardEdged, TranslucentHard }
	shadow type More...

Public Member Functions
unsafe void	CommitAndDisplay (NXOpen.View view, bool updateDisplay)
	Saves the attributes and optionally updates the display of image-based lighting 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 double	Accuracy `[get, set]`
	Returns or sets the accuracy of the lighting and shadows produced from the given image More...

unsafe double	ColorSaturation `[get, set]`
	Returns or sets the image-based lighting color saturation More...

unsafe NXOpen.Display.Image	Image `[get, set]`
	Returns or sets the image-based lighting's image builder More...

unsafe NXOpen.Display.ImageBasedLighting.ImageBlurType	ImageBlur `[get, set]`
	Returns or sets the blurr of the lighting image More...

unsafe string	ImageFilename `[get, set]`
	Returns or sets the image filename used for image-based lighting More...

unsafe double	ImageRotation `[get, set]`
	Returns or sets the image rotation angle (in degrees) More...

unsafe NXOpen.Display.ImageBasedLighting.ImagesType	ImageType `[get, set]`
	Returns or sets the image type More...

unsafe NXOpen.Direction	ImageUpVector `[get, set]`
	Returns or sets the image up vector direction, relative to the absolute coordinate system More...

unsafe NXOpen.Display.ImageBasedLighting.ImageUpVectorTypes	ImageUpVectorType `[get, set]`
	Returns or sets the image up vector define More...

unsafe double	Intensity `[get, set]`
	Returns or sets the intensity of the image-based lighting light effects More...

unsafe double	LwrtAngle `[get, set]`
	Returns or sets the angle of the lwrt image-based lighting light effects More...

unsafe double	LwrtIntensity `[get, set]`
	Returns or sets the intensity of the lwrt image-based lighting light effects More...

unsafe double	LwrtQuality `[get, set]`
	Returns or sets the quality of the lwrt image-based lighting light effects 1 to 7 More...

unsafe double	ShadowSoftness `[get, set]`
	Returns or sets the image-based lighting shadow softness More...

unsafe NXOpen.Display.ImageBasedLighting.ShadowsType	ShadowType `[get, set]`
	Returns or sets the shadow type More...

unsafe bool	UseImageBasedLighting `[get, set]`
	Returns or sets whether image-based lighting (IBL) is enabled More...

unsafe bool	UseLightsForShadowCatcherInHqi `[get, set]`
	Returns or sets whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher More...

unsafe bool	UseLightsForShadowCatcherInLwrt `[get, set]`
	Returns or sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher More...

unsafe bool	UseLwrtImageBasedLighting `[get, set]`
	Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display 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.ImageBasedLighting Image-based Lighting (IBL) is only performed in High Quality Image renderings.

IBL replaces the Lights in a scene with lighting effects derived from a given image.

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

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.Display.ImageBasedLighting.ImageBlurType

lighting image blurr type

Enumerator
None
Low
Medium
High

enum NXOpen.Display.ImageBasedLighting.ImagesType

images type - environment used for generating image-based lighting

Enumerator
Background	Use the background image.
Stage	Use the stage.
UserDefined	Use the image file specified.
LightingOnly	only used for IBL

enum NXOpen.Display.ImageBasedLighting.ImageUpVectorTypes

up vector type

Enumerator
AlignWithFloorPlane
UserDefined

enum NXOpen.Display.ImageBasedLighting.ShadowsType

shadow type

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.

Member Function Documentation

unsafe void NXOpen.Display.ImageBasedLighting.CommitAndDisplay	(	NXOpen.View	view,
		bool	updateDisplay
	)

inline

Saves the attributes and optionally updates the display of image-based lighting

Created in NX5.0.0

License requirements: None.

Parameters

view	View of the image-based lighting attributes
updateDisplay	True if the display should be updated

Property Documentation

unsafe double NXOpen.Display.ImageBasedLighting.Accuracy

getset

Returns or sets the accuracy of the lighting and shadows produced from the given image

Created in NX5.0.0