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	BackgroundImageType { Image1, Image2, Image3, Image4, CustomImage }
	Background image types More...

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

enum	ShadedType { SystemBackground, Plain, Graduated, Image }
	background types More...

enum	SystemBackgroundType { White, Light, GraduatedLight, GraduatedDark, Dark, LightImage, DarkImage }
	system background types More...

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

Public Member Functions
unsafe double[]	GetBackgroundShadedViewsGraduatedBottom ()
	Returns the shaded background graduated bottom color More...

unsafe double[]	GetBackgroundShadedViewsGraduatedTop ()
	Returns the shaded background graduated top color More...

unsafe double[]	GetBackgroundShadedViewsPlain ()
	Returns the shaded background plain color More...

unsafe double[]	GetBackgroundWireframeViewsGraduatedBottom ()
	Returns the wireframe background graduated bottom color More...

unsafe double[]	GetBackgroundWireframeViewsGraduatedTop ()
	Returns the wireframe background graduated top color More...

unsafe double[]	GetBackgroundWireframeViewsPlain ()
	Returns the wireframe background plain color More...

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

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

unsafe void	ImageFileSelect ()
	Gets an image file using file selection. More...

unsafe void	SetBackgroundShadedViewsGraduatedBottom (double[] bottomColor)
	Set the shaded background graduated bottom color More...

unsafe void	SetBackgroundShadedViewsGraduatedTop (double[] topColor)
	Set the shaded background graduated top color More...

unsafe void	SetBackgroundShadedViewsPlain (double[] plainColor)
	Set the shaded background plain color More...

unsafe void	SetBackgroundWireframeViewsGraduatedBottom (double[] bottomColor)
	Set the wireframe background graduated bottom color More...

unsafe void	SetBackgroundWireframeViewsGraduatedTop (double[] topColor)
	Set the wireframe background graduated top color More...

unsafe void	SetBackgroundWireframeViewsPlain (double[] plainColor)
	Set the wireframe background plain color More...

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

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

unsafe void	ShadedBackgroundOptionDark ()
	Sets shaded view background to a dark color. More...

unsafe void	ShadedBackgroundOptionDarkImage ()
	Sets shaded view background to use a dark-colored image. More...

unsafe void	ShadedBackgroundOptionGraduatedDark ()
	Sets shaded view background to graduated dark gray. More...

unsafe void	ShadedBackgroundOptionGraduatedLight ()
	Sets shaded view background to graduated light gray. More...

unsafe void	ShadedBackgroundOptionLight ()
	Sets shaded view background to a light color. More...

unsafe void	ShadedBackgroundOptionLightImage ()
	Sets shaded view background to use a light-colored image. More...

unsafe void	ShadedBackgroundOptionWhite ()
	Sets shaded view background to white. More...

unsafe void	WireframeBackgroundOptionDark ()
	Sets wireframe view background to a dark color. More...

unsafe void	WireframeBackgroundOptionGraduatedDark ()
	Sets wireframe view background to graduated dark gray. More...

unsafe void	WireframeBackgroundOptionGraduatedLight ()
	Sets wireframe view background to graduated light gray. More...

unsafe void	WireframeBackgroundOptionLight ()
	Sets wireframe view background to a light color. More...

unsafe void	WireframeBackgroundOptionWhite ()
	Sets wireframe view background to white. 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 int	BackgroundShadedViewsBackgroundImage `[get, set]`
	Returns or sets the shaded background type More...

unsafe int	BackgroundShadedViewsType `[get, set]`
	Returns or sets the shaded background type More...

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

unsafe int	BackgroundWireframeViewsType `[get, set]`
	Returns or sets the wireframe background type More...

unsafe bool	BackgroundWireframeViewsUsedShadedViewsSetting `[get, set]`
	Returns or sets an option to used shaded views setting in wireframe views 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...

Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder	PreviewBuilder `[get]`
	Returns the preview builder subobject. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. 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.BackgroundImageType

Background image types

Enumerator
Image1	Predefined image 1 background
Image2	Predefined image 2 background
Image3	Predefined image 3 background
Image4	Predefined image 4 background
CustomImage	Custom image background

enum NXOpen.Display.Background.CategoryType

background 2D3D types

Enumerator
Flat	2D Background
Dome	3D Dome

enum NXOpen.Display.Background.ShadedType

background types

Enumerator
SystemBackground	a system background
Plain	single color background
Graduated	two color background, which varies between them
Image	an image file displayed in the background

enum NXOpen.Display.Background.SystemBackgroundType

system background types

Enumerator
White	Plain white Colored background
Light	Plain light Colored background
GraduatedLight	Graduated light colored background
GraduatedDark	Graduated dark colored background
Dark	Plain dark Colored background
LightImage	Light theme Iamge background
DarkImage	Dark theme Iamge background

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.GetBackgroundShadedViewsGraduatedBottom ( )

inline

Returns the shaded background graduated bottom color

Created in NX1899.0.0

License requirements: None.

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

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

inline

Returns the shaded background graduated top color

Created in NX1899.0.0

License requirements: None.

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

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

inline

Returns the shaded background plain color

Created in NX1899.0.0

License requirements: None.

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

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

inline

Returns the wireframe background graduated bottom color

Created in NX1899.0.0

License requirements: None.

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

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

inline

Returns the wireframe background graduated top color

Created in NX1899.0.0

License requirements: None.

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

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

inline

Returns the wireframe background plain color

Created in NX1899.0.0

License requirements: None.

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

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.ImageFileSelect ( )

inline

Gets an image file using file selection.

Created in NX1899.0.0

License requirements: None.

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

inline

Set the shaded background graduated bottom color

Created in NX1899.0.0

License requirements: None.

Parameters

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

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

inline

Set the shaded background graduated top color

Created in NX1899.0.0

License requirements: None.

Parameters

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

unsafe void NXOpen.Display.Background.SetBackgroundShadedViewsPlain ( double[] plainColor )

inline

Set the shaded background plain color

Created in NX1899.0.0

License requirements: None.

Parameters

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

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

inline

Set the wireframe background graduated bottom color

Created in NX1899.0.0

License requirements: None.

Parameters

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

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

inline

Set the wireframe background graduated top color

Created in NX1899.0.0

License requirements: None.

Parameters

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

unsafe void NXOpen.Display.Background.SetBackgroundWireframeViewsPlain ( double[] plainColor )

inline

Set the wireframe background plain color

Created in NX1899.0.0

License requirements: None.

Parameters

plainColor 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

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionDark ( )

inline

Sets shaded view background to a dark color.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionDarkImage ( )

inline

Sets shaded view background to use a dark-colored image.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionGraduatedDark ( )

inline

Sets shaded view background to graduated dark gray.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionGraduatedLight ( )

inline

Sets shaded view background to graduated light gray.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionLight ( )

inline

Sets shaded view background to a light color.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionLightImage ( )

inline

Sets shaded view background to use a light-colored image.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.ShadedBackgroundOptionWhite ( )

inline

Sets shaded view background to white.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.WireframeBackgroundOptionDark ( )

inline

Sets wireframe view background to a dark color.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.WireframeBackgroundOptionGraduatedDark ( )

inline

Sets wireframe view background to graduated dark gray.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.WireframeBackgroundOptionGraduatedLight ( )

inline

Sets wireframe view background to graduated light gray.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.WireframeBackgroundOptionLight ( )

inline

Sets wireframe view background to a light color.

Created in NX1899.0.0

License requirements: None.

unsafe void NXOpen.Display.Background.WireframeBackgroundOptionWhite ( )

inline

Sets wireframe view background to white.

Created in NX1899.0.0

License requirements: None.

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