Represents a Display.EnvironmentBuilder This controls environment image, tone mapping, and stages. More...

Inheritance diagram for NXOpen.Display.EnvironmentBuilder:

Public Types
enum	GlobalFinishType { MattePlastic, ClassicSatin, ShinyPlastic, UserDefined }
	Represents global finish types for shaded views More...

enum	GroundPlaneTypes { Yz, Xz, Xy, UserDefined }
	Represents an index to a ground plane type define More...

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...

Public Member Functions
unsafe void	AlignFloorPlane (NXOpen.Plane specifyFloorPlane)
	The environment's floor aligns with the given plane. More...

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...

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...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe double	ColorSaturation `[get, set]`
	Returns or sets the image-based lighting color saturation More...

unsafe bool	EnvironmentShadedViewsFixGroundPlaneOffset `[get, set]`
	Returns or sets the ground plane offset in shaded mode More...

unsafe int	EnvironmentShadedViewsGlobalFinish `[get, set]`
	Returns or sets the global finish in shaded mode More...

unsafe int	EnvironmentShadedViewsGroundPlane `[get, set]`
	Returns or sets the ground plane in shaded mode More...

unsafe NXOpen.Plane	EnvironmentShadedViewsGroundPlaneCustom `[get, set]`
	Returns or sets the user defined ground plane in shaded mode More...

unsafe double	EnvironmentShadedViewsGroundPlaneOffset `[get, set]`
	Returns or sets the ground plane offset in shaded mode More...

unsafe double	EnvironmentShadedViewsGroundRefReflectivity `[get, set]`
	Returns or sets the ground floor reflectivity in shaded mode More...

unsafe bool	EnvironmentShadedViewsShowGroundReflection `[get, set]`
	Returns or sets the ground reflection for shaded mode 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...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

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

Member Enumeration Documentation

enum NXOpen.Display.EnvironmentBuilder.GlobalFinishType

Represents global finish types for shaded views

Enumerator
MattePlastic	Matte Plastic global finish effect
ClassicSatin	Classic Satin global finish effect
ShinyPlastic	Shiny Plastic global finish effect
UserDefined	Original global finish effect

enum NXOpen.Display.EnvironmentBuilder.GroundPlaneTypes

Represents an index to a ground plane type define

Enumerator
Yz	Use yz plane for the ground.
Xz	Use xz plane for the ground.
Xy	Use xy plane for the ground.
UserDefined	Use user defined plane for the ground.

enum NXOpen.Display.EnvironmentBuilder.ImageBlurType

lighting image blurr type

Enumerator
None
Low
Medium
High

enum NXOpen.Display.EnvironmentBuilder.ImageUpVectorTypes

up vector type

Enumerator
AlignWithFloorPlane
UserDefined

enum NXOpen.Display.EnvironmentBuilder.ToneMappingTypes

tone mapping type - do not enable until NX11

Enumerator
SystemScene
UserDefined

Member Function Documentation

unsafe void NXOpen.Display.EnvironmentBuilder.AlignFloorPlane ( NXOpen.Plane specifyFloorPlane )

inline

The environment's floor aligns with the given plane.

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

Parameters

specifyFloorPlane

unsafe void NXOpen.Display.EnvironmentBuilder.CommitAndDisplay	(	NXOpen.View	view,
		bool	updateIblDisplay,
		bool	updateEnvCubeDisplay
	)

inline

Saves the attributes and optionally updates the display of image-based lighting

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

Parameters

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 )

inline

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")

Parameters

view

unsafe void NXOpen.Display.EnvironmentBuilder.FloorXaxis ( )

inline

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 ( )

inline

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 ( )

inline

The environment's floor to align with the WCS z-axis

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

Property Documentation

unsafe double NXOpen.Display.EnvironmentBuilder.ColorSaturation

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")

unsafe bool NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsFixGroundPlaneOffset

getset

Returns or sets the ground plane offset in shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsGlobalFinish

getset

Returns or sets the global finish in shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsGroundPlane

getset

Returns or sets the ground plane in shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Plane NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsGroundPlaneCustom

getset

Returns or sets the user defined ground plane in shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsGroundPlaneOffset

getset

Returns or sets the ground plane offset in shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsGroundRefReflectivity

getset

Returns or sets the ground floor reflectivity in shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Display.EnvironmentBuilder.EnvironmentShadedViewsShowGroundReflection

getset

Returns or sets the ground reflection for shaded mode

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Display.EnvironmentBuilder.GroundPlaneTypes NXOpen.Display.EnvironmentBuilder.GroundPlaneType

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.

unsafe bool NXOpen.Display.EnvironmentBuilder.GroundReflection

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")

unsafe bool NXOpen.Display.EnvironmentBuilder.GroundVisibility

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")

unsafe NXOpen.Display.Image NXOpen.Display.EnvironmentBuilder.Image

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")

unsafe NXOpen.Display.EnvironmentBuilder.ImageBlurType NXOpen.Display.EnvironmentBuilder.ImageBlur

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")

unsafe string NXOpen.Display.EnvironmentBuilder.ImageFilename

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")

unsafe double NXOpen.Display.EnvironmentBuilder.ImageRotation

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")

unsafe NXOpen.Direction NXOpen.Display.EnvironmentBuilder.ImageUpVector

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")

unsafe NXOpen.Display.EnvironmentBuilder.ImageUpVectorTypes NXOpen.Display.EnvironmentBuilder.ImageUpVectorType

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")

unsafe double NXOpen.Display.EnvironmentBuilder.LightIntensity

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")

unsafe double NXOpen.Display.EnvironmentBuilder.LwrtAngle

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")

unsafe double NXOpen.Display.EnvironmentBuilder.LwrtIntensity

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")

unsafe double NXOpen.Display.EnvironmentBuilder.LwrtQuality

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")

unsafe NXOpen.Expression NXOpen.Display.EnvironmentBuilder.OffsetExpression

get

Returns the environment offset expression

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

unsafe double NXOpen.Display.EnvironmentBuilder.Reflectivity

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")

unsafe NXOpen.Expression NXOpen.Display.EnvironmentBuilder.SizeExpression

get

Returns the environment size expression

Created in NX10.0.2

License requirements: studio_render ("UG STUDIO RENDER")

unsafe NXOpen.Plane NXOpen.Display.EnvironmentBuilder.SpecifyGroundPlane

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.

unsafe bool NXOpen.Display.EnvironmentBuilder.UseEnvironment

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")

unsafe bool NXOpen.Display.EnvironmentBuilder.UseLightsForShadowCatcherInLwrt

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")

unsafe bool NXOpen.Display.EnvironmentBuilder.UseLwrtEnvironment

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")

unsafe bool NXOpen.Display.EnvironmentBuilder.ViewFitToStage

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")

The documentation for this class was generated from the following file:

Display_EnvironmentBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation