NX Open C++ 参考指南 2406 v1.1
载入中...
搜索中...
未找到
Public 类型 | Public 成员函数 | 友元 | 所有成员列表
NXOpen::Display::Background类 参考

背景 更多...

#include <Display_Background.hxx>

类 NXOpen::Display::Background 继承关系图:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public 类型

enum  BackgroundDomeType { BackgroundDomeTypeFinite , BackgroundDomeTypeInfinite }
enum  BackgroundImageType {
  BackgroundImageTypeLightBackground1 , BackgroundImageTypeLightBackground2 , BackgroundImageTypeDarkBackground1 , BackgroundImageTypeDarkBackground2 ,
  BackgroundImageTypeClassicBackground1 , BackgroundImageTypeClassicBackground2 , BackgroundImageTypeSystemBackground , BackgroundImageTypeCustomImage
}
enum  CategoryType { CategoryTypeFlat , CategoryTypeDome }
enum  ShadedType { ShadedTypeSystemBackground , ShadedTypePlain , ShadedTypeGraduated , ShadedTypeImage }
enum  SystemBackgroundType {
  SystemBackgroundTypeWhite , SystemBackgroundTypeLight , SystemBackgroundTypeGraduatedLight , SystemBackgroundTypeGraduatedDark ,
  SystemBackgroundTypeDark , SystemBackgroundTypeLightImage , SystemBackgroundTypeDarkImage
}
enum  Type { TypePlain , TypeGraduated , TypeImage , TypeHemiDome }

Public 成员函数

NXOpen::Display::Background::CategoryType BackgroundCategory ()
int BackgroundShadedViewsBackgroundImage ()
int BackgroundShadedViewsType ()
NXOpen::Display::Background::Type BackgroundType ()
int BackgroundWireframeViewsType ()
bool BackgroundWireframeViewsUsedShadedViewsSetting ()
NXOpen::Display::Image * DomeImage ()
NXString DomeImageFilename ()
NXOpen::Point * DomeOrigin ()
double DomeSize ()
NXOpen::Display::Background::BackgroundDomeType DomeType ()
std::vector< double > GetBackgroundShadedViewsGraduatedBottom ()
std::vector< double > GetBackgroundShadedViewsGraduatedTop ()
std::vector< double > GetBackgroundShadedViewsPlain ()
std::vector< double > GetBackgroundWireframeViewsGraduatedBottom ()
std::vector< double > GetBackgroundWireframeViewsGraduatedTop ()
std::vector< double > GetBackgroundWireframeViewsPlain ()
std::vector< double > GetBottomColor ()
std::vector< double > GetTopColor ()
NXOpen::Display::Image * Image ()
NXString ImageFilename ()
void ImageFileSelect ()
double ImageHorizon ()
double ImageRotation ()
NXOpen::Direction * ImageUpVector ()
void SetBackgroundCategory (NXOpen::Display::Background::CategoryType backgroundCategoryType)
void SetBackgroundShadedViewsBackgroundImage (int backgroundImgType)
void SetBackgroundShadedViewsGraduatedBottom (const std::vector< double > &bottomColor)
void SetBackgroundShadedViewsGraduatedTop (const std::vector< double > &topColor)
void SetBackgroundShadedViewsPlain (const std::vector< double > &plainColor)
void SetBackgroundShadedViewsType (int backgroundType)
void SetBackgroundType (NXOpen::Display::Background::Type backgroundType)
void SetBackgroundWireframeViewsGraduatedBottom (const std::vector< double > &bottomColor)
void SetBackgroundWireframeViewsGraduatedTop (const std::vector< double > &topColor)
void SetBackgroundWireframeViewsPlain (const std::vector< double > &plainColor)
void SetBackgroundWireframeViewsType (int backgroundType)
void SetBackgroundWireframeViewsUsedShadedViewsSetting (bool useShadedViewsSetting)
void SetBottomColor (const std::vector< double > &bottomColor)
void SetDomeImage (NXOpen::Display::Image *domeImageBuilder)
void SetDomeImageFilename (const char *domeImageFileName)
void SetDomeImageFilename (const NXString &domeImageFileName)
void SetDomeOrigin (NXOpen::Point *origin)
void SetDomeSize (double domeSize)
void SetDomeType (NXOpen::Display::Background::BackgroundDomeType domeType)
void SetImage (NXOpen::Display::Image *imageBuilder)
void SetImageFilename (const char *imageFileName)
void SetImageFilename (const NXString &imageFileName)
void SetImageHorizon (double imageHorizon)
void SetImageRotation (double imageRotation)
void SetImageUpVector (NXOpen::Direction *imageUpVector)
void SetTopColor (const std::vector< double > &topColor)
void SetUseStageSizeAndOrientation (bool StageSizeAndOrientation)
void ShadedBackgroundOptionDark ()
void ShadedBackgroundOptionDarkImage ()
void ShadedBackgroundOptionGraduatedDark ()
void ShadedBackgroundOptionGraduatedLight ()
void ShadedBackgroundOptionLight ()
void ShadedBackgroundOptionLightImage ()
void ShadedBackgroundOptionWhite ()
bool UseStageSizeAndOrientation ()
void WireframeBackgroundOptionDark ()
void WireframeBackgroundOptionGraduatedDark ()
void WireframeBackgroundOptionGraduatedLight ()
void WireframeBackgroundOptionLight ()
void WireframeBackgroundOptionWhite ()
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 _BackgroundBuilder

