NXOpen .NET Reference
12.0.0
|
Represents a Display.EnvironmentBuilder This controls environment image, tone mapping, and stages. More...
Public Types | |
enum | ImageBlurType { None, Low, Medium, High } |
lighting image blurr type More... | |
enum | ImageUpVectorTypes { AlignWithFloorPlane, UserDefined } |
up vector type More... | |
enum | ToneMappingTypes { SystemScene, UserDefined } |
tone mapping type - do not enable until NX11 More... | |
enum | GroundPlaneTypes { Yz, Xz, Xy, UserDefined } |
Represents an index to a ground plane type define More... | |
Public Member Functions | |
unsafe void | CommitAndDisplay (NXOpen.View view, bool updateIblDisplay, bool updateEnvCubeDisplay) |
Saves the attributes and optionally updates the display of image-based lighting More... | |
unsafe void | CommitOffset (NXOpen.View view) |
Updates the data and display for a change to the ground's offset More... | |
unsafe void | FloorXaxis () |
The environment's floor to align with the WCS x-axis More... | |
unsafe void | FloorYaxis () |
The environment's floor to align with the WCS y-axis More... | |
unsafe void | FloorZaxis () |
The environment's floor to align with the WCS z-axis More... | |
unsafe void | AlignFloorPlane (NXOpen.Plane specifyFloorPlane) |
The environment's floor aligns with the given plane. More... | |
Public Member Functions inherited from NXOpen.Builder | |
unsafe NXOpen.NXObject | Commit () |
Commits any edits that have been applied to the builder. More... | |
unsafe void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
unsafe NXOpen.NXObject[] | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
unsafe NXOpen.NXObject | GetObject () |
Returns the object currently being edited by this builder. More... | |
unsafe void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
unsafe bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Properties | |
unsafe double | ColorSaturation [get, set] |
Returns or sets the image-based lighting color saturation More... | |
unsafe NXOpen.Display.EnvironmentBuilder.GroundPlaneTypes | GroundPlaneType [get, set] |
Returns or sets the ground orientation define More... | |
unsafe bool | GroundReflection [get, set] |
Returns or sets whether to enable ground reflection More... | |
unsafe bool | GroundVisibility [get, set] |
Returns or sets whether to enable ground visibility or not More... | |
unsafe NXOpen.Display.Image | Image [get, set] |
Returns or sets the image-based lighting's image builder More... | |
unsafe NXOpen.Display.EnvironmentBuilder.ImageBlurType | ImageBlur [get, set] |
Returns or sets the blurr of the lighting image More... | |
unsafe string | ImageFilename [get, set] |
Returns or sets the image filename used for image-based lighting More... | |
unsafe double | ImageRotation [get, set] |
Returns or sets the image rotation angle (in degrees) More... | |
unsafe NXOpen.Direction | ImageUpVector [get, set] |
Returns or sets the image up vector direction, relative to the absolute coordinate system More... | |
unsafe NXOpen.Display.EnvironmentBuilder.ImageUpVectorTypes | ImageUpVectorType [get, set] |
Returns or sets the image up vector define More... | |
unsafe double | LightIntensity [get, set] |
Returns or sets the intensity of the light effects More... | |
unsafe double | LwrtAngle [get, set] |
Returns or sets the angle of the lwrt image-based lighting light effects More... | |
unsafe double | LwrtIntensity [get, set] |
Returns or sets the intensity of the lwrt image-based lighting light effects More... | |
unsafe double | LwrtQuality [get, set] |
Returns or sets the quality of the lwrt image-based lighting light effects 1 to 7 More... | |
unsafe NXOpen.Expression | OffsetExpression [get] |
Returns the environment offset expression More... | |
unsafe double | Reflectivity [get, set] |
Returns or sets the ground reflectivity More... | |
unsafe NXOpen.Expression | SizeExpression [get] |
Returns the environment size expression More... | |
unsafe NXOpen.Plane | SpecifyGroundPlane [get, set] |
Returns or sets the specify ground plane More... | |
unsafe bool | UseEnvironment [get, set] |
Returns or sets whether image-based lighting (IBL) is enabled More... | |
unsafe bool | UseLightsForShadowCatcherInLwrt [get, set] |
Returns or sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher More... | |
unsafe bool | UseLwrtEnvironment [get, set] |
Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display More... | |
unsafe bool | ViewFitToStage [get, set] |
Returns or sets whether to fit view to stage More... | |
Represents a Display.EnvironmentBuilder This 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 a null reference (Nothing in Visual Basic).
To create a new instance of this class, use NXOpen.ViewCollection.CreateEnvironmentBuilder
Created in NX10.0.2
unsafe void NXOpen.Display.EnvironmentBuilder.AlignFloorPlane | ( | NXOpen.Plane | specifyFloorPlane | ) |
The environment's floor aligns with the given plane.
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
specifyFloorPlane |
unsafe void NXOpen.Display.EnvironmentBuilder.CommitAndDisplay | ( | NXOpen.View | view, |
bool | updateIblDisplay, | ||
bool | updateEnvCubeDisplay | ||
) |
Saves the attributes and optionally updates the display of image-based lighting
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
view | View of the image-based lighting attributes |
updateIblDisplay | True if the image-based lighting display should be updated |
updateEnvCubeDisplay | True if the cube display should be updated |
unsafe void NXOpen.Display.EnvironmentBuilder.CommitOffset | ( | NXOpen.View | view | ) |
Updates the data and display for a change to the ground's offset
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
view |
unsafe void NXOpen.Display.EnvironmentBuilder.FloorXaxis | ( | ) |
The environment's floor to align with the WCS x-axis
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
unsafe void NXOpen.Display.EnvironmentBuilder.FloorYaxis | ( | ) |
The environment's floor to align with the WCS y-axis
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
unsafe void NXOpen.Display.EnvironmentBuilder.FloorZaxis | ( | ) |
The environment's floor to align with the WCS z-axis
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the image-based lighting color saturation
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the ground orientation define
Created in NX10.0.2
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets whether to enable ground reflection
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets whether to enable ground visibility or not
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the image-based lighting's image builder
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the blurr of the lighting image
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the image filename used for image-based lighting
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the image rotation angle (in degrees)
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the image up vector direction, relative to the absolute coordinate system
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the image up vector define
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the intensity of the light effects
Created in NX11.0.0
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the angle of the lwrt image-based lighting light effects
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the intensity of the lwrt image-based lighting light effects
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the quality of the lwrt image-based lighting light effects 1 to 7
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
get |
Returns the environment offset expression
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the ground reflectivity
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
get |
Returns the environment size expression
Created in NX10.0.2
License requirements: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets the specify ground plane
Created in NX10.0.2
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets whether image-based lighting (IBL) is enabled
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets whether image-based lighting is enabled in Advanced Studio (lwrt) display
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")
|
getset |
Returns or sets whether to fit view to stage
Created in NX10.0.2
License requirements to get this property: studio_render ("UG STUDIO RENDER")
License requirements to set this property: studio_render ("UG STUDIO RENDER")