NXOpen::Display::ImageBasedLighting Class Reference

Represents a 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 { ImageBlurTypeNone, ImageBlurTypeLow, ImageBlurTypeMedium, ImageBlurTypeHigh }
	lighting image blurr type More...
enum	ImagesType { ImagesTypeBackground, ImagesTypeStage, ImagesTypeUserDefined, ImagesTypeLightingOnly }
	images type - environment used for generating image-based lighting More...
enum	ShadowsType { ShadowsTypeNone, ShadowsTypeSoftEdged, ShadowsTypeHardEdged, ShadowsTypeTranslucentHard }
	shadow type More...

Public Member Functions
double	Accuracy ()
	Returns the accuracy of the lighting and shadows produced from the given image Created in NX5.0.0.
double	ColorSaturation ()
	Returns the image-based lighting color saturation Created in NX8.5.0.
void	CommitAndDisplay (NXOpen::View *view, bool updateDisplay)
	Saves the attributes and optionally updates the display of image-based lighting Created in NX5.0.0.
NXOpen::Display::Image *	Image ()
	Returns the image-based lighting's image builder Created in NX5.0.0.
NXOpen::Display::ImageBasedLighting::ImageBlurType	ImageBlur ()
	Returns the blurr of the lighting image Created in NX8.0.0.
NXString	ImageFilename ()
	Returns the image filename used for image-based lighting Created in NX5.0.0.
double	ImageRotation ()
	Returns the image rotation angle (in degrees) Created in NX5.0.0.
NXOpen::Display::ImageBasedLighting::ImagesType	ImageType ()
	Returns the image type Created in NX5.0.0.
NXOpen::Direction *	ImageUpVector ()
	Returns the image up vector direction, relative to the absolute coordinate system Created in NX5.0.0.
double	Intensity ()
	Returns the intensity of the image-based lighting light effects Created in NX5.0.0.
double	LwrtAngle ()
	Returns the angle of the lwrt image-based lighting light effects Created in NX8.0.0.
double	LwrtIntensity ()
	Returns the intensity of the lwrt image-based lighting light effects Created in NX8.0.0.
double	LwrtQuality ()
	Returns the quality of the lwrt image-based lighting light effects 1 to 7 Created in NX8.0.0.
void	SetAccuracy (double accuracy)
	Sets the accuracy of the lighting and shadows produced from the given image Created in NX5.0.0.
void	SetColorSaturation (double colorSaturation)
	Sets the image-based lighting color saturation Created in NX8.5.0.
void	SetImage (NXOpen::Display::Image *imageBuilder)
	Sets the image-based lighting's image builder Created in NX5.0.0.
void	SetImageBlur (NXOpen::Display::ImageBasedLighting::ImageBlurType imageBlurr)
	Sets the blurr of the lighting image Created in NX8.0.0.
void	SetImageFilename (const NXString &imageFileName)
	Sets the image filename used for image-based lighting Created in NX5.0.0.
void	SetImageFilename (const char *imageFileName)
	Sets the image filename used for image-based lighting Created in NX5.0.0.
void	SetImageRotation (double imageRotation)
	Sets the image rotation angle (in degrees) Created in NX5.0.0.
void	SetImageType (NXOpen::Display::ImageBasedLighting::ImagesType imageType)
	Sets the image type Created in NX5.0.0.
void	SetImageUpVector (NXOpen::Direction *imageUpVector)
	Sets the image up vector direction, relative to the absolute coordinate system Created in NX5.0.0.
void	SetIntensity (double intensity)
	Sets the intensity of the image-based lighting light effects Created in NX5.0.0.
void	SetLwrtAngle (double lwrtAngle)
	Sets the angle of the lwrt image-based lighting light effects Created in NX8.0.0.
void	SetLwrtIntensity (double lwrtIntensity)
	Sets the intensity of the lwrt image-based lighting light effects Created in NX8.0.0.
void	SetLwrtQuality (double lwrtQuality)
	Sets the quality of the lwrt image-based lighting light effects 1 to 7 Created in NX8.0.0.
void	SetShadowSoftness (double shadowSoftness)
	Sets the image-based lighting shadow softness Created in NX8.5.0.
void	SetShadowType (NXOpen::Display::ImageBasedLighting::ShadowsType shadowType)
	Sets the shadow type Created in NX5.0.0.
void	SetUseImageBasedLighting (bool useIBL)
	Sets whether image-based lighting (IBL) is enabled Created in NX5.0.0.
void	SetUseLightsForShadowCatcherInHqi (bool useLightsForShadowCatcherInHqi)
	Sets whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher Created in NX8.0.0.
void	SetUseLightsForShadowCatcherInLwrt (bool useLightsForShadowCatcherInLwrt)
	Sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher Created in NX8.0.0.
void	SetUseLwrtImageBasedLighting (bool useLwrtIBL)
	Sets whether image-based lighting is enabled in Advanced Studio (lwrt) display Created in NX8.0.0.
double	ShadowSoftness ()
	Returns the image-based lighting shadow softness Created in NX8.5.0.
NXOpen::Display::ImageBasedLighting::ShadowsType	ShadowType ()
	Returns the shadow type Created in NX5.0.0.
bool	UseImageBasedLighting ()
	Returns whether image-based lighting (IBL) is enabled Created in NX5.0.0.
bool	UseLightsForShadowCatcherInHqi ()
	Returns whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher Created in NX8.0.0.
bool	UseLightsForShadowCatcherInLwrt ()
	Returns whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher Created in NX8.0.0.
bool	UseLwrtImageBasedLighting ()
	Returns whether image-based lighting is enabled in Advanced Studio (lwrt) display Created in NX8.0.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a 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 NULL.

To create a new instance of this class, use ViewCollection::CreateImageBasedLighting

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::ImageBasedLighting::ImageBlurType

lighting image blurr type

Enumerator:

ImageBlurTypeNone	none
ImageBlurTypeLow	low
ImageBlurTypeMedium	medium
ImageBlurTypeHigh	high

enum NXOpen::Display::ImageBasedLighting::ImagesType

images type - environment used for generating image-based lighting

Enumerator:

ImagesTypeBackground	Use the background image.
ImagesTypeStage	Use the stage.
ImagesTypeUserDefined	Use the image file specified.
ImagesTypeLightingOnly	only used for IBL

enum NXOpen::Display::ImageBasedLighting::ShadowsType

shadow type

Enumerator:

ShadowsTypeNone	No shadows will be produced.
ShadowsTypeSoftEdged	Soft-edged,approximated shadows will be generated using a shadow mapping algorithm.
ShadowsTypeHardEdged	Hard-edged, precise shadows will be generated using a ray-tracing algorithm.
ShadowsTypeTranslucentHard	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

double NXOpen::Display::ImageBasedLighting::Accuracy

(

)

Returns the accuracy of the lighting and shadows produced from the given image
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::ImageBasedLighting::ColorSaturation

(

)

Returns the image-based lighting color saturation
Created in NX8.5.0.

License requirements : None

void NXOpen::Display::ImageBasedLighting::CommitAndDisplay	(	NXOpen::View *	view,
		bool	updateDisplay
	)

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

NXOpen::Display::Image* NXOpen::Display::ImageBasedLighting::Image

(

)

Returns the image-based lighting's image builder
Created in NX5.0.0.

License requirements : None

NXOpen::Display::ImageBasedLighting::ImageBlurType NXOpen::Display::ImageBasedLighting::ImageBlur

(

)

Returns the blurr of the lighting image
Created in NX8.0.0.

License requirements : None

NXString NXOpen::Display::ImageBasedLighting::ImageFilename

(

)

Returns the image filename used for image-based lighting
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::ImageBasedLighting::ImageRotation

(

)

Returns the image rotation angle (in degrees)
Created in NX5.0.0.

License requirements : None

NXOpen::Display::ImageBasedLighting::ImagesType NXOpen::Display::ImageBasedLighting::ImageType

(

)

Returns the image type
Created in NX5.0.0.

License requirements : None

NXOpen::Direction* NXOpen::Display::ImageBasedLighting::ImageUpVector

(

)

Returns the image up vector direction, relative to the absolute coordinate system
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::ImageBasedLighting::Intensity

(

)

Returns the intensity of the image-based lighting light effects
Created in NX5.0.0.

License requirements : None

double NXOpen::Display::ImageBasedLighting::LwrtAngle

(

)

Returns the angle of the lwrt image-based lighting light effects
Created in NX8.0.0.

License requirements : None

double NXOpen::Display::ImageBasedLighting::LwrtIntensity

(

)

Returns the intensity of the lwrt image-based lighting light effects
Created in NX8.0.0.

License requirements : None

double NXOpen::Display::ImageBasedLighting::LwrtQuality

(

)

Returns the quality of the lwrt image-based lighting light effects 1 to 7
Created in NX8.0.0.

License requirements : None

void NXOpen::Display::ImageBasedLighting::SetAccuracy

(

double

accuracy

)

Sets the accuracy of the lighting and shadows produced from the given image
Created in NX5.0.0.

License requirements : None

Parameters

accuracy

accuracy

void NXOpen::Display::ImageBasedLighting::SetColorSaturation

(

double

colorSaturation

)

Sets the image-based lighting color saturation
Created in NX8.5.0.

License requirements : None

Parameters

colorSaturation

color saturation

void NXOpen::Display::ImageBasedLighting::SetImage

(

NXOpen::Display::Image *

imageBuilder

)

Sets the image-based lighting's image builder
Created in NX5.0.0.

License requirements : None

Parameters

imageBuilder

image builder

void NXOpen::Display::ImageBasedLighting::SetImageBlur

(

NXOpen::Display::ImageBasedLighting::ImageBlurType

imageBlurr

)

Sets the blurr of the lighting image
Created in NX8.0.0.

License requirements : None

Parameters

imageBlurr

image blurr

void NXOpen::Display::ImageBasedLighting::SetImageFilename

(

const NXString &

imageFileName

)

Sets the image filename used for image-based lighting
Created in NX5.0.0.

License requirements : None

Parameters

imageFileName

image file name

void NXOpen::Display::ImageBasedLighting::SetImageFilename

(

const char *

imageFileName

)

Sets the image filename used for image-based lighting
Created in NX5.0.0.

License requirements : None

Parameters

imageFileName

image file name

void NXOpen::Display::ImageBasedLighting::SetImageRotation

(

double

imageRotation

)

Sets the image rotation angle (in degrees)
Created in NX5.0.0.

License requirements : None

Parameters

imageRotation

imagerotation

void NXOpen::Display::ImageBasedLighting::SetImageType

(

NXOpen::Display::ImageBasedLighting::ImagesType

imageType

)

Sets the image type
Created in NX5.0.0.

License requirements : None

Parameters

imageType

image type

void NXOpen::Display::ImageBasedLighting::SetImageUpVector

(

NXOpen::Direction *

imageUpVector

)

Sets the image up vector direction, relative to the absolute coordinate system
Created in NX5.0.0.

License requirements : None

Parameters

imageUpVector

imageupvector

void NXOpen::Display::ImageBasedLighting::SetIntensity

(

double

intensity

)

Sets the intensity of the image-based lighting light effects
Created in NX5.0.0.

License requirements : None

Parameters

intensity

intensity

void NXOpen::Display::ImageBasedLighting::SetLwrtAngle

(

double

lwrtAngle

)

Sets the angle of the lwrt image-based lighting light effects
Created in NX8.0.0.

License requirements : None

Parameters

lwrtAngle

lwrt angle

void NXOpen::Display::ImageBasedLighting::SetLwrtIntensity

(

double

lwrtIntensity

)

Sets the intensity of the lwrt image-based lighting light effects
Created in NX8.0.0.

License requirements : None

Parameters

lwrtIntensity

lwrt intensity

void NXOpen::Display::ImageBasedLighting::SetLwrtQuality

(

double

lwrtQuality

)

Sets the quality of the lwrt image-based lighting light effects 1 to 7
Created in NX8.0.0.

License requirements : None

Parameters

lwrtQuality

lwrt quality

void NXOpen::Display::ImageBasedLighting::SetShadowSoftness

(

double

shadowSoftness

)

Sets the image-based lighting shadow softness
Created in NX8.5.0.

License requirements : None

Parameters

shadowSoftness

shadow softness

void NXOpen::Display::ImageBasedLighting::SetShadowType

(

NXOpen::Display::ImageBasedLighting::ShadowsType

shadowType

)

Sets the shadow type
Created in NX5.0.0.

License requirements : None

Parameters

shadowType

shadow type

void NXOpen::Display::ImageBasedLighting::SetUseImageBasedLighting

(

bool

useIBL

)

Sets whether image-based lighting (IBL) is enabled
Created in NX5.0.0.

License requirements : None

Parameters

useIBL

useibl

void NXOpen::Display::ImageBasedLighting::SetUseLightsForShadowCatcherInHqi

(

bool

useLightsForShadowCatcherInHqi

)

Sets whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher
Created in NX8.0.0.

License requirements : None

Parameters

useLightsForShadowCatcherInHqi

uselightsforshadowcatcherinhqi

void NXOpen::Display::ImageBasedLighting::SetUseLightsForShadowCatcherInLwrt

(

bool

useLightsForShadowCatcherInLwrt

)

Sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
Created in NX8.0.0.

License requirements : None

Parameters

useLightsForShadowCatcherInLwrt

uselightsforshadowcatcherinlwrt

void NXOpen::Display::ImageBasedLighting::SetUseLwrtImageBasedLighting

(

bool

useLwrtIBL

)

Sets whether image-based lighting is enabled in Advanced Studio (lwrt) display
Created in NX8.0.0.

License requirements : None

Parameters

useLwrtIBL

uselwrtibl

double NXOpen::Display::ImageBasedLighting::ShadowSoftness

(

)

Returns the image-based lighting shadow softness
Created in NX8.5.0.

License requirements : None

NXOpen::Display::ImageBasedLighting::ShadowsType NXOpen::Display::ImageBasedLighting::ShadowType

(

)

Returns the shadow type
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::ImageBasedLighting::UseImageBasedLighting

(

)

Returns whether image-based lighting (IBL) is enabled
Created in NX5.0.0.

License requirements : None

bool NXOpen::Display::ImageBasedLighting::UseLightsForShadowCatcherInHqi

(

)

Returns whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher
Created in NX8.0.0.

License requirements : None

bool NXOpen::Display::ImageBasedLighting::UseLightsForShadowCatcherInLwrt

(

)

Returns whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
Created in NX8.0.0.

License requirements : None

bool NXOpen::Display::ImageBasedLighting::UseLwrtImageBasedLighting

(

)

Returns whether image-based lighting is enabled in Advanced Studio (lwrt) display
Created in NX8.0.0.

License requirements : None

---

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

• Display_ImageBasedLighting.hxx