详细描述

背景

表示 NXOpen::Display::Background 背景定义了背景像素的显示方式。背景位于视图背面的虚拟平面上。此背景用于Studio渲染样式和高质量图像的显示。
此类仅限于在交互式NX会话中运行的程序调用。如果在非交互式会话中运行，将返回NULL。

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

于NX5.0.0版本创建。

成员枚举类型说明

◆ BackgroundDomeType

enum NXOpen::Display::Background::BackgroundDomeType

穹顶类型

枚举值
BackgroundDomeTypeFinite 

有限3D穹顶

BackgroundDomeTypeInfinite 

无限3D穹顶

◆ BackgroundImageType

enum NXOpen::Display::Background::BackgroundImageType

背景图像类型

枚举值
BackgroundImageTypeLightBackground1 

预定义浅色背景1

BackgroundImageTypeLightBackground2 

预定义浅色背景2

BackgroundImageTypeDarkBackground1 

预定义深色背景1

BackgroundImageTypeDarkBackground2 

预定义深色背景2

BackgroundImageTypeClassicBackground1 

预定义经典背景1

BackgroundImageTypeClassicBackground2 

预定义经典背景2

BackgroundImageTypeSystemBackground 

预定义系统背景

BackgroundImageTypeCustomImage 

自定义图像背景

◆ CategoryType

enum NXOpen::Display::Background::CategoryType

背景2D3D类型

枚举值
CategoryTypeFlat 

2D背景

CategoryTypeDome 

3D穹顶

◆ ShadedType

enum NXOpen::Display::Background::ShadedType

背景类型

枚举值
ShadedTypeSystemBackground 

系统背景

ShadedTypePlain 

单色背景

ShadedTypeGraduated 

两色渐变背景

ShadedTypeImage 

显示图像文件的背景

◆ SystemBackgroundType

enum NXOpen::Display::Background::SystemBackgroundType

系统背景类型

枚举值
SystemBackgroundTypeWhite 

纯白色背景

SystemBackgroundTypeLight 

浅纯色背景

SystemBackgroundTypeGraduatedLight 

浅渐变背景

SystemBackgroundTypeGraduatedDark 

深渐变背景

SystemBackgroundTypeDark 

深纯色背景

SystemBackgroundTypeLightImage 

浅色主题图像背景

SystemBackgroundTypeDarkImage 

深色主题图像背景

◆ Type

enum NXOpen::Display::Background::Type

背景类型

枚举值
TypePlain 

单色背景

TypeGraduated 

两色渐变背景

TypeImage 

显示图像文件的背景

TypeHemiDome 

