NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::Background Class Reference

Represents a Display::Background Background defines how background pixels are displayed. More...

Inheritance diagram for NXOpen::Display::Background:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::ImageImage ()
 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.

Detailed Description

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.


Member Enumeration Documentation

background types

Enumerator:
TypePlain 

single color background

TypeGraduated 

two color background, which varies between them

TypeImage 

an image file displayed in the background


Member Function Documentation

Returns the background type
Created in NX5.0.0.



License requirements : None

Returns the bottom color.

Returns:
Array of 3 rgb values, each between 0 and 1
Created in NX5.0.0.

License requirements : None

Returns the top color.

Returns:
Array of 3 rgb values, each between 0 and 1
Created in NX5.0.0.

License requirements : None

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

Sets the background type
Created in NX5.0.0.



License requirements : None

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

Sets the bottom color
Created in NX5.0.0.



License requirements : None

Parameters:
bottomColorArray of 3 rgb values, each between 0 and 1

Sets the background's image builder
Created in NX5.0.0.



License requirements : None

Parameters:
imageBuilderimage builder

Sets the background's image filename
Created in NX5.0.0.



License requirements : None

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

Sets the top color
Created in NX5.0.0.



License requirements : None

Parameters:
topColorArray of 3 rgb values, each between 0 and 1

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.