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

Inheritance diagram for NXOpen::Display::EnvironmentBuilder:

Public Types
enum	GroundPlaneTypes { GroundPlaneTypesYz, GroundPlaneTypesXz, GroundPlaneTypesXy, GroundPlaneTypesUserDefined }
	Represents an index to a ground plane type define. More...

enum	ImageBlurType { ImageBlurTypeNone, ImageBlurTypeLow, ImageBlurTypeMedium, ImageBlurTypeHigh }
	lighting image blurr type More...

enum	ImageUpVectorTypes { ImageUpVectorTypesAlignWithFloorPlane, ImageUpVectorTypesUserDefined }
	up vector type More...

enum	ToneMappingTypes { ToneMappingTypesSystemScene, ToneMappingTypesUserDefined }
	tone mapping type - do not enable until NX11 More...

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

double	ColorSaturation ()
	Returns the image-based lighting color saturation Created in NX10.0.2. More...

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

void	CommitOffset (NXOpen::View *view)
	Updates the data and display for a change to the ground's offset Created in NX10.0.2. More...

void	FloorXaxis ()
	The environment's floor to align with the WCS x-axis Created in NX10.0.2. More...

void	FloorYaxis ()
	The environment's floor to align with the WCS y-axis Created in NX10.0.2. More...

void	FloorZaxis ()
	The environment's floor to align with the WCS z-axis Created in NX10.0.2. More...

NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes	GroundPlaneType ()
	Returns the ground orientation define Created in NX10.0.2. More...

bool	GroundReflection ()
	Returns whether to enable ground reflection Created in NX10.0.2. More...

bool	GroundVisibility ()
	Returns whether to enable ground visibility or not Created in NX10.0.2. More...

NXOpen::Display::Image *	Image ()
	Returns the image-based lighting's image builder Created in NX10.0.2. More...

NXOpen::Display::EnvironmentBuilder::ImageBlurType	ImageBlur ()
	Returns the blurr of the lighting image Created in NX10.0.2. More...

NXString	ImageFilename ()
	Returns the image filename used for image-based lighting Created in NX10.0.2. More...

double	ImageRotation ()
	Returns the image rotation angle (in degrees) Created in NX10.0.2. More...

NXOpen::Direction *	ImageUpVector ()
	Returns the image up vector direction, relative to the absolute coordinate system Created in NX10.0.2. More...

NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes	ImageUpVectorType ()
	Returns the image up vector define Created in NX10.0.2. More...

double	LightIntensity ()
	Returns the intensity of the light effects Created in NX11.0.0. More...

double	LwrtAngle ()
	Returns the angle of the lwrt image-based lighting light effects Created in NX10.0.2. More...

double	LwrtIntensity ()
	Returns the intensity of the lwrt image-based lighting light effects Created in NX10.0.2. More...

double	LwrtQuality ()
	Returns the quality of the lwrt image-based lighting light effects 1 to 7 Created in NX10.0.2. More...

NXOpen::Expression *	OffsetExpression ()
	Returns the environment offset expression Created in NX10.0.2. More...

double	Reflectivity ()
	Returns the ground reflectivity Created in NX10.0.2. More...

void	SetColorSaturation (double colorSaturation)
	Sets the image-based lighting color saturation Created in NX10.0.2. More...

void	SetGroundPlaneType (NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes planeType)
	Sets the ground orientation define Created in NX10.0.2. More...

void	SetGroundReflection (bool groundReflection)
	Sets whether to enable ground reflection Created in NX10.0.2. More...

void	SetGroundVisibility (bool groundVisibility)
	Sets whether to enable ground visibility or not Created in NX10.0.2. More...

void	SetImage (NXOpen::Display::Image *imageBuilder)
	Sets the image-based lighting's image builder Created in NX10.0.2. More...

void	SetImageBlur (NXOpen::Display::EnvironmentBuilder::ImageBlurType imageBlurr)
	Sets the blurr of the lighting image Created in NX10.0.2. More...

void	SetImageFilename (const NXString &imageFileName)
	Sets the image filename used for image-based lighting Created in NX10.0.2. More...

void	SetImageFilename (const char *imageFileName)
	Sets the image filename used for image-based lighting Created in NX10.0.2. More...

void	SetImageRotation (double imageRotation)
	Sets the image rotation angle (in degrees) Created in NX10.0.2. More...

void	SetImageUpVector (NXOpen::Direction *imageUpVector)
	Sets the image up vector direction, relative to the absolute coordinate system Created in NX10.0.2. More...

void	SetImageUpVectorType (NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes imageUpVector)
	Sets the image up vector define Created in NX10.0.2. More...

void	SetLightIntensity (double lightIntensity)
	Sets the intensity of the light effects Created in NX11.0.0. More...

void	SetLwrtAngle (double lwrtAngle)
	Sets the angle of the lwrt image-based lighting light effects Created in NX10.0.2. More...

void	SetLwrtIntensity (double lwrtIntensity)
	Sets the intensity of the lwrt image-based lighting light effects Created in NX10.0.2. More...

void	SetLwrtQuality (double lwrtQuality)
	Sets the quality of the lwrt image-based lighting light effects 1 to 7 Created in NX10.0.2. More...

void	SetReflectivity (double reflectivity)
	Sets the ground reflectivity Created in NX10.0.2. More...

void	SetSpecifyGroundPlane (NXOpen::Plane *specifyPlane)
	Sets the specify ground plane Created in NX10.0.2. More...

void	SetUseEnvironment (bool useIBL)
	Sets whether image-based lighting (IBL) is enabled Created in NX10.0.2. More...

void	SetUseLightsForShadowCatcherInLwrt (bool useLightsForShadowCatcherInLwrt)
	Sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher Created in NX10.0.2. More...

void	SetUseLwrtEnvironment (bool useLwrtIBL)
	Sets whether image-based lighting is enabled in Advanced Studio (lwrt) display Created in NX10.0.2. More...

void	SetViewFitToStage (bool viewFitToStage)
	Sets whether to fit view to stage Created in NX10.0.2. More...

NXOpen::Expression *	SizeExpression ()
	Returns the environment size expression Created in NX10.0.2. More...

NXOpen::Plane *	SpecifyGroundPlane ()
	Returns the specify ground plane Created in NX10.0.2. More...

bool	UseEnvironment ()
	Returns whether image-based lighting (IBL) is enabled Created in NX10.0.2. More...

bool	UseLightsForShadowCatcherInLwrt ()
	Returns whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher Created in NX10.0.2. More...

bool	UseLwrtEnvironment ()
	Returns whether image-based lighting is enabled in Advanced Studio (lwrt) display Created in NX10.0.2. More...

bool	ViewFitToStage ()
	Returns whether to fit view to stage Created in NX10.0.2. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. 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 NULL.

To create a new instance of this class, use NXOpen::ViewCollection::CreateEnvironmentBuilder

Created in NX10.0.2.

Member Enumeration Documentation

enum NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes

Represents an index to a ground plane type define.

Enumerator
GroundPlaneTypesYz	Use yz plane for the ground.
GroundPlaneTypesXz	Use xz plane for the ground.
GroundPlaneTypesXy	Use xy plane for the ground.
GroundPlaneTypesUserDefined	Use user defined plane for the ground.

enum NXOpen::Display::EnvironmentBuilder::ImageBlurType

lighting image blurr type

Enumerator
ImageBlurTypeNone	none
ImageBlurTypeLow	low
ImageBlurTypeMedium	medium
ImageBlurTypeHigh	high

enum NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes

up vector type

Enumerator
ImageUpVectorTypesAlignWithFloorPlane	align with floor plane
ImageUpVectorTypesUserDefined	user defined

enum NXOpen::Display::EnvironmentBuilder::ToneMappingTypes

tone mapping type - do not enable until NX11

Enumerator
ToneMappingTypesSystemScene	system scene
ToneMappingTypesUserDefined	user defined

Member Function Documentation

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

Parameters

specifyFloorPlane specifyfloorplane

double NXOpen::Display::EnvironmentBuilder::ColorSaturation ( )

Returns the image-based lighting color saturation
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

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

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

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

Parameters

view view

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

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

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

NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes NXOpen::Display::EnvironmentBuilder::GroundPlaneType ( )

Returns the ground orientation define
Created in NX10.0.2.

License requirements : None

bool NXOpen::Display::EnvironmentBuilder::GroundReflection ( )

Returns whether to enable ground reflection
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

bool NXOpen::Display::EnvironmentBuilder::GroundVisibility ( )

Returns whether to enable ground visibility or not
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::Image* NXOpen::Display::EnvironmentBuilder::Image ( )

Returns the image-based lighting's image builder
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::EnvironmentBuilder::ImageBlurType NXOpen::Display::EnvironmentBuilder::ImageBlur ( )

Returns the blurr of the lighting image
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXString NXOpen::Display::EnvironmentBuilder::ImageFilename ( )

Returns the image filename used for image-based lighting
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::EnvironmentBuilder::ImageRotation ( )

Returns the image rotation angle (in degrees)
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Direction* NXOpen::Display::EnvironmentBuilder::ImageUpVector ( )

Returns the image up vector direction, relative to the absolute coordinate system
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes NXOpen::Display::EnvironmentBuilder::ImageUpVectorType ( )

Returns the image up vector define
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::EnvironmentBuilder::LightIntensity ( )

Returns the intensity of the light effects
Created in NX11.0.0.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::EnvironmentBuilder::LwrtAngle ( )

Returns the angle of the lwrt image-based lighting light effects
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::EnvironmentBuilder::LwrtIntensity ( )

Returns the intensity of the lwrt image-based lighting light effects
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::EnvironmentBuilder::LwrtQuality ( )

Returns the quality of the lwrt image-based lighting light effects 1 to 7
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Expression* NXOpen::Display::EnvironmentBuilder::OffsetExpression ( )

Returns the environment offset expression
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

double NXOpen::Display::EnvironmentBuilder::Reflectivity ( )

Returns the ground reflectivity
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

void NXOpen::Display::EnvironmentBuilder::SetColorSaturation ( double colorSaturation )

Sets the image-based lighting color saturation
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

colorSaturation color saturation

void NXOpen::Display::EnvironmentBuilder::SetGroundPlaneType ( NXOpen::Display::EnvironmentBuilder::GroundPlaneTypes planeType )

Sets the ground orientation define
Created in NX10.0.2.

License requirements : None

Parameters

planeType planetype

void NXOpen::Display::EnvironmentBuilder::SetGroundReflection ( bool groundReflection )

Sets whether to enable ground reflection
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

groundReflection groundreflection

void NXOpen::Display::EnvironmentBuilder::SetGroundVisibility ( bool groundVisibility )

Sets whether to enable ground visibility or not
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

groundVisibility groundvisibility

void NXOpen::Display::EnvironmentBuilder::SetImage ( NXOpen::Display::Image * imageBuilder )

Sets the image-based lighting's image builder
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageBuilder image builder

void NXOpen::Display::EnvironmentBuilder::SetImageBlur ( NXOpen::Display::EnvironmentBuilder::ImageBlurType imageBlurr )

Sets the blurr of the lighting image
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageBlurr image blurr

void NXOpen::Display::EnvironmentBuilder::SetImageFilename ( const NXString & imageFileName )

Sets the image filename used for image-based lighting
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageFileName image file name

void NXOpen::Display::EnvironmentBuilder::SetImageFilename ( const char * imageFileName )

Sets the image filename used for image-based lighting
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageFileName image file name

void NXOpen::Display::EnvironmentBuilder::SetImageRotation ( double imageRotation )

Sets the image rotation angle (in degrees)
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageRotation imagerotation

void NXOpen::Display::EnvironmentBuilder::SetImageUpVector ( NXOpen::Direction * imageUpVector )

Sets the image up vector direction, relative to the absolute coordinate system
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageUpVector imageupvector

void NXOpen::Display::EnvironmentBuilder::SetImageUpVectorType ( NXOpen::Display::EnvironmentBuilder::ImageUpVectorTypes imageUpVector )

Sets the image up vector define
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

imageUpVector imageupvector

void NXOpen::Display::EnvironmentBuilder::SetLightIntensity ( double lightIntensity )

Sets the intensity of the light effects
Created in NX11.0.0.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

lightIntensity lightintensity

void NXOpen::Display::EnvironmentBuilder::SetLwrtAngle ( double lwrtAngle )

Sets the angle of the lwrt image-based lighting light effects
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

lwrtAngle lwrt angle

void NXOpen::Display::EnvironmentBuilder::SetLwrtIntensity ( double lwrtIntensity )

Sets the intensity of the lwrt image-based lighting light effects
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

lwrtIntensity lwrt intensity

void NXOpen::Display::EnvironmentBuilder::SetLwrtQuality ( double lwrtQuality )

Sets the quality of the lwrt image-based lighting light effects 1 to 7
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

lwrtQuality lwrt quality

void NXOpen::Display::EnvironmentBuilder::SetReflectivity ( double reflectivity )

Sets the ground reflectivity
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

reflectivity reflectivity

void NXOpen::Display::EnvironmentBuilder::SetSpecifyGroundPlane ( NXOpen::Plane * specifyPlane )

Sets the specify ground plane
Created in NX10.0.2.

License requirements : None

Parameters

specifyPlane specifyplane

void NXOpen::Display::EnvironmentBuilder::SetUseEnvironment ( bool useIBL )

Sets whether image-based lighting (IBL) is enabled
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

useIBL useibl

void NXOpen::Display::EnvironmentBuilder::SetUseLightsForShadowCatcherInLwrt ( bool useLightsForShadowCatcherInLwrt )

Sets whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

useLightsForShadowCatcherInLwrt uselightsforshadowcatcherinlwrt

void NXOpen::Display::EnvironmentBuilder::SetUseLwrtEnvironment ( bool useLwrtIBL )

Sets whether image-based lighting is enabled in Advanced Studio (lwrt) display
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

useLwrtIBL uselwrtibl

void NXOpen::Display::EnvironmentBuilder::SetViewFitToStage ( bool viewFitToStage )

Sets whether to fit view to stage
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

Parameters

viewFitToStage viewfittostage

NXOpen::Expression* NXOpen::Display::EnvironmentBuilder::SizeExpression ( )

Returns the environment size expression
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

NXOpen::Plane* NXOpen::Display::EnvironmentBuilder::SpecifyGroundPlane ( )

Returns the specify ground plane
Created in NX10.0.2.

License requirements : None

bool NXOpen::Display::EnvironmentBuilder::UseEnvironment ( )

Returns whether image-based lighting (IBL) is enabled
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

bool NXOpen::Display::EnvironmentBuilder::UseLightsForShadowCatcherInLwrt ( )

Returns whether Advanced Studio display (lwrt) uses individual light sources or image-based lighting for shadow catcher
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

bool NXOpen::Display::EnvironmentBuilder::UseLwrtEnvironment ( )

Returns whether image-based lighting is enabled in Advanced Studio (lwrt) display
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

bool NXOpen::Display::EnvironmentBuilder::ViewFitToStage ( )

Returns whether to fit view to stage
Created in NX10.0.2.

License requirements : studio_render ("UG STUDIO RENDER")

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

Display_EnvironmentBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation