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

Inheritance diagram for NXOpen.Display.Background:

Public Types
enum	BackgroundDomeType { Finite, Infinite }
	dome types More...

enum	CategoryType { Flat, Dome }
	background 2D3D types More...

enum	Type { Plain, Graduated, Image, HemiDome }
	background types More...

Public Member Functions
unsafe double[]	GetBottomColor ()
	Returns the bottom color More...

unsafe double[]	GetTopColor ()
	Returns the top color More...

unsafe void	SetBottomColor (double[] bottomColor)
	Sets the bottom color More...

unsafe void	SetTopColor (double[] topColor)
	Sets the top color More...

Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject	Commit ()
	Commits any edits that have been applied to the builder. More...

unsafe void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

unsafe NXOpen.NXObject[]	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

unsafe NXOpen.NXObject	GetObject ()
	Returns the object currently being edited by this builder. More...

unsafe void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

unsafe bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Display.Background.CategoryType	BackgroundCategory `[get, set]`
	Returns or sets the background 2D or 3D type More...

unsafe NXOpen.Display.Background.Type	BackgroundType `[get, set]`
	Returns or sets the background type More...

unsafe NXOpen.Display.Image	DomeImage `[get, set]`
	Returns or sets the dome background's image builder More...

unsafe string	DomeImageFilename `[get, set]`
	Returns or sets the background's dome image filename More...

unsafe NXOpen.Point	DomeOrigin `[get, set]`
	Returns or sets the origin More...

unsafe double	DomeSize `[get, set]`
	Returns or sets the dome size More...

unsafe NXOpen.Display.Background.BackgroundDomeType	DomeType `[get, set]`
	Returns or sets the dome type More...

unsafe NXOpen.Display.Image	Image `[get, set]`
	Returns or sets the background's image builder More...

unsafe string	ImageFilename `[get, set]`
	Returns or sets the background's image filename More...

unsafe double	ImageHorizon `[get, set]`
	Returns or sets the dome image horizon More...

unsafe double	ImageRotation `[get, set]`
	Returns or sets the image rotation angle (in degrees) More...

unsafe NXOpen.Direction	ImageUpVector `[get, set]`
	Returns or sets the image up vector direction, relative to the absolute coordinate system More...

unsafe bool	UseStageSizeAndOrientation `[get, set]`
	Returns or sets whether to use stage Size and Orientation More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a NXOpen.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 a null reference (Nothing in Visual Basic).

To create a new instance of this class, use NXOpen.ViewCollection.CreateBackground

Created in NX5.0.0

Member Enumeration Documentation

enum NXOpen.Display.Background.BackgroundDomeType

dome types

Enumerator
Finite	finite 3D dome
Infinite	infinite 3D dome

enum NXOpen.Display.Background.CategoryType

background 2D3D types

Enumerator
Flat	2D Background
Dome	3D Dome

enum NXOpen.Display.Background.Type

background types

Enumerator
Plain	single color background
Graduated	two color background, which varies between them
Image	an image file displayed in the background
HemiDome	an 3D HDR image displayed in the background

Member Function Documentation

unsafe double [] NXOpen.Display.Background.GetBottomColor ( )

inline

Returns the bottom color

Created in NX5.0.0

License requirements: None.

Returns: Array of 3 rgb values, each between 0 and 1

unsafe double [] NXOpen.Display.Background.GetTopColor ( )

inline

Returns the top color

Created in NX5.0.0

License requirements: None.

Returns: Array of 3 rgb values, each between 0 and 1

unsafe void NXOpen.Display.Background.SetBottomColor ( double[] bottomColor )

inline

Sets the bottom color

Created in NX5.0.0

License requirements: None.

Parameters

bottomColor Array of 3 rgb values, each between 0 and 1

unsafe void NXOpen.Display.Background.SetTopColor ( double[] topColor )

inline

Sets the top color

Created in NX5.0.0

License requirements: None.

Parameters

topColor Array of 3 rgb values, each between 0 and 1

Property Documentation

unsafe NXOpen.Display.Background.CategoryType NXOpen.Display.Background.BackgroundCategory

getset

Returns or sets the background 2D or 3D type

Created in NX10.0.2