NX Open C++ Reference Guide
|
Represents a Display::Background Background defines how background pixels are displayed. More...
Public Types | |
enum | Type { TypePlain, TypeGraduated, TypeImage } |
background types More... | |
Public Member Functions | |
NXOpen::Display::Background::Type | BackgroundType () |
Returns the background type Created in NX5.0.0. | |
std::vector< double > | GetBottomColor () |
Returns the bottom color. | |
std::vector< double > | GetTopColor () |
Returns the top color. | |
NXOpen::Display::Image * | Image () |
Returns the background's image builder Created in NX5.0.0. | |
NXString | ImageFilename () |
Returns the background's image filename Created in NX5.0.0. | |
void | SetBackgroundType (NXOpen::Display::Background::Type backgroundType) |
Sets the background type Created in NX5.0.0. | |
void | SetBottomColor (const std::vector< double > &bottomColor) |
Sets the bottom color Created in NX5.0.0. | |
void | SetImage (NXOpen::Display::Image *imageBuilder) |
Sets the background's image builder Created in NX5.0.0. | |
void | SetImageFilename (const NXString &imageFileName) |
Sets the background's image filename Created in NX5.0.0. | |
void | SetTopColor (const std::vector< double > &topColor) |
Sets the top color Created in NX5.0.0. |
Represents a Display::Background Background defines how background pixels are displayed.
The background resides on a virtual plane at the back of a view. This background is used for display in Studio rendering style and High Quality Images.
To create a new instance of this class, use ViewCollection::CreateBackground
Created in NX5.0.0.
Returns the background type
Created in NX5.0.0.
License requirements : None
std::vector<double> NXOpen::Display::Background::GetBottomColor | ( | ) |
Returns the bottom color.
std::vector<double> NXOpen::Display::Background::GetTopColor | ( | ) |
Returns the top color.
Returns the background's image builder
Created in NX5.0.0.
License requirements : None
Returns the background's image filename
Created in NX5.0.0.
License requirements : None
void NXOpen::Display::Background::SetBackgroundType | ( | NXOpen::Display::Background::Type | backgroundType | ) |
Sets the background type
Created in NX5.0.0.
License requirements : None
backgroundType | backgroundtype |
void NXOpen::Display::Background::SetBottomColor | ( | const std::vector< double > & | bottomColor | ) |
Sets the bottom color
Created in NX5.0.0.
License requirements : None
bottomColor | Array of 3 rgb values, each between 0 and 1 |
void NXOpen::Display::Background::SetImage | ( | NXOpen::Display::Image * | imageBuilder | ) |
Sets the background's image builder
Created in NX5.0.0.
License requirements : None
imageBuilder | image builder |
void NXOpen::Display::Background::SetImageFilename | ( | const NXString & | imageFileName | ) |
Sets the background's image filename
Created in NX5.0.0.
License requirements : None
imageFileName | image file name |
void NXOpen::Display::Background::SetTopColor | ( | const std::vector< double > & | topColor | ) |
Sets the top color
Created in NX5.0.0.
License requirements : None
topColor | Array of 3 rgb values, each between 0 and 1 |