基于图像的照明类更多...

#include <Display_ImageBasedLighting.hxx>

类 NXOpen::Display::ImageBasedLighting 继承关系图:

Public 类型
enum	ImageBlurType { ImageBlurTypeNone , ImageBlurTypeLow , ImageBlurTypeMedium , ImageBlurTypeHigh }
enum	ImagesType { ImagesTypeBackground , ImagesTypeStage , ImagesTypeUserDefined , ImagesTypeLightingOnly }
enum	ImageUpVectorTypes { ImageUpVectorTypesAlignWithFloorPlane , ImageUpVectorTypesUserDefined }
enum	ShadowsType { ShadowsTypeNone , ShadowsTypeSoftEdged , ShadowsTypeHardEdged , ShadowsTypeTranslucentHard }

Public 成员函数
double	Accuracy ()
double	ColorSaturation ()
void	CommitAndDisplay (NXOpen::View *view, bool updateDisplay)
NXOpen::Display::Image *	Image ()
NXOpen::Display::ImageBasedLighting::ImageBlurType	ImageBlur ()
NXString	ImageFilename ()
double	ImageRotation ()
NXOpen::Display::ImageBasedLighting::ImagesType	ImageType ()
NXOpen::Direction *	ImageUpVector ()
NXOpen::Display::ImageBasedLighting::ImageUpVectorTypes	ImageUpVectorType ()
double	Intensity ()
double	LwrtAngle ()
double	LwrtIntensity ()
double	LwrtQuality ()
void	SetAccuracy (double accuracy)
void	SetColorSaturation (double colorSaturation)
void	SetImage (NXOpen::Display::Image *imageBuilder)
void	SetImageBlur (NXOpen::Display::ImageBasedLighting::ImageBlurType imageBlurr)
void	SetImageFilename (const char *imageFileName)
void	SetImageFilename (const NXString &imageFileName)
void	SetImageRotation (double imageRotation)
void	SetImageType (NXOpen::Display::ImageBasedLighting::ImagesType imageType)
void	SetImageUpVector (NXOpen::Direction *imageUpVector)
void	SetImageUpVectorType (NXOpen::Display::ImageBasedLighting::ImageUpVectorTypes imageUpVector)
void	SetIntensity (double intensity)
void	SetLwrtAngle (double lwrtAngle)
void	SetLwrtIntensity (double lwrtIntensity)
void	SetLwrtQuality (double lwrtQuality)
void	SetShadowSoftness (double shadowSoftness)
void	SetShadowType (NXOpen::Display::ImageBasedLighting::ShadowsType shadowType)
void	SetUseImageBasedLighting (bool useIBL)
void	SetUseLightsForShadowCatcherInHqi (bool useLightsForShadowCatcherInHqi)
void	SetUseLightsForShadowCatcherInLwrt (bool useLightsForShadowCatcherInLwrt)
void	SetUseLwrtImageBasedLighting (bool useLwrtIBL)
double	ShadowSoftness ()
NXOpen::Display::ImageBasedLighting::ShadowsType	ShadowType ()
bool	UseImageBasedLighting ()
bool	UseLightsForShadowCatcherInHqi ()
bool	UseLightsForShadowCatcherInLwrt ()
bool	UseLwrtImageBasedLighting ()
Public 成员函数继承自 NXOpen::Builder
NXOpen::NXObject *	Commit ()
void	Destroy ()
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
NXOpen::NXObject *	GetObject ()
NXOpen::PreviewBuilder *	PreviewBuilder ()
void	ShowResults ()
virtual bool	Validate ()
Public 成员函数继承自 NXOpen::TaggedObject
tag_t	Tag () const

友元
class	_ImageBasedLightingBuilder

详细描述

基于图像的照明类

表示 NXOpen::Display::ImageBasedLighting 基于图像的光照（IBL）仅在高质量图像渲染中执行。IBL使用来自给定图像的光照效果替换场景中的光源。
此类限制在交互式NX会话期间运行的程序中调用。如果从非交互式会话运行，它将返回NULL。

要创建此类的新实例，请使用 NXOpen::ViewCollection::CreateImageBasedLighting

创建于NX5.0.0。

成员枚举类型说明

◆ ImageBlurType

enum NXOpen::Display::ImageBasedLighting::ImageBlurType

光照图像模糊类型

枚举值
ImageBlurTypeNone	无
ImageBlurTypeLow	低
ImageBlurTypeMedium	中
ImageBlurTypeHigh	高

◆ ImagesType

enum NXOpen::Display::ImageBasedLighting::ImagesType

图像类型 - 用于生成基于图像的光照的环境

枚举值
ImagesTypeBackground	使用背景图像。
ImagesTypeStage	使用场景。
ImagesTypeUserDefined	使用指定的图像文件。
ImagesTypeLightingOnly	仅用于IBL

◆ ImageUpVectorTypes

enum NXOpen::Display::ImageBasedLighting::ImageUpVectorTypes

上向量类型

枚举值
ImageUpVectorTypesAlignWithFloorPlane	与地板平面对齐
ImageUpVectorTypesUserDefined	用户定义

◆ ShadowsType

enum NXOpen::Display::ImageBasedLighting::ShadowsType

阴影类型

枚举值
ShadowsTypeNone	不产生阴影。
ShadowsTypeSoftEdged	使用阴影映射算法生成柔和边缘的近似阴影。
ShadowsTypeHardEdged	使用光线跟踪算法生成硬边缘的精确阴影。
ShadowsTypeTranslucentHard	使用光线跟踪算法生成硬边缘的精确阴影。也会生成半透明对象的阴影，其颜色由透明对象的颜色决定。

成员函数说明

◆ Accuracy()

double NXOpen::Display::ImageBasedLighting::Accuracy ( )

获取由给定图像产生的照明和阴影的精度
创建于NX5.0.0。

许可要求 : 无

◆ ColorSaturation()

double NXOpen::Display::ImageBasedLighting::ColorSaturation ( )

返回基于图像的照明的颜色饱和度
于 NX8.5.0 中创建。

许可证要求：无

◆ CommitAndDisplay()

void NXOpen::Display::ImageBasedLighting::CommitAndDisplay	(	NXOpen::View *	view,
		bool	updateDisplay )

保存属性并可选地更新基于图像照明的显示
创建于 NX5.0.0。

许可要求:无

参数

view	基于图像照明属性的视图
updateDisplay	是否更新显示

◆ Image()

NXOpen::Display::Image * NXOpen::Display::ImageBasedLighting::Image ( )

获取基于图像的照明的图像构建器
创建于 NX5.0.0。

许可要求:无

◆ ImageBlur()

NXOpen::Display::ImageBasedLighting::ImageBlurType NXOpen::Display::ImageBasedLighting::ImageBlur ( )

获取照明图像的模糊类型
创建于 NX8.0.0。

许可要求:无

◆ ImageFilename()

NXString NXOpen::Display::ImageBasedLighting::ImageFilename ( )

获取用于基于图像照明的图像文件名
创建于 NX5.0.0。

许可要求:无

◆ ImageRotation()

double NXOpen::Display::ImageBasedLighting::ImageRotation ( )

获取图像旋转角度(单位:度)
创建于NX5.0.0。

许可要求 : 无

◆ ImageType()

NXOpen::Display::ImageBasedLighting::ImagesType NXOpen::Display::ImageBasedLighting::ImageType ( )

获取图像类型
创建于NX5.0.0。

许可要求 : 无

◆ ImageUpVector()

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

获取图像向上向量方向，相对于绝对坐标系
创建于NX5.0.0。

许可要求 : 无

◆ ImageUpVectorType()

NXOpen::Display::ImageBasedLighting::ImageUpVectorTypes NXOpen::Display::ImageBasedLighting::ImageUpVectorType ( )

获取图像向上向量定义
创建于NX10.0.0。

许可要求 : 无

◆ Intensity()

double NXOpen::Display::ImageBasedLighting::Intensity ( )

获取基于图像的照明光效强度
创建于NX5.0.0。

许可要求 : 无

◆ LwrtAngle()

double NXOpen::Display::ImageBasedLighting::LwrtAngle ( )

获取高级工作室基于图像照明光效的角度
创建于 NX8.0.0。

许可要求:无

◆ LwrtIntensity()

double NXOpen::Display::ImageBasedLighting::LwrtIntensity ( )

获取高级工作室基于图像照明光效的强度
创建于 NX8.0.0。

许可要求:无

◆ LwrtQuality()

double NXOpen::Display::ImageBasedLighting::LwrtQuality ( )

获取高级工作室基于图像照明光效的质量（1到7）
创建于 NX8.0.0。

许可要求:无

◆ SetAccuracy()

void NXOpen::Display::ImageBasedLighting::SetAccuracy ( double accuracy )

设置由给定图像产生的照明和阴影的精度
创建于NX5.0.0。

许可要求 : 无

参数

accuracy accuracy

◆ SetColorSaturation()

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

设置基于图像的照明的颜色饱和度
于 NX8.5.0 中创建。

许可证要求：无

参数

colorSaturation color saturation

◆ SetImage()

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

设置基于图像的照明的图像构建器
创建于 NX5.0.0。

许可要求:无

参数

imageBuilder 图像构建器

◆ SetImageBlur()

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

设置照明图像的模糊类型
创建于 NX8.0.0。

许可要求:无

参数

imageBlurr 照明图像模糊类型

◆ SetImageFilename() [1/2]

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

设置用于基于图像照明的图像文件名
创建于 NX5.0.0。

许可要求:无

参数

imageFileName 图像文件名

◆ SetImageFilename() [2/2]

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

设置用于基于图像照明的图像文件名
创建于 NX5.0.0。

许可要求:无

参数

imageFileName 图像文件名

◆ SetImageRotation()

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

设置图像旋转角度(单位:度)
创建于NX5.0.0。

许可要求 : 无

参数

imageRotation imagerotation

◆ SetImageType()

void NXOpen::Display::ImageBasedLighting::SetImageType ( NXOpen::Display::ImageBasedLighting::ImagesType imageType )

设置图像类型
创建于NX5.0.0。

许可要求 : 无

参数

imageType image type

◆ SetImageUpVector()

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

设置图像向上向量方向，相对于绝对坐标系
创建于NX5.0.0。

许可要求 : 无

参数

imageUpVector imageupvector

◆ SetImageUpVectorType()

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

设置图像向上向量定义
创建于NX10.0.0。

许可要求 : 无

参数

imageUpVector imageupvector

◆ SetIntensity()

void NXOpen::Display::ImageBasedLighting::SetIntensity ( double intensity )

设置基于图像的照明光效强度
创建于NX5.0.0。

许可要求 : 无

参数

intensity intensity

◆ SetLwrtAngle()

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

设置高级工作室基于图像照明光效的角度
创建于 NX8.0.0。

许可要求:无

参数

lwrtAngle 高级工作室照明角度

◆ SetLwrtIntensity()

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

设置高级工作室基于图像照明光效的强度
创建于 NX8.0.0。

许可要求:无

参数

lwrtIntensity 高级工作室照明强度

◆ SetLwrtQuality()

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

设置高级工作室基于图像照明光效的质量（1到7）
创建于 NX8.0.0。

许可要求:无

参数

lwrtQuality 高级工作室照明质量

◆ SetShadowSoftness()

void NXOpen::Display::ImageBasedLighting::SetShadowSoftness ( double shadowSoftness )

设置基于图像的照明的阴影柔和度
于 NX8.5.0 中创建。

许可证要求：无

参数

shadowSoftness shadow softness

◆ SetShadowType()

void NXOpen::Display::ImageBasedLighting::SetShadowType ( NXOpen::Display::ImageBasedLighting::ShadowsType shadowType )

设置阴影类型
创建于NX5.0.0。

许可要求 : 无

参数

shadowType shadow type

◆ SetUseImageBasedLighting()

void NXOpen::Display::ImageBasedLighting::SetUseImageBasedLighting ( bool useIBL )

设置是否启用基于图像的照明(IBL)
创建于NX5.0.0。

许可要求 : 无

参数

useIBL useibl

◆ SetUseLightsForShadowCatcherInHqi()

void NXOpen::Display::ImageBasedLighting::SetUseLightsForShadowCatcherInHqi ( bool useLightsForShadowCatcherInHqi )

设置高质量图像生成（HQI）是否对阴影捕捉使用单独的光源或基于图像的照明
于 NX8.0.0 中创建。

许可证要求：无

参数

useLightsForShadowCatcherInHqi uselightsforshadowcatcherinhqi

◆ SetUseLightsForShadowCatcherInLwrt()

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

设置高级工作室显示（lwrt）是否对阴影捕捉使用单独的光源或基于图像的照明
于 NX8.0.0 中创建。

许可证要求：无

参数

useLightsForShadowCatcherInLwrt uselightsforshadowcatcherinlwrt

◆ SetUseLwrtImageBasedLighting()

void NXOpen::Display::ImageBasedLighting::SetUseLwrtImageBasedLighting ( bool useLwrtIBL )

设置高级工作室（lwrt）显示中是否启用基于图像的照明
创建于 NX8.0.0。

许可要求:无

参数

useLwrtIBL 是否启用高级工作室基于图像的照明

◆ ShadowSoftness()

double NXOpen::Display::ImageBasedLighting::ShadowSoftness ( )

返回基于图像的照明的阴影柔和度
于 NX8.5.0 中创建。

许可证要求：无

◆ ShadowType()

NXOpen::Display::ImageBasedLighting::ShadowsType NXOpen::Display::ImageBasedLighting::ShadowType ( )

获取阴影类型
创建于NX5.0.0。

许可要求 : 无

◆ UseImageBasedLighting()

bool NXOpen::Display::ImageBasedLighting::UseImageBasedLighting ( )

获取是否启用基于图像的照明(IBL)
创建于NX5.0.0。

许可要求 : 无

◆ UseLightsForShadowCatcherInHqi()

bool NXOpen::Display::ImageBasedLighting::UseLightsForShadowCatcherInHqi ( )

返回高质量图像生成（HQI）是否对阴影捕捉使用单独的光源或基于图像的照明
于 NX8.0.0 中创建。

许可证要求：无

◆ UseLightsForShadowCatcherInLwrt()

bool NXOpen::Display::ImageBasedLighting::UseLightsForShadowCatcherInLwrt ( )

返回高级工作室显示（lwrt）是否对阴影捕捉使用单独的光源或基于图像的照明
于 NX8.0.0 中创建。

许可证要求：无

◆ UseLwrtImageBasedLighting()

bool NXOpen::Display::ImageBasedLighting::UseLwrtImageBasedLighting ( )

获取高级工作室（lwrt）显示中是否启用基于图像的照明
创建于 NX8.0.0。

许可要求:无

Public 类型

Public 成员函数

友元

详细描述

成员枚举类型说明

◆ ImageBlurType

◆ ImagesType

◆ ImageUpVectorTypes

◆ ShadowsType

成员函数说明

◆ Accuracy()

◆ ColorSaturation()

◆ CommitAndDisplay()

◆ Image()

◆ ImageBlur()

◆ ImageFilename()

◆ ImageRotation()

◆ ImageType()

◆ ImageUpVector()

◆ ImageUpVectorType()

◆ Intensity()

◆ LwrtAngle()

◆ LwrtIntensity()

◆ LwrtQuality()

◆ SetAccuracy()

◆ SetColorSaturation()

◆ SetImage()

◆ SetImageBlur()

◆ SetImageFilename() [1/2]

◆ SetImageFilename() [2/2]

◆ SetImageRotation()

◆ SetImageType()

◆ SetImageUpVector()

◆ SetImageUpVectorType()

◆ SetIntensity()

◆ SetLwrtAngle()

◆ SetLwrtIntensity()

◆ SetLwrtQuality()

◆ SetShadowSoftness()

◆ SetShadowType()

◆ SetUseImageBasedLighting()

◆ SetUseLightsForShadowCatcherInHqi()

◆ SetUseLightsForShadowCatcherInLwrt()

◆ SetUseLwrtImageBasedLighting()

◆ ShadowSoftness()

◆ ShadowType()

◆ UseImageBasedLighting()

◆ UseLightsForShadowCatcherInHqi()

◆ UseLightsForShadowCatcherInLwrt()

◆ UseLwrtImageBasedLighting()