显示3D HDR图像的背景

成员函数说明

◆ BackgroundCategory()

NXOpen::Display::Background::CategoryType NXOpen::Display::Background::BackgroundCategory ( )

返回背景2D或3D类型
在NX10.0.2中创建。

许可证要求 : 无

◆ BackgroundShadedViewsBackgroundImage()

int NXOpen::Display::Background::BackgroundShadedViewsBackgroundImage ( )

获取着色视图的背景图像设置。
创建于NX1899.0.0。

许可证要求：无

◆ BackgroundShadedViewsType()

int NXOpen::Display::Background::BackgroundShadedViewsType ( )

获取着色视图的背景类型。
创建于NX1899.0.0。

许可证要求：无

◆ BackgroundType()

NXOpen::Display::Background::Type NXOpen::Display::Background::BackgroundType ( )

返回背景类型
在NX5.0.0中创建。

许可证要求 : 无

◆ BackgroundWireframeViewsType()

int NXOpen::Display::Background::BackgroundWireframeViewsType ( )

获取线框视图的背景类型。
创建于NX1899.0.0。

许可证要求：无

◆ BackgroundWireframeViewsUsedShadedViewsSetting()

bool NXOpen::Display::Background::BackgroundWireframeViewsUsedShadedViewsSetting ( )

获取是否在线框视图中使用着色视图的背景设置。
创建于NX1899.0.0。

许可证要求：无

◆ DomeImage()

NXOpen::Display::Image * NXOpen::Display::Background::DomeImage ( )

获取穹顶背景的图像构建器
于 NX8.5.0 中创建。

许可证要求：无

◆ DomeImageFilename()

NXString NXOpen::Display::Background::DomeImageFilename ( )

获取背景的穹顶图像文件名
于 NX8.5.0 中创建。

许可证要求：无

◆ DomeOrigin()

NXOpen::Point * NXOpen::Display::Background::DomeOrigin ( )

获取原点
于 NX8.5.0 中创建。

许可证要求：无

◆ DomeSize()

double NXOpen::Display::Background::DomeSize ( )

返回穹顶大小
在NX8.5.0中创建。

许可证要求 : 无

◆ DomeType()

NXOpen::Display::Background::BackgroundDomeType NXOpen::Display::Background::DomeType ( )

获取穹顶类型
于 NX12.0.0 中创建。

许可证要求：无

◆ GetBackgroundShadedViewsGraduatedBottom()

std::vector< double > NXOpen::Display::Background::GetBackgroundShadedViewsGraduatedBottom ( )

获取着色视图的渐变底部颜色。

返回
包含3个RGB值的数组，每个值介于0和1之间。
创建于NX1899.0.0。

许可证要求：无

◆ GetBackgroundShadedViewsGraduatedTop()

std::vector< double > NXOpen::Display::Background::GetBackgroundShadedViewsGraduatedTop ( )

获取着色视图的渐变顶部颜色。

返回
包含3个RGB值的数组，每个值介于0和1之间。
创建于NX1899.0.0。

许可证要求：无

◆ GetBackgroundShadedViewsPlain()

std::vector< double > NXOpen::Display::Background::GetBackgroundShadedViewsPlain ( )

获取着色视图的纯色背景。

返回
包含3个RGB值的数组，每个值介于0和1之间。
创建于NX1899.0.0。

许可证要求：无

◆ GetBackgroundWireframeViewsGraduatedBottom()

std::vector< double > NXOpen::Display::Background::GetBackgroundWireframeViewsGraduatedBottom ( )

获取线框视图背景渐变底部颜色

返回
3个RGB值的数组，每个值在0到1之间
创建于NX1899.0.0.

许可证要求：无

◆ GetBackgroundWireframeViewsGraduatedTop()

std::vector< double > NXOpen::Display::Background::GetBackgroundWireframeViewsGraduatedTop ( )

获取线框视图背景渐变顶部颜色

返回
3个RGB值的数组，每个值在0到1之间
创建于NX1899.0.0.

许可证要求：无

◆ GetBackgroundWireframeViewsPlain()

std::vector< double > NXOpen::Display::Background::GetBackgroundWireframeViewsPlain ( )

获取线框视图的纯色背景。

返回
包含3个RGB值的数组，每个值介于0和1之间。
创建于NX1899.0.0。

许可证要求：无

◆ GetBottomColor()

std::vector< double > NXOpen::Display::Background::GetBottomColor ( )

返回底部颜色

返回
包含3个RGB值的数组，每个值在0到1之间
在NX5.0.0中创建。

许可证要求 : 无

◆ GetTopColor()

std::vector< double > NXOpen::Display::Background::GetTopColor ( )

返回顶部颜色

返回
包含3个RGB值的数组，每个值在0到1之间
在NX5.0.0中创建。

许可证要求 : 无

◆ Image()

NXOpen::Display::Image * NXOpen::Display::Background::Image ( )

返回背景的图像构建器
在NX5.0.0中创建。

许可证要求 : 无

◆ ImageFilename()

NXString NXOpen::Display::Background::ImageFilename ( )

返回背景的图像文件名
在NX5.0.0中创建。

许可证要求 : 无

◆ ImageFileSelect()

void NXOpen::Display::Background::ImageFileSelect ( )

使用文件选择获取图像文件
创建于NX1899.0.0.

许可证要求：无

◆ ImageHorizon()

double NXOpen::Display::Background::ImageHorizon ( )

获取穹顶图像地平线
于 NX8.5.0 中创建。

许可证要求：无

◆ ImageRotation()

double NXOpen::Display::Background::ImageRotation ( )

获取图像旋转角度（以度为单位）
于 NX8.5.0 中创建。

许可证要求：无

◆ ImageUpVector()

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

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

许可证要求：无

◆ SetBackgroundCategory()

void NXOpen::Display::Background::SetBackgroundCategory ( NXOpen::Display::Background::CategoryType backgroundCategoryType)

设置背景2D或3D类型
在NX10.0.2中创建。

许可证要求 : 无

参数
backgroundCategoryType背景类型

◆ SetBackgroundShadedViewsBackgroundImage()

void NXOpen::Display::Background::SetBackgroundShadedViewsBackgroundImage ( int backgroundImgType)

设置着色视图的背景图像类型。
创建于NX1899.0.0。

许可证要求：无

参数
backgroundImgType背景图像类型

◆ SetBackgroundShadedViewsGraduatedBottom()

void NXOpen::Display::Background::SetBackgroundShadedViewsGraduatedBottom ( const std::vector< double > & bottomColor)

设置着色视图的渐变底部颜色。
创建于NX1899.0.0。

许可证要求：无

参数
bottomColor包含3个RGB值的数组，每个值介于0和1之间

◆ SetBackgroundShadedViewsGraduatedTop()

void NXOpen::Display::Background::SetBackgroundShadedViewsGraduatedTop ( const std::vector< double > & topColor)

设置着色视图的渐变顶部颜色。
创建于NX1899.0.0。

许可证要求：无

参数
topColor包含3个RGB值的数组，每个值介于0和1之间

◆ SetBackgroundShadedViewsPlain()

void NXOpen::Display::Background::SetBackgroundShadedViewsPlain ( const std::vector< double > & plainColor)

设置着色视图的纯色背景。
创建于NX1899.0.0。

许可证要求：无

参数
plainColor包含3个RGB值的数组，每个值介于0和1之间

◆ SetBackgroundShadedViewsType()

void NXOpen::Display::Background::SetBackgroundShadedViewsType ( int backgroundType)

设置着色视图的背景类型。
创建于NX1899.0.0。

许可证要求：无

参数
backgroundType背景类型

◆ SetBackgroundType()

void NXOpen::Display::Background::SetBackgroundType ( NXOpen::Display::Background::Type backgroundType)

设置背景类型
在NX5.0.0中创建。

许可证要求 : 无

参数
backgroundType背景类型

◆ SetBackgroundWireframeViewsGraduatedBottom()

void NXOpen::Display::Background::SetBackgroundWireframeViewsGraduatedBottom ( const std::vector< double > & bottomColor)

设置线框视图背景渐变底部颜色
创建于NX1899.0.0.

许可证要求：无

参数
bottomColor3个RGB值的数组，每个值在0到1之间

◆ SetBackgroundWireframeViewsGraduatedTop()

void NXOpen::Display::Background::SetBackgroundWireframeViewsGraduatedTop ( const std::vector< double > & topColor)

设置线框视图背景渐变顶部颜色
创建于NX1899.0.0.

许可证要求：无

参数
topColor3个RGB值的数组，每个值在0到1之间

◆ SetBackgroundWireframeViewsPlain()

void NXOpen::Display::Background::SetBackgroundWireframeViewsPlain ( const std::vector< double > & plainColor)

设置线框视图的纯色背景。
创建于NX1899.0.0。

许可证要求：无

参数
plainColor包含3个RGB值的数组，每个值介于0和1之间

◆ SetBackgroundWireframeViewsType()

void NXOpen::Display::Background::SetBackgroundWireframeViewsType ( int backgroundType)

设置线框视图的背景类型。
创建于NX1899.0.0。

许可证要求：无

参数
backgroundType背景类型

◆ SetBackgroundWireframeViewsUsedShadedViewsSetting()

void NXOpen::Display::Background::SetBackgroundWireframeViewsUsedShadedViewsSetting ( bool useShadedViewsSetting)

设置是否在线框视图中使用着色视图的背景设置。
创建于NX1899.0.0。

许可证要求：无

参数
useShadedViewsSetting是否使用着色视图设置

◆ SetBottomColor()

void NXOpen::Display::Background::SetBottomColor ( const std::vector< double > & bottomColor)

设置底部颜色
在NX5.0.0中创建。

许可证要求 : 无

参数
bottomColor包含3个RGB值的数组，每个值在0到1之间

◆ SetDomeImage()

void NXOpen::Display::Background::SetDomeImage ( NXOpen::Display::Image * domeImageBuilder)

设置穹顶背景的图像构建器
于 NX8.5.0 中创建。

许可证要求：无

参数
domeImageBuilder穹顶图像构建器

◆ SetDomeImageFilename() [1/2]

void NXOpen::Display::Background::SetDomeImageFilename ( const char * domeImageFileName)

设置背景的穹顶图像文件名
于 NX8.5.0 中创建。

许可证要求：无

参数
domeImageFileName穹顶图像文件名

◆ SetDomeImageFilename() [2/2]

void NXOpen::Display::Background::SetDomeImageFilename ( const NXString & domeImageFileName)

设置背景的穹顶图像文件名
于 NX8.5.0 中创建。

许可证要求：无

参数
domeImageFileName穹顶图像文件名

◆ SetDomeOrigin()

void NXOpen::Display::Background::SetDomeOrigin ( NXOpen::Point * origin)

设置原点
于 NX8.5.0 中创建。

许可证要求：无

参数
origin原点

◆ SetDomeSize()

void NXOpen::Display::Background::SetDomeSize ( double domeSize)

设置穹顶大小
于 NX8.5.0 中创建。

许可证要求：无

参数
domeSize穹顶大小

◆ SetDomeType()

void NXOpen::Display::Background::SetDomeType ( NXOpen::Display::Background::BackgroundDomeType domeType)

设置穹顶类型
于 NX12.0.0 中创建。

许可证要求：无

参数
domeType穹顶类型

◆ SetImage()

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

设置背景的图像构建器
在NX5.0.0中创建。

许可证要求 : 无

参数
imageBuilder图像构建器

◆ SetImageFilename() [1/2]

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

设置背景的图像文件名
在NX5.0.0中创建。

许可证要求 : 无

参数
imageFileName图像文件名

◆ SetImageFilename() [2/2]

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

设置背景的图像文件名
在NX5.0.0中创建。

许可证要求 : 无

参数
imageFileName图像文件名

◆ SetImageHorizon()

void NXOpen::Display::Background::SetImageHorizon ( double imageHorizon)

设置穹顶图像地平线
于 NX8.5.0 中创建。

许可证要求：无

参数
imageHorizon穹顶图像地平线

◆ SetImageRotation()

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

设置图像旋转角度（以度为单位）
于 NX8.5.0 中创建。

许可证要求：无

参数
imageRotation图像旋转角度

◆ SetImageUpVector()

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

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

许可证要求：无

参数
imageUpVector图像上向量方向

◆ SetTopColor()

void NXOpen::Display::Background::SetTopColor ( const std::vector< double > & topColor)

设置顶部颜色
在NX5.0.0中创建。

许可证要求 : 无

参数
topColor包含3个RGB值的数组，每个值在0到1之间

◆ SetUseStageSizeAndOrientation()

void NXOpen::Display::Background::SetUseStageSizeAndOrientation ( bool StageSizeAndOrientation)

设置是否使用舞台尺寸和方向
在NX8.5.0中创建。

许可证要求 : 无

参数
StageSizeAndOrientation舞台尺寸和方向

◆ ShadedBackgroundOptionDark()

void NXOpen::Display::Background::ShadedBackgroundOptionDark ( )

将着色视图背景设置为深色
创建于NX1899.0.0.

许可证要求：无

◆ ShadedBackgroundOptionDarkImage()

void NXOpen::Display::Background::ShadedBackgroundOptionDarkImage ( )

将着色视图背景设置为使用深色图像
创建于NX1899.0.0.

许可证要求：无

◆ ShadedBackgroundOptionGraduatedDark()

void NXOpen::Display::Background::ShadedBackgroundOptionGraduatedDark ( )

将着色视图背景设置为渐变深灰色
创建于NX1899.0.0.

许可证要求：无

◆ ShadedBackgroundOptionGraduatedLight()

void NXOpen::Display::Background::ShadedBackgroundOptionGraduatedLight ( )

将着色视图背景设置为渐变浅灰色
创建于NX1899.0.0.

许可证要求：无

◆ ShadedBackgroundOptionLight()

void NXOpen::Display::Background::ShadedBackgroundOptionLight ( )

将着色视图背景设置为浅色
创建于NX1899.0.0.

许可证要求：无

◆ ShadedBackgroundOptionLightImage()

void NXOpen::Display::Background::ShadedBackgroundOptionLightImage ( )

将着色视图背景设置为使用浅色图像
创建于NX1899.0.0.

许可证要求：无

◆ ShadedBackgroundOptionWhite()

void NXOpen::Display::Background::ShadedBackgroundOptionWhite ( )

将着色视图背景设置为白色
创建于NX1899.0.0.

许可证要求：无

◆ UseStageSizeAndOrientation()

bool NXOpen::Display::Background::UseStageSizeAndOrientation ( )

返回是否使用舞台尺寸和方向
在NX8.5.0中创建。

许可证要求 : 无

◆ WireframeBackgroundOptionDark()

void NXOpen::Display::Background::WireframeBackgroundOptionDark ( )

将线框视图背景设置为深色
创建于NX1899.0.0.

许可证要求：无

◆ WireframeBackgroundOptionGraduatedDark()

void NXOpen::Display::Background::WireframeBackgroundOptionGraduatedDark ( )

将线框视图背景设置为渐变深灰色
创建于NX1899.0.0.

许可证要求：无

◆ WireframeBackgroundOptionGraduatedLight()

void NXOpen::Display::Background::WireframeBackgroundOptionGraduatedLight ( )

将线框视图背景设置为渐变浅灰色
创建于NX1899.0.0.

许可证要求：无

◆ WireframeBackgroundOptionLight()

void NXOpen::Display::Background::WireframeBackgroundOptionLight ( )

将线框视图背景设置为浅色
创建于NX1899.0.0.

许可证要求：无

◆ WireframeBackgroundOptionWhite()

void NXOpen::Display::Background::WireframeBackgroundOptionWhite ( )

将线框视图背景设置为白色
创建于NX1899.0.0.

许可证要求：无