NXOpen::Display::Background Class Reference

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

Inheritance diagram for NXOpen::Display::Background:

Public Types
enum	Type { TypePlain, TypeGraduated, TypeImage, TypeHemiDome }
	background types More...

Public Member Functions
NXOpen::Display::Background::Type	BackgroundType ()
	Returns the background type Created in NX5.0.0.
NXOpen::Display::Image *	DomeImage ()
	Returns the dome background's image builder Created in NX8.5.0.
NXString	DomeImageFilename ()
	Returns the background's dome image filename Created in NX8.5.0.
NXOpen::Point *	DomeOrigin ()
	Returns the origin Created in NX8.5.0.
double	DomeSize ()
	Returns the dome size Created in NX8.5.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.
double	ImageHorizon ()
	Returns the dome image horizon Created in NX8.5.0.
double	ImageRotation ()
	Returns the image rotation angle (in degrees) Created in NX8.5.0.
NXOpen::Direction *	ImageUpVector ()
	Returns the image up vector direction, relative to the absolute coordinate system Created in NX8.5.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	SetDomeImage (NXOpen::Display::Image *domeImageBuilder)
	Sets the dome background's image builder Created in NX8.5.0.
void	SetDomeImageFilename (const NXString &domeImageFileName)
	Sets the background's dome image filename Created in NX8.5.0.
void	SetDomeImageFilename (const char *domeImageFileName)
	Sets the background's dome image filename Created in NX8.5.0.
void	SetDomeOrigin (NXOpen::Point *origin)
	Sets the origin Created in NX8.5.0.
void	SetDomeSize (double domeSize)
	Sets the dome size Created in NX8.5.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	SetImageFilename (const char *imageFileName)
	Sets the background's image filename Created in NX5.0.0.
void	SetImageHorizon (double imageHorizon)
	Sets the dome image horizon Created in NX8.5.0.
void	SetImageRotation (double imageRotation)
	Sets the image rotation angle (in degrees) Created in NX8.5.0.
void	SetImageUpVector (NXOpen::Direction *imageUpVector)
	Sets the image up vector direction, relative to the absolute coordinate system Created in NX8.5.0.
void	SetTopColor (const std::vector< double > &topColor)
	Sets the top color Created in NX5.0.0.
void	SetUseStageSizeAndOrientation (bool StageSizeAndOrientation)
	Sets whether to use stage Size and Orientation Created in NX8.5.0.
bool	UseStageSizeAndOrientation ()
	Returns whether to use stage Size and Orientation Created in NX8.5.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

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.
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 ViewCollection::CreateBackground

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Display::Background::Type

background types

Enumerator:

TypePlain	single color background
TypeGraduated	two color background, which varies between them
TypeImage	an image file displayed in the background
TypeHemiDome	an 3D HDR image displayed in the background

Member Function Documentation

NXOpen::Display::Background::Type NXOpen::Display::Background::BackgroundType

(

)

Returns the background type
Created in NX5.0.0.

License requirements : None

NXOpen::Display::Image* NXOpen::Display::Background::DomeImage

(

)

Returns the dome background's image builder
Created in NX8.5.0.

License requirements : None

NXString NXOpen::Display::Background::DomeImageFilename

(

)

Returns the background's dome image filename
Created in NX8.5.0.

License requirements : None

NXOpen::Point* NXOpen::Display::Background::DomeOrigin

(

)

Returns the origin
Created in NX8.5.0.

License requirements : None

double NXOpen::Display::Background::DomeSize

(

)

Returns the dome size
Created in NX8.5.0.

License requirements : None

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

(

)

Returns the bottom color.

Returns

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

License requirements : None

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

(

)

Returns the top color.

Returns

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

License requirements : None

NXOpen::Display::Image* NXOpen::Display::Background::Image

(

)

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

License requirements : None

NXString NXOpen::Display::Background::ImageFilename

(

)

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

License requirements : None

double NXOpen::Display::Background::ImageHorizon

(

)

Returns the dome image horizon
Created in NX8.5.0.

License requirements : None

double NXOpen::Display::Background::ImageRotation

(

)

Returns the image rotation angle (in degrees)
Created in NX8.5.0.

License requirements : None

NXOpen::Direction* NXOpen::Display::Background::ImageUpVector

(

)

Returns the image up vector direction, relative to the absolute coordinate system
Created in NX8.5.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

Parameters

backgroundType

backgroundtype

void NXOpen::Display::Background::SetBottomColor

(

const std::vector< double > &

bottomColor

)

Sets the bottom color
Created in NX5.0.0.

License requirements : None

Parameters

bottomColor

Array of 3 rgb values, each between 0 and 1

void NXOpen::Display::Background::SetDomeImage

(

NXOpen::Display::Image *

domeImageBuilder

)

Sets the dome background's image builder
Created in NX8.5.0.

License requirements : None

Parameters

domeImageBuilder

dome image builder

void NXOpen::Display::Background::SetDomeImageFilename

(

const NXString &

domeImageFileName

)

Sets the background's dome image filename
Created in NX8.5.0.

License requirements : None

Parameters

domeImageFileName

dome image file name

void NXOpen::Display::Background::SetDomeImageFilename

(

const char *

domeImageFileName

)

Sets the background's dome image filename
Created in NX8.5.0.

License requirements : None

Parameters

domeImageFileName

dome image file name

void NXOpen::Display::Background::SetDomeOrigin

(

NXOpen::Point *

origin

)

Sets the origin
Created in NX8.5.0.

License requirements : None

Parameters

origin

origin

void NXOpen::Display::Background::SetDomeSize

(

double

domeSize

)

Sets the dome size
Created in NX8.5.0.

License requirements : None

Parameters

domeSize

dome size

void NXOpen::Display::Background::SetImage

(

NXOpen::Display::Image *

imageBuilder

)

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

License requirements : None

Parameters

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

Parameters

imageFileName

image file name

void NXOpen::Display::Background::SetImageFilename

(

const char *

imageFileName

)

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

License requirements : None

Parameters

imageFileName

image file name

void NXOpen::Display::Background::SetImageHorizon

(

double

imageHorizon

)

Sets the dome image horizon
Created in NX8.5.0.

License requirements : None

Parameters

imageHorizon

image horizon

void NXOpen::Display::Background::SetImageRotation

(

double

imageRotation

)

Sets the image rotation angle (in degrees)
Created in NX8.5.0.

License requirements : None

Parameters

imageRotation

imagerotation

void NXOpen::Display::Background::SetImageUpVector

(

NXOpen::Direction *

imageUpVector

)

Sets the image up vector direction, relative to the absolute coordinate system
Created in NX8.5.0.

License requirements : None

Parameters

imageUpVector

imageupvector

void NXOpen::Display::Background::SetTopColor

(

const std::vector< double > &

topColor

)

Sets the top color
Created in NX5.0.0.

License requirements : None

Parameters

topColor

Array of 3 rgb values, each between 0 and 1

void NXOpen::Display::Background::SetUseStageSizeAndOrientation

(

bool

StageSizeAndOrientation

)

Sets whether to use stage Size and Orientation
Created in NX8.5.0.

License requirements : None

Parameters

StageSizeAndOrientation

_stage size and orientation

bool NXOpen::Display::Background::UseStageSizeAndOrientation

(

)

Returns whether to use stage Size and Orientation
Created in NX8.5.0.

License requirements : None

---

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

• Display_Background.hxx