public interface EnvironmentBuilder extends Builder
Display.EnvironmentBuilder
This controls environment image, tone mapping, and stages.
ViewCollection.createEnvironmentBuilder(nxopen.View, boolean)
Modifier and Type | Interface and Description |
---|---|
static class |
EnvironmentBuilder.GroundPlaneTypes
Represents an index to a ground plane type define
|
static class |
EnvironmentBuilder.ImageBlurType
lighting image blurr type
|
static class |
EnvironmentBuilder.ImageUpVectorTypes
up vector type
|
static class |
EnvironmentBuilder.ToneMappingTypes
tone mapping type - do not enable until NX11
|
Modifier and Type | Method and Description |
---|---|
void |
alignFloorPlane(Plane specifyFloorPlane)
The environment's floor aligns with the given plane.
|
double |
colorSaturation()
Returns the image-based lighting color saturation
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
commitAndDisplay(View view,
boolean updateIblDisplay,
boolean updateEnvCubeDisplay)
Saves the attributes and optionally updates the display of image-based lighting
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
commitOffset(View view)
Updates the data and display for a change to the ground's offset
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
floorXaxis()
The environment's floor to align with the WCS x-axis
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
floorYaxis()
The environment's floor to align with the WCS y-axis
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
floorZaxis()
The environment's floor to align with the WCS z-axis
License requirements: studio_render ("UG STUDIO RENDER") . |
EnvironmentBuilder.GroundPlaneTypes |
groundPlaneType()
Returns the ground orientation define
License requirements: None. |
boolean |
groundReflection()
Returns whether to enable ground reflection
License requirements: studio_render ("UG STUDIO RENDER") . |
boolean |
groundVisibility()
Returns whether to enable ground visibility or not
License requirements: studio_render ("UG STUDIO RENDER") . |
Image |
image()
Returns the image-based lighting's image builder
License requirements: studio_render ("UG STUDIO RENDER") . |
EnvironmentBuilder.ImageBlurType |
imageBlur()
Returns the blurr of the lighting image
License requirements: studio_render ("UG STUDIO RENDER") . |
String |
imageFilename()
Returns the image filename used for image-based lighting
License requirements: studio_render ("UG STUDIO RENDER") . |
double |
imageRotation()
Returns the image rotation angle (in degrees)
License requirements: studio_render ("UG STUDIO RENDER") . |
Direction |
imageUpVector()
Returns the image up vector direction, relative to the absolute coordinate system
License requirements: studio_render ("UG STUDIO RENDER") . |
EnvironmentBuilder.ImageUpVectorTypes |
imageUpVectorType()
Returns the image up vector define
License requirements: studio_render ("UG STUDIO RENDER") . |
double |
lightIntensity()
Returns the intensity of the light effects
License requirements: studio_render ("UG STUDIO RENDER") . |
double |
lwrtAngle()
Returns the angle of the lwrt image-based lighting light effects
License requirements: studio_render ("UG STUDIO RENDER") . |
double |
lwrtIntensity()
Returns the intensity of the lwrt image-based lighting light effects
License requirements: studio_render ("UG STUDIO RENDER") . |
double |
lwrtQuality()
Returns the quality of the lwrt image-based lighting light effects 1 to 7
License requirements: studio_render ("UG STUDIO RENDER") . |
Expression |
offsetExpression()
Returns the environment offset expression
License requirements: studio_render ("UG STUDIO RENDER") . |
double |
reflectivity()
Returns the ground reflectivity
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setColorSaturation(double colorSaturation)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setGroundPlaneType(EnvironmentBuilder.GroundPlaneTypes planeType)
License requirements: None. |
void |
setGroundReflection(boolean groundReflection)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setGroundVisibility(boolean groundVisibility)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setImage(Image imageBuilder)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setImageBlur(EnvironmentBuilder.ImageBlurType imageBlurr)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setImageFilename(String imageFileName)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setImageRotation(double imageRotation)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setImageUpVector(Direction imageUpVector)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setImageUpVectorType(EnvironmentBuilder.ImageUpVectorTypes imageUpVector)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setLightIntensity(double lightIntensity)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setLwrtAngle(double lwrtAngle)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setLwrtIntensity(double lwrtIntensity)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setLwrtQuality(double lwrtQuality)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setReflectivity(double reflectivity)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setSpecifyGroundPlane(Plane specifyPlane)
License requirements: None. |
void |
setUseEnvironment(boolean useIBL)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setUseLightsForShadowCatcherInLwrt(boolean useLightsForShadowCatcherInLwrt)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setUseLwrtEnvironment(boolean useLwrtIBL)
License requirements: studio_render ("UG STUDIO RENDER") . |
void |
setViewFitToStage(boolean viewFitToStage)
License requirements: studio_render ("UG STUDIO RENDER") . |
Expression |
sizeExpression()
Returns the environment size expression
License requirements: studio_render ("UG STUDIO RENDER") . |
Plane |
specifyGroundPlane()
Returns the specify ground plane
License requirements: None. |
boolean |
useEnvironment()
Returns whether image-based lighting (IBL) is enabled
License requirements: studio_render ("UG STUDIO RENDER") . |
boolean |
useLightsForShadowCatcherInLwrt()
Returns whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
License requirements: studio_render ("UG STUDIO RENDER") . |
boolean |
useLwrtEnvironment()
Returns whether image-based lighting is enabled in Advanced Studio (lwrt) display
License requirements: studio_render ("UG STUDIO RENDER") . |
boolean |
viewFitToStage()
Returns whether to fit view to stage
License requirements: studio_render ("UG STUDIO RENDER") . |
commit, destroy, getCommittedObjects, getObject, showResults
printTestData, printTestData, tag, tagValue
validate
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
boolean useEnvironment() throws NXException, RemoteException
NXException
RemoteException
void setUseEnvironment(boolean useIBL) throws NXException, RemoteException
useIBL
- NXException
RemoteException
Expression sizeExpression() throws NXException, RemoteException
NXException
RemoteException
EnvironmentBuilder.ImageUpVectorTypes imageUpVectorType() throws NXException, RemoteException
NXException
RemoteException
void setImageUpVectorType(EnvironmentBuilder.ImageUpVectorTypes imageUpVector) throws NXException, RemoteException
imageUpVector
- NXException
RemoteException
Direction imageUpVector() throws NXException, RemoteException
NXException
RemoteException
void setImageUpVector(Direction imageUpVector) throws NXException, RemoteException
imageUpVector
- NXException
RemoteException
double imageRotation() throws NXException, RemoteException
NXException
RemoteException
void setImageRotation(double imageRotation) throws NXException, RemoteException
imageRotation
- NXException
RemoteException
boolean viewFitToStage() throws NXException, RemoteException
NXException
RemoteException
void setViewFitToStage(boolean viewFitToStage) throws NXException, RemoteException
viewFitToStage
- NXException
RemoteException
boolean groundVisibility() throws NXException, RemoteException
NXException
RemoteException
void setGroundVisibility(boolean groundVisibility) throws NXException, RemoteException
groundVisibility
- NXException
RemoteException
EnvironmentBuilder.GroundPlaneTypes groundPlaneType() throws NXException, RemoteException
NXException
RemoteException
void setGroundPlaneType(EnvironmentBuilder.GroundPlaneTypes planeType) throws NXException, RemoteException
planeType
- NXException
RemoteException
Plane specifyGroundPlane() throws NXException, RemoteException
NXException
RemoteException
void setSpecifyGroundPlane(Plane specifyPlane) throws NXException, RemoteException
specifyPlane
- NXException
RemoteException
Expression offsetExpression() throws NXException, RemoteException
NXException
RemoteException
boolean groundReflection() throws NXException, RemoteException
NXException
RemoteException
void setGroundReflection(boolean groundReflection) throws NXException, RemoteException
groundReflection
- NXException
RemoteException
double reflectivity() throws NXException, RemoteException
NXException
RemoteException
void setReflectivity(double reflectivity) throws NXException, RemoteException
reflectivity
- NXException
RemoteException
double lightIntensity() throws NXException, RemoteException
NXException
RemoteException
void setLightIntensity(double lightIntensity) throws NXException, RemoteException
lightIntensity
- NXException
RemoteException
void commitAndDisplay(View view, boolean updateIblDisplay, boolean updateEnvCubeDisplay) throws NXException, RemoteException
view
- View of the image-based lighting attributesupdateIblDisplay
- True if the image-based lighting display should be updatedupdateEnvCubeDisplay
- True if the cube display should be updatedNXException
RemoteException
EnvironmentBuilder.ImageBlurType imageBlur() throws NXException, RemoteException
NXException
RemoteException
void setImageBlur(EnvironmentBuilder.ImageBlurType imageBlurr) throws NXException, RemoteException
imageBlurr
- NXException
RemoteException
boolean useLwrtEnvironment() throws NXException, RemoteException
NXException
RemoteException
void setUseLwrtEnvironment(boolean useLwrtIBL) throws NXException, RemoteException
useLwrtIBL
- NXException
RemoteException
boolean useLightsForShadowCatcherInLwrt() throws NXException, RemoteException
NXException
RemoteException
void setUseLightsForShadowCatcherInLwrt(boolean useLightsForShadowCatcherInLwrt) throws NXException, RemoteException
useLightsForShadowCatcherInLwrt
- 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
double colorSaturation() throws NXException, RemoteException
NXException
RemoteException
void setColorSaturation(double colorSaturation) throws NXException, RemoteException
colorSaturation
- NXException
RemoteException
void commitOffset(View view) throws NXException, RemoteException
view
- NXException
RemoteException
void floorXaxis() throws NXException, RemoteException
NXException
RemoteException
void floorYaxis() throws NXException, RemoteException
NXException
RemoteException
void floorZaxis() throws NXException, RemoteException
NXException
RemoteException
void alignFloorPlane(Plane specifyFloorPlane) throws NXException, RemoteException
specifyFloorPlane
- NXException
RemoteException
Copyright 2016 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.