Background Class¶
-
class
NXOpen.Display.Background¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Display.BackgroundBackground 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. |
Enumerations¶
| BackgroundBackgroundDomeType Enumeration | dome types |
| BackgroundCategoryType Enumeration | background 2D3D types |
| BackgroundType Enumeration | background types |
Property Detail¶
BackgroundCategory¶
-
Background.BackgroundCategory¶ Returns or sets the background 2D or 3D type
-------------------------------------Getter Method
Signature
BackgroundCategoryReturns: Return type: NXOpen.Display.BackgroundCategoryTypeNew in version NX10.0.2.
License requirements: None.
-------------------------------------Setter Method
Signature
BackgroundCategoryParameters: 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
BackgroundTypeReturns: Return type: NXOpen.Display.BackgroundTypeNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BackgroundTypeParameters: 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
DomeImageReturns: Return type: NXOpen.Display.ImageNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DomeImageParameters: 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
DomeImageFilenameReturns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DomeImageFilenameParameters: domeImageFileName (str) – New in version NX8.5.0.
License requirements: None.
DomeOrigin¶
-
Background.DomeOrigin¶ Returns or sets the origin
-------------------------------------Getter Method
Signature
DomeOriginReturns: Return type: NXOpen.PointNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DomeOriginParameters: origin ( NXOpen.Point) –New in version NX8.5.0.
License requirements: None.
DomeSize¶
-
Background.DomeSize¶ Returns or sets the dome size
-------------------------------------Getter Method
Signature
DomeSizeReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DomeSizeParameters: domeSize (float) – New in version NX8.5.0.
License requirements: None.
DomeType¶
-
Background.DomeType¶ Returns or sets the dome type
-------------------------------------Getter Method
Signature
DomeTypeReturns: Return type: NXOpen.Display.BackgroundBackgroundDomeTypeNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DomeTypeParameters: 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
ImageReturns: Return type: NXOpen.Display.ImageNew in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageParameters: 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
ImageFilenameReturns: Return type: str New in version NX5.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageFilenameParameters: imageFileName (str) – New in version NX5.0.0.
License requirements: None.
ImageHorizon¶
-
Background.ImageHorizon¶ Returns or sets the dome image horizon
-------------------------------------Getter Method
Signature
ImageHorizonReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageHorizonParameters: 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
ImageRotationReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageRotationParameters: 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
ImageUpVectorReturns: Return type: NXOpen.DirectionNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageUpVectorParameters: 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
UseStageSizeAndOrientationReturns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseStageSizeAndOrientationParameters: 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.