EnvironmentBuilder Class¶
-
class
NXOpen.Display.EnvironmentBuilder¶ Bases:
NXOpen.BuilderRepresents a
Display.EnvironmentBuilderThis controls environment image, tone mapping, and stages.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.CreateEnvironmentBuilder()New in version NX10.0.2.
Properties¶
| Property | Description |
|---|---|
| ColorSaturation | Returns or sets the image-based lighting color saturation |
| GroundPlaneType | Returns or sets the ground orientation define |
| GroundReflection | Returns or sets whether to enable ground reflection |
| GroundVisibility | Returns or sets whether to enable ground visibility or not |
| 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) |
| ImageUpVector | Returns or sets the image up vector direction, relative to the absolute coordinate system |
| ImageUpVectorType | Returns or sets the image up vector define |
| LightIntensity | Returns or sets the intensity of the 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 |
| OffsetExpression | Returns the environment offset expression |
| Reflectivity | Returns or sets the ground reflectivity |
| SizeExpression | Returns the environment size expression |
| SpecifyGroundPlane | Returns or sets the specify ground plane |
| Tag | Returns the Tag for this object. |
| UseEnvironment | Returns or sets whether image-based lighting (IBL) is enabled |
| UseLightsForShadowCatcherInLwrt | Returns or sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher |
| UseLwrtEnvironment | Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display |
| ViewFitToStage | Returns or sets whether to fit view to stage |
Methods¶
| Method | Description |
|---|---|
| AlignFloorPlane | The environment’s floor aligns with the given plane. |
| Commit | Commits any edits that have been applied to the builder. |
| CommitAndDisplay | Saves the attributes and optionally updates the display of image-based lighting |
| CommitOffset | Updates the data and display for a change to the ground’s offset |
| Destroy | Deletes the builder, and cleans up any objects created by the builder. |
| FloorXaxis | The environment’s floor to align with the WCS x-axis |
| FloorYaxis | The environment’s floor to align with the WCS y-axis |
| FloorZaxis | The environment’s floor to align with the WCS z-axis |
| 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¶
| EnvironmentBuilderGroundPlaneTypes Enumeration | Represents an index to a ground plane type define |
| EnvironmentBuilderImageBlurType Enumeration | lighting image blurr type |
| EnvironmentBuilderImageUpVectorTypes Enumeration | up vector type |
| EnvironmentBuilderToneMappingTypes Enumeration | tone mapping type - do not enable until NX11 |
Property Detail¶
ColorSaturation¶
-
EnvironmentBuilder.ColorSaturation¶ Returns or sets the image-based lighting color saturation
-------------------------------------Getter Method
Signature
ColorSaturationReturns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ColorSaturationParameters: colorSaturation (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
GroundPlaneType¶
-
EnvironmentBuilder.GroundPlaneType¶ Returns or sets the ground orientation define
-------------------------------------Getter Method
Signature
GroundPlaneTypeReturns: Return type: NXOpen.Display.EnvironmentBuilderGroundPlaneTypesNew in version NX10.0.2.
License requirements: None.
-------------------------------------Setter Method
Signature
GroundPlaneTypeParameters: planeType ( NXOpen.Display.EnvironmentBuilderGroundPlaneTypes) –New in version NX10.0.2.
License requirements: None.
GroundReflection¶
-
EnvironmentBuilder.GroundReflection¶ Returns or sets whether to enable ground reflection
-------------------------------------Getter Method
Signature
GroundReflectionReturns: Return type: bool New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
GroundReflectionParameters: groundReflection (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
GroundVisibility¶
-
EnvironmentBuilder.GroundVisibility¶ Returns or sets whether to enable ground visibility or not
-------------------------------------Getter Method
Signature
GroundVisibilityReturns: Return type: bool New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
GroundVisibilityParameters: groundVisibility (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Image¶
-
EnvironmentBuilder.Image¶ Returns or sets the image-based lighting’s image builder
-------------------------------------Getter Method
Signature
ImageReturns: Return type: NXOpen.Display.ImageNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ImageParameters: imageBuilder ( NXOpen.Display.Image) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
ImageBlur¶
-
EnvironmentBuilder.ImageBlur¶ Returns or sets the blurr of the lighting image
-------------------------------------Getter Method
Signature
ImageBlurReturns: Return type: NXOpen.Display.EnvironmentBuilderImageBlurTypeNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ImageBlurParameters: imageBlurr ( NXOpen.Display.EnvironmentBuilderImageBlurType) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
ImageFilename¶
-
EnvironmentBuilder.ImageFilename¶ Returns or sets the image filename used for image-based lighting
-------------------------------------Getter Method
Signature
ImageFilenameReturns: Return type: str New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ImageFilenameParameters: imageFileName (str) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
ImageRotation¶
-
EnvironmentBuilder.ImageRotation¶ Returns or sets the image rotation angle (in degrees)
-------------------------------------Getter Method
Signature
ImageRotationReturns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ImageRotationParameters: imageRotation (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
ImageUpVector¶
-
EnvironmentBuilder.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 NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ImageUpVectorParameters: imageUpVector ( NXOpen.Direction) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
ImageUpVectorType¶
-
EnvironmentBuilder.ImageUpVectorType¶ Returns or sets the image up vector define
-------------------------------------Getter Method
Signature
ImageUpVectorTypeReturns: Return type: NXOpen.Display.EnvironmentBuilderImageUpVectorTypesNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ImageUpVectorTypeParameters: imageUpVector ( NXOpen.Display.EnvironmentBuilderImageUpVectorTypes) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
LightIntensity¶
-
EnvironmentBuilder.LightIntensity¶ Returns or sets the intensity of the light effects
-------------------------------------Getter Method
Signature
LightIntensityReturns: Return type: float New in version NX11.0.0.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
LightIntensityParameters: lightIntensity (float) – New in version NX11.0.0.
License requirements: studio_render (“UG STUDIO RENDER”)
LwrtAngle¶
-
EnvironmentBuilder.LwrtAngle¶ Returns or sets the angle of the lwrt image-based lighting light effects
-------------------------------------Getter Method
Signature
LwrtAngleReturns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
LwrtAngleParameters: lwrtAngle (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
LwrtIntensity¶
-
EnvironmentBuilder.LwrtIntensity¶ Returns or sets the intensity of the lwrt image-based lighting light effects
-------------------------------------Getter Method
Signature
LwrtIntensityReturns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
LwrtIntensityParameters: lwrtIntensity (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
LwrtQuality¶
-
EnvironmentBuilder.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 NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
LwrtQualityParameters: lwrtQuality (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
OffsetExpression¶
-
EnvironmentBuilder.OffsetExpression¶ Returns the environment offset expression
-------------------------------------Getter Method
Signature
OffsetExpressionReturns: Return type: NXOpen.ExpressionNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Reflectivity¶
-
EnvironmentBuilder.Reflectivity¶ Returns or sets the ground reflectivity
-------------------------------------Getter Method
Signature
ReflectivityReturns: Return type: float New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ReflectivityParameters: reflectivity (float) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
SizeExpression¶
-
EnvironmentBuilder.SizeExpression¶ Returns the environment size expression
-------------------------------------Getter Method
Signature
SizeExpressionReturns: Return type: NXOpen.ExpressionNew in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
SpecifyGroundPlane¶
-
EnvironmentBuilder.SpecifyGroundPlane¶ Returns or sets the specify ground plane
-------------------------------------Getter Method
Signature
SpecifyGroundPlaneReturns: Return type: NXOpen.PlaneNew in version NX10.0.2.
License requirements: None.
-------------------------------------Setter Method
Signature
SpecifyGroundPlaneParameters: specifyPlane ( NXOpen.Plane) –New in version NX10.0.2.
License requirements: None.
UseEnvironment¶
-
EnvironmentBuilder.UseEnvironment¶ Returns or sets whether image-based lighting (IBL) is enabled
-------------------------------------Getter Method
Signature
UseEnvironmentReturns: Return type: bool New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
UseEnvironmentParameters: useIBL (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
UseLightsForShadowCatcherInLwrt¶
-
EnvironmentBuilder.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 NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
UseLightsForShadowCatcherInLwrtParameters: useLightsForShadowCatcherInLwrt (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
UseLwrtEnvironment¶
-
EnvironmentBuilder.UseLwrtEnvironment¶ Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display
-------------------------------------Getter Method
Signature
UseLwrtEnvironmentReturns: Return type: bool New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
UseLwrtEnvironmentParameters: useLwrtIBL (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
ViewFitToStage¶
-
EnvironmentBuilder.ViewFitToStage¶ Returns or sets whether to fit view to stage
-------------------------------------Getter Method
Signature
ViewFitToStageReturns: Return type: bool New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
-------------------------------------Setter Method
Signature
ViewFitToStageParameters: viewFitToStage (bool) – New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Method Detail¶
AlignFloorPlane¶
-
EnvironmentBuilder.AlignFloorPlane¶ The environment’s floor aligns with the given plane.
Signature
AlignFloorPlane(specifyFloorPlane)Parameters: specifyFloorPlane ( NXOpen.Plane) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
CommitAndDisplay¶
-
EnvironmentBuilder.CommitAndDisplay¶ Saves the attributes and optionally updates the display of image-based lighting
Signature
CommitAndDisplay(view, updateIblDisplay, updateEnvCubeDisplay)Parameters: - view (
NXOpen.View) – View of the image-based lighting attributes - updateIblDisplay (bool) – True if the image-based lighting display should be updated
- updateEnvCubeDisplay (bool) – True if the cube display should be updated
New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
- view (
CommitOffset¶
-
EnvironmentBuilder.CommitOffset¶ Updates the data and display for a change to the ground’s offset
Signature
CommitOffset(view)Parameters: view ( NXOpen.View) –New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
FloorXaxis¶
-
EnvironmentBuilder.FloorXaxis¶ The environment’s floor to align with the WCS x-axis
Signature
FloorXaxis()New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
FloorYaxis¶
-
EnvironmentBuilder.FloorYaxis¶ The environment’s floor to align with the WCS y-axis
Signature
FloorYaxis()New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
FloorZaxis¶
-
EnvironmentBuilder.FloorZaxis¶ The environment’s floor to align with the WCS z-axis
Signature
FloorZaxis()New in version NX10.0.2.
License requirements: studio_render (“UG STUDIO RENDER”)
Validate¶
-
EnvironmentBuilder.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.