Background Class

class NXOpen.Display.Background

Bases: NXOpen.Builder

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 None.

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

New in version NX5.0.0.

Properties

Property Description
BackgroundCategory Returns or sets the background 2D or 3D type
BackgroundType Returns or sets the background type
DomeImage Returns or sets the dome background’s image builder
DomeImageFilename Returns or sets the background’s dome image filename
DomeOrigin Returns or sets the origin
DomeSize Returns or sets the dome size
DomeType Returns or sets the dome type
Image Returns or sets the background’s image builder
ImageFilename Returns or sets the background’s image filename
ImageHorizon Returns or sets the dome image horizon
ImageRotation Returns or sets the image rotation angle (in degrees)
ImageUpVector Returns or sets the image up vector direction, relative to the absolute coordinate system
Tag Returns the Tag for this object.
UseStageSizeAndOrientation Returns or sets whether to use stage Size and Orientation

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetBottomColor Returns the bottom color
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetObject Returns the object currently being edited by this builder.
GetTopColor Returns the top color
SetBottomColor Sets the bottom color
SetTopColor Sets the top color
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

BackgroundCategory

Background.BackgroundCategory

Returns or sets the background 2D or 3D type

-------------------------------------

Getter Method

Signature BackgroundCategory

Returns:
Return type:NXOpen.Display.BackgroundCategoryType

New in version NX10.0.2.

License requirements: None.

-------------------------------------

Setter Method

Signature BackgroundCategory

Parameters:backgroundCategoryType (NXOpen.Display.BackgroundCategoryType) –

New in version NX10.0.2.

License requirements: None.

BackgroundType

Background.BackgroundType

Returns or sets the background type

-------------------------------------

Getter Method

Signature BackgroundType

Returns:
Return type:NXOpen.Display.BackgroundType

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BackgroundType

Parameters:backgroundType (NXOpen.Display.BackgroundType) –

New in version NX5.0.0.

License requirements: None.

DomeImage

Background.DomeImage

Returns or sets the dome background’s image builder

-------------------------------------

Getter Method

Signature DomeImage

Returns:
Return type:NXOpen.Display.Image

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DomeImage

Parameters:domeImageBuilder (NXOpen.Display.Image) –

New in version NX8.5.0.

License requirements: None.

DomeImageFilename

Background.DomeImageFilename

Returns or sets the background’s dome image filename

-------------------------------------

Getter Method

Signature DomeImageFilename

Returns:
Return type:str

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DomeImageFilename

Parameters:domeImageFileName (str) –

New in version NX8.5.0.

License requirements: None.

DomeOrigin

Background.DomeOrigin

Returns or sets the origin

-------------------------------------

Getter Method

Signature DomeOrigin

Returns:
Return type:NXOpen.Point

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DomeOrigin

Parameters:origin (NXOpen.Point) –

New in version NX8.5.0.

License requirements: None.

DomeSize

Background.DomeSize

Returns or sets the dome size

-------------------------------------

Getter Method

Signature DomeSize

Returns:
Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DomeSize

Parameters:domeSize (float) –

New in version NX8.5.0.

License requirements: None.

DomeType

Background.DomeType

Returns or sets the dome type

-------------------------------------

Getter Method

Signature DomeType

Returns:
Return type:NXOpen.Display.BackgroundBackgroundDomeType

New in version NX12.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature DomeType

Parameters:domeType (NXOpen.Display.BackgroundBackgroundDomeType) –

New in version NX12.0.0.

License requirements: None.

Image

Background.Image

Returns or sets the background’s image builder

-------------------------------------

Getter Method

Signature Image

Returns:
Return type:NXOpen.Display.Image

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Image

Parameters:imageBuilder (NXOpen.Display.Image) –

New in version NX5.0.0.

License requirements: None.

ImageFilename

Background.ImageFilename

Returns or sets the background’s image filename

-------------------------------------

Getter Method

Signature ImageFilename

Returns:
Return type:str

New in version NX5.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageFilename

Parameters:imageFileName (str) –

New in version NX5.0.0.

License requirements: None.

ImageHorizon

Background.ImageHorizon

Returns or sets the dome image horizon

-------------------------------------

Getter Method

Signature ImageHorizon

Returns:
Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageHorizon

Parameters:imageHorizon (float) –

New in version NX8.5.0.

License requirements: None.

ImageRotation

Background.ImageRotation

Returns or sets the image rotation angle (in degrees)

-------------------------------------

Getter Method

Signature ImageRotation

Returns:
Return type:float

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageRotation

Parameters:imageRotation (float) –

New in version NX8.5.0.

License requirements: None.

ImageUpVector

Background.ImageUpVector

Returns or sets the image up vector direction, relative to the absolute coordinate system

-------------------------------------

Getter Method

Signature ImageUpVector

Returns:
Return type:NXOpen.Direction

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature ImageUpVector

Parameters:imageUpVector (NXOpen.Direction) –

New in version NX8.5.0.

License requirements: None.

UseStageSizeAndOrientation

Background.UseStageSizeAndOrientation

Returns or sets whether to use stage Size and Orientation

-------------------------------------

Getter Method

Signature UseStageSizeAndOrientation

Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseStageSizeAndOrientation

Parameters:StageSizeAndOrientation (bool) –

New in version NX8.5.0.

License requirements: None.

Method Detail

GetBottomColor

Background.GetBottomColor

Returns the bottom color

Signature GetBottomColor()

Returns:Array of 3 rgb values, each between 0 and 1
Return type:list of float

New in version NX5.0.0.

License requirements: None.

GetTopColor

Background.GetTopColor

Returns the top color

Signature GetTopColor()

Returns:Array of 3 rgb values, each between 0 and 1
Return type:list of float

New in version NX5.0.0.

License requirements: None.

SetBottomColor

Background.SetBottomColor

Sets the bottom color

Signature SetBottomColor(bottomColor)

Parameters:bottomColor (list of float) – Array of 3 rgb values, each between 0 and 1

New in version NX5.0.0.

License requirements: None.

SetTopColor

Background.SetTopColor

Sets the top color

Signature SetTopColor(topColor)

Parameters:topColor (list of float) – Array of 3 rgb values, each between 0 and 1

New in version NX5.0.0.

License requirements: None.

Validate

Background.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.