NX Open C++ Reference Guide
Public Types | Public Member Functions
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:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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.
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::ImageImage ()
 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::DirectionImageUpVector ()
 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 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 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 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 HQI use lights or IBL for shadow catcher
Created in NX8.0.0.
void SetUseLightsForShadowCatcherInLwrt (bool useLightsForShadowCatcherInLwrt)
 Sets whether lwrt use lights or IBL for shadow catcher
Created in NX8.0.0.
void SetUseLwrtImageBasedLighting (bool useLwrtIBL)
 Sets whether lwrt image-based lighting (IBL) is enabled
Created in NX8.0.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 HQI use lights or IBL for shadow catcher
Created in NX8.0.0.
bool UseLightsForShadowCatcherInLwrt ()
 Returns whether lwrt use lights or IBL for shadow catcher
Created in NX8.0.0.
bool UseLwrtImageBasedLighting ()
 Returns whether lwrt image-based lighting (IBL) is enabled
Created in NX8.0.0.

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.
To create a new instance of this class, use ViewCollection::CreateImageBasedLighting

Created in NX5.0.0.


Member Enumeration Documentation

lighting image blurr type

Enumerator:
ImageBlurTypeNone 

none

ImageBlurTypeLow 

low

ImageBlurTypeMedium 

medium

ImageBlurTypeHigh 

high

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

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

Returns the accuracy of the lighting and shadows produced from the given image
Created in NX5.0.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:
viewView of the image-based lighting attributes
updateDisplayTrue if the display should be updated

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the image type
Created in NX5.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Parameters:
accuracyaccuracy

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



License requirements : None

Parameters:
imageBuilderimage builder

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



License requirements : None

Parameters:
imageBlurrimage blurr

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



License requirements : None

Parameters:
imageFileNameimage file name

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



License requirements : None

Parameters:
imageRotationimagerotation

Sets the image type
Created in NX5.0.0.



License requirements : None

Parameters:
imageTypeimage type

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



License requirements : None

Parameters:
imageUpVectorimageupvector

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



License requirements : None

Parameters:
intensityintensity

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



License requirements : None

Parameters:
lwrtAnglelwrt angle

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



License requirements : None

Parameters:
lwrtIntensitylwrt intensity

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



License requirements : None

Parameters:
lwrtQualitylwrt quality

Sets the shadow type
Created in NX5.0.0.



License requirements : None

Parameters:
shadowTypeshadow type

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



License requirements : None

Parameters:
useIBLuseibl
void NXOpen::Display::ImageBasedLighting::SetUseLightsForShadowCatcherInHqi ( bool  useLightsForShadowCatcherInHqi)

Sets whether HQI use lights or IBL for shadow catcher
Created in NX8.0.0.



License requirements : None

Parameters:
useLightsForShadowCatcherInHqiuselightsforshadowcatcherinhqi
void NXOpen::Display::ImageBasedLighting::SetUseLightsForShadowCatcherInLwrt ( bool  useLightsForShadowCatcherInLwrt)

Sets whether lwrt use lights or IBL for shadow catcher
Created in NX8.0.0.



License requirements : None

Parameters:
useLightsForShadowCatcherInLwrtuselightsforshadowcatcherinlwrt

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



License requirements : None

Parameters:
useLwrtIBLuselwrtibl

Returns the shadow type
Created in NX5.0.0.



License requirements : None

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



License requirements : None

Returns whether HQI use lights or IBL for shadow catcher
Created in NX8.0.0.



License requirements : None

Returns whether lwrt use lights or IBL for shadow catcher
Created in NX8.0.0.



License requirements : None

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



License requirements : None


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