public interface ImageBasedLighting extends Builder
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.
ViewCollection.createImageBasedLighting(nxopen.View, boolean)
Modifier and Type | Interface and Description |
---|---|
static class |
ImageBasedLighting.ImageBlurType
lighting image blurr type
|
static class |
ImageBasedLighting.ImagesType
images type - environment used for generating image-based lighting
|
static class |
ImageBasedLighting.ImageUpVectorTypes
up vector type
|
static class |
ImageBasedLighting.ShadowsType
shadow type
|
Modifier and Type | Method and Description |
---|---|
double |
accuracy()
Returns the accuracy of the lighting and shadows produced from the given image
License requirements: None. |
double |
colorSaturation()
Returns the image-based lighting color saturation
License requirements: None. |
void |
commitAndDisplay(View view,
boolean updateDisplay)
Saves the attributes and optionally updates the display of image-based lighting
License requirements: None. |
Image |
image()
Returns the image-based lighting's image builder
License requirements: None. |
ImageBasedLighting.ImageBlurType |
imageBlur()
Returns the blurr of the lighting image
License requirements: None. |
String |
imageFilename()
Returns the image filename used for image-based lighting
License requirements: None. |
double |
imageRotation()
Returns the image rotation angle (in degrees)
License requirements: None. |
ImageBasedLighting.ImagesType |
imageType()
Returns the image type
License requirements: None. |
nxopen.Direction |
imageUpVector()
Returns the image up vector direction, relative to the absolute coordinate system
License requirements: None. |
ImageBasedLighting.ImageUpVectorTypes |
imageUpVectorType()
Returns the image up vector define
License requirements: None. |
double |
intensity()
Returns the intensity of the image-based lighting light effects
License requirements: None. |
double |
lwrtAngle()
Returns the angle of the lwrt image-based lighting light effects
License requirements: None. |
double |
lwrtIntensity()
Returns the intensity of the lwrt image-based lighting light effects
License requirements: None. |
double |
lwrtQuality()
Returns the quality of the lwrt image-based lighting light effects 1 to 7
License requirements: None. |
void |
setAccuracy(double accuracy)
License requirements: None. |
void |
setColorSaturation(double colorSaturation)
License requirements: None. |
void |
setImage(Image imageBuilder)
License requirements: None. |
void |
setImageBlur(ImageBasedLighting.ImageBlurType imageBlurr)
License requirements: None. |
void |
setImageFilename(String imageFileName)
License requirements: None. |
void |
setImageRotation(double imageRotation)
License requirements: None. |
void |
setImageType(ImageBasedLighting.ImagesType imageType)
License requirements: None. |
void |
setImageUpVector(nxopen.Direction imageUpVector)
License requirements: None. |
void |
setImageUpVectorType(ImageBasedLighting.ImageUpVectorTypes imageUpVector)
License requirements: None. |
void |
setIntensity(double intensity)
License requirements: None. |
void |
setLwrtAngle(double lwrtAngle)
License requirements: None. |
void |
setLwrtIntensity(double lwrtIntensity)
License requirements: None. |
void |
setLwrtQuality(double lwrtQuality)
License requirements: None. |
void |
setShadowSoftness(double shadowSoftness)
License requirements: None. |
void |
setShadowType(ImageBasedLighting.ShadowsType shadowType)
License requirements: None. |
void |
setUseImageBasedLighting(boolean useIBL)
License requirements: None. |
void |
setUseLightsForShadowCatcherInHqi(boolean useLightsForShadowCatcherInHqi)
License requirements: None. |
void |
setUseLightsForShadowCatcherInLwrt(boolean useLightsForShadowCatcherInLwrt)
License requirements: None. |
void |
setUseLwrtImageBasedLighting(boolean useLwrtIBL)
License requirements: None. |
double |
shadowSoftness()
Returns the image-based lighting shadow softness
License requirements: None. |
ImageBasedLighting.ShadowsType |
shadowType()
Returns the shadow type
License requirements: None. |
boolean |
useImageBasedLighting()
Returns whether image-based lighting (IBL) is enabled
License requirements: None. |
boolean |
useLightsForShadowCatcherInHqi()
Returns whether high quality image generation (HQI) uses individual light sources or image-based lighting for shadow catcher
License requirements: None. |
boolean |
useLightsForShadowCatcherInLwrt()
Returns whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
License requirements: None. |
boolean |
useLwrtImageBasedLighting()
Returns whether image-based lighting is enabled in Advanced Studio (lwrt) display
License requirements: None. |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
ImageBasedLighting.ImageUpVectorTypes imageUpVectorType() throws NXException, RemoteException
NXException
RemoteException
void setImageUpVectorType(ImageBasedLighting.ImageUpVectorTypes imageUpVector) throws NXException, RemoteException
imageUpVector
- NXException
RemoteException
boolean useImageBasedLighting() throws NXException, RemoteException
NXException
RemoteException
void setUseImageBasedLighting(boolean useIBL) throws NXException, RemoteException
useIBL
- NXException
RemoteException
double intensity() throws NXException, RemoteException
NXException
RemoteException
void setIntensity(double intensity) throws NXException, RemoteException
intensity
- NXException
RemoteException
double accuracy() throws NXException, RemoteException
NXException
RemoteException
void setAccuracy(double accuracy) throws NXException, RemoteException
accuracy
- NXException
RemoteException
ImageBasedLighting.ImagesType imageType() throws NXException, RemoteException
NXException
RemoteException
void setImageType(ImageBasedLighting.ImagesType imageType) throws NXException, RemoteException
imageType
- NXException
RemoteException
ImageBasedLighting.ShadowsType shadowType() throws NXException, RemoteException
NXException
RemoteException
void setShadowType(ImageBasedLighting.ShadowsType shadowType) throws NXException, RemoteException
shadowType
- NXException
RemoteException
double imageRotation() throws NXException, RemoteException
NXException
RemoteException
void setImageRotation(double imageRotation) throws NXException, RemoteException
imageRotation
- NXException
RemoteException
nxopen.Direction imageUpVector() throws NXException, RemoteException
NXException
RemoteException
void setImageUpVector(nxopen.Direction imageUpVector) throws NXException, RemoteException
imageUpVector
- NXException
RemoteException
Image image() throws NXException, RemoteException
NXException
RemoteException
void setImage(Image imageBuilder) throws NXException, RemoteException
imageBuilder
- NXException
RemoteException
String imageFilename() throws NXException, RemoteException
NXException
RemoteException
void setImageFilename(String imageFileName) throws NXException, RemoteException
imageFileName
- NXException
RemoteException
void commitAndDisplay(View view, boolean updateDisplay) throws NXException, RemoteException
view
- View of the image-based lighting attributesupdateDisplay
- True if the display should be updatedNXException
RemoteException
boolean useLwrtImageBasedLighting() throws NXException, RemoteException
NXException
RemoteException
void setUseLwrtImageBasedLighting(boolean useLwrtIBL) throws NXException, RemoteException
useLwrtIBL
- NXException
RemoteException
double lwrtQuality() throws NXException, RemoteException
NXException
RemoteException
void setLwrtQuality(double lwrtQuality) throws NXException, RemoteException
lwrtQuality
- NXException
RemoteException
double lwrtAngle() throws NXException, RemoteException
NXException
RemoteException
void setLwrtAngle(double lwrtAngle) throws NXException, RemoteException
lwrtAngle
- NXException
RemoteException
double lwrtIntensity() throws NXException, RemoteException
NXException
RemoteException
void setLwrtIntensity(double lwrtIntensity) throws NXException, RemoteException
lwrtIntensity
- NXException
RemoteException
ImageBasedLighting.ImageBlurType imageBlur() throws NXException, RemoteException
NXException
RemoteException
void setImageBlur(ImageBasedLighting.ImageBlurType imageBlurr) throws NXException, RemoteException
imageBlurr
- NXException
RemoteException
boolean useLightsForShadowCatcherInHqi() throws NXException, RemoteException
NXException
RemoteException
void setUseLightsForShadowCatcherInHqi(boolean useLightsForShadowCatcherInHqi) throws NXException, RemoteException
useLightsForShadowCatcherInHqi
- NXException
RemoteException
boolean useLightsForShadowCatcherInLwrt() throws NXException, RemoteException
NXException
RemoteException
void setUseLightsForShadowCatcherInLwrt(boolean useLightsForShadowCatcherInLwrt) throws NXException, RemoteException
useLightsForShadowCatcherInLwrt
- NXException
RemoteException
double shadowSoftness() throws NXException, RemoteException
NXException
RemoteException
void setShadowSoftness(double shadowSoftness) throws NXException, RemoteException
shadowSoftness
- NXException
RemoteException
double colorSaturation() throws NXException, RemoteException
NXException
RemoteException
void setColorSaturation(double colorSaturation) throws NXException, RemoteException
colorSaturation
- NXException
RemoteException
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.