ImageBasedLighting Class¶
-
class
NXOpen.Display.ImageBasedLighting¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.ImageBasedLightingImage-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 None.
To create a new instance of this class, use
NXOpen.ViewCollection.CreateImageBasedLighting()New in version NX5.0.0.
Properties¶
| Property | Description |
|---|---|
| Accuracy | Returns or sets the accuracy of the lighting and shadows produced from the given image |
| ColorSaturation | Returns or sets the image-based lighting color saturation |
| Image | Returns or sets the image-based lighting’s image builder |
| ImageBlur | Returns or sets the blurr of the lighting image |
| ImageFilename | Returns or sets the image filename used for image-based lighting |
| ImageRotation | Returns or sets the image rotation angle (in degrees) |
| ImageType | Returns or sets the image type |
| ImageUpVector | Returns or sets the image up vector direction, relative to the absolute coordinate system |
| ImageUpVectorType | Returns or sets the image up vector define |
| Intensity | Returns or sets the intensity of the image-based lighting light effects |
| LwrtAngle | Returns or sets the angle of the lwrt image-based lighting light effects |
| LwrtIntensity | Returns or sets the intensity of the lwrt image-based lighting light effects |
| LwrtQuality | Returns or sets the quality of the lwrt image-based lighting light effects 1 to 7 |
| ShadowSoftness | Returns or sets the image-based lighting shadow softness |
| ShadowType | Returns or sets the shadow type |
| Tag | Returns the Tag for this object. |
| UseImageBasedLighting | Returns or sets whether image-based lighting (IBL) is enabled |
| UseLightsForShadowCatcherInHqi | Returns or sets whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher |
| UseLightsForShadowCatcherInLwrt | Returns or sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher |
| UseLwrtImageBasedLighting | Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| CommitAndDisplay | Saves the attributes and optionally updates the display of image-based lighting |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetObject | Returns the object currently being edited by this builder. |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| ImageBasedLightingImageBlurType Enumeration | lighting image blurr type |
| ImageBasedLightingImageUpVectorTypes Enumeration | up vector type |
| ImageBasedLightingImagesType Enumeration | images type - environment used for generating image-based lighting |
| ImageBasedLightingShadowsType Enumeration | shadow type |
Property Detail¶
Accuracy¶
-
ImageBasedLighting.Accuracy¶ Returns or sets the accuracy of the lighting and shadows produced from the given image
-------------------------------------Getter Method
Signature
AccuracyReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AccuracyParameters: accuracy (float) – New in version NX5.0.0.
License requirements: None.
ColorSaturation¶
-
ImageBasedLighting.ColorSaturation¶ Returns or sets the image-based lighting color saturation
-------------------------------------Getter Method
Signature
ColorSaturationReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ColorSaturationParameters: colorSaturation (float) – New in version NX8.5.0.
License requirements: None.
Image¶
-
ImageBasedLighting.Image¶ Returns or sets the image-based lighting’s image builder
-------------------------------------Getter Method
Signature
ImageReturns: Return type: NXOpen.Display.ImageNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageParameters: imageBuilder ( NXOpen.Display.Image) –New in version NX5.0.0.
License requirements: None.
ImageBlur¶
-
ImageBasedLighting.ImageBlur¶ Returns or sets the blurr of the lighting image
-------------------------------------Getter Method
Signature
ImageBlurReturns: Return type: NXOpen.Display.ImageBasedLightingImageBlurTypeNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageBlurParameters: imageBlurr ( NXOpen.Display.ImageBasedLightingImageBlurType) –New in version NX8.0.0.
License requirements: None.
ImageFilename¶
-
ImageBasedLighting.ImageFilename¶ Returns or sets the image filename used for image-based lighting
-------------------------------------Getter Method
Signature
ImageFilenameReturns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageFilenameParameters: imageFileName (str) – New in version NX5.0.0.
License requirements: None.
ImageRotation¶
-
ImageBasedLighting.ImageRotation¶ Returns or sets the image rotation angle (in degrees)
-------------------------------------Getter Method
Signature
ImageRotationReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageRotationParameters: imageRotation (float) – New in version NX5.0.0.
License requirements: None.
ImageType¶
-
ImageBasedLighting.ImageType¶ Returns or sets the image type
-------------------------------------Getter Method
Signature
ImageTypeReturns: Return type: NXOpen.Display.ImageBasedLightingImagesTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageTypeParameters: imageType ( NXOpen.Display.ImageBasedLightingImagesType) –New in version NX5.0.0.
License requirements: None.
ImageUpVector¶
-
ImageBasedLighting.ImageUpVector¶ Returns or sets the image up vector direction, relative to the absolute coordinate system
-------------------------------------Getter Method
Signature
ImageUpVectorReturns: Return type: NXOpen.DirectionNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageUpVectorParameters: imageUpVector ( NXOpen.Direction) –New in version NX5.0.0.
License requirements: None.
ImageUpVectorType¶
-
ImageBasedLighting.ImageUpVectorType¶ Returns or sets the image up vector define
-------------------------------------Getter Method
Signature
ImageUpVectorTypeReturns: Return type: NXOpen.Display.ImageBasedLightingImageUpVectorTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageUpVectorTypeParameters: imageUpVector ( NXOpen.Display.ImageBasedLightingImageUpVectorTypes) –New in version NX10.0.0.
License requirements: None.
Intensity¶
-
ImageBasedLighting.Intensity¶ Returns or sets the intensity of the image-based lighting light effects
-------------------------------------Getter Method
Signature
IntensityReturns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IntensityParameters: intensity (float) – New in version NX5.0.0.
License requirements: None.
LwrtAngle¶
-
ImageBasedLighting.LwrtAngle¶ Returns or sets the angle of the lwrt image-based lighting light effects
-------------------------------------Getter Method
Signature
LwrtAngleReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LwrtAngleParameters: lwrtAngle (float) – New in version NX8.0.0.
License requirements: None.
LwrtIntensity¶
-
ImageBasedLighting.LwrtIntensity¶ Returns or sets the intensity of the lwrt image-based lighting light effects
-------------------------------------Getter Method
Signature
LwrtIntensityReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LwrtIntensityParameters: lwrtIntensity (float) – New in version NX8.0.0.
License requirements: None.
LwrtQuality¶
-
ImageBasedLighting.LwrtQuality¶ Returns or sets the quality of the lwrt image-based lighting light effects 1 to 7
-------------------------------------Getter Method
Signature
LwrtQualityReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LwrtQualityParameters: lwrtQuality (float) – New in version NX8.0.0.
License requirements: None.
ShadowSoftness¶
-
ImageBasedLighting.ShadowSoftness¶ Returns or sets the image-based lighting shadow softness
-------------------------------------Getter Method
Signature
ShadowSoftnessReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShadowSoftnessParameters: shadowSoftness (float) – New in version NX8.5.0.
License requirements: None.
ShadowType¶
-
ImageBasedLighting.ShadowType¶ Returns or sets the shadow type
-------------------------------------Getter Method
Signature
ShadowTypeReturns: Return type: NXOpen.Display.ImageBasedLightingShadowsTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShadowTypeParameters: shadowType ( NXOpen.Display.ImageBasedLightingShadowsType) –New in version NX5.0.0.
License requirements: None.
UseImageBasedLighting¶
-
ImageBasedLighting.UseImageBasedLighting¶ Returns or sets whether image-based lighting (IBL) is enabled
-------------------------------------Getter Method
Signature
UseImageBasedLightingReturns: Return type: bool New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseImageBasedLightingParameters: useIBL (bool) – New in version NX5.0.0.
License requirements: None.
UseLightsForShadowCatcherInHqi¶
-
ImageBasedLighting.UseLightsForShadowCatcherInHqi¶ Returns or sets whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher
-------------------------------------Getter Method
Signature
UseLightsForShadowCatcherInHqiReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseLightsForShadowCatcherInHqiParameters: useLightsForShadowCatcherInHqi (bool) – New in version NX8.0.0.
License requirements: None.
UseLightsForShadowCatcherInLwrt¶
-
ImageBasedLighting.UseLightsForShadowCatcherInLwrt¶ Returns or sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
-------------------------------------Getter Method
Signature
UseLightsForShadowCatcherInLwrtReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseLightsForShadowCatcherInLwrtParameters: useLightsForShadowCatcherInLwrt (bool) – New in version NX8.0.0.
License requirements: None.
UseLwrtImageBasedLighting¶
-
ImageBasedLighting.UseLwrtImageBasedLighting¶ Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display
-------------------------------------Getter Method
Signature
UseLwrtImageBasedLightingReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseLwrtImageBasedLightingParameters: useLwrtIBL (bool) – New in version NX8.0.0.
License requirements: None.
Method Detail¶
CommitAndDisplay¶
-
ImageBasedLighting.CommitAndDisplay¶ Saves the attributes and optionally updates the display of image-based lighting
Signature
CommitAndDisplay(view, updateDisplay)Parameters: - view (
NXOpen.View) – View of the image-based lighting attributes - updateDisplay (bool) – True if the display should be updated
New in version NX5.0.0.
License requirements: None.
- view (
Validate¶
-
ImageBasedLighting.Validate¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.