ImageTestBuilder Class¶
-
class
NXOpen.Display.ImageTestBuilder¶ Bases:
NXOpen.BuilderSupports debug dialog UGS::DebugUI::UICompImageTest which is used to test Gateway::ImageIO, DSS, CGP, AW2D, and CGM image functionality.
To create a new instance of this class, use
NXOpen.DebugSession.CreateImageTestBuilder()New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| DeletePreviousImages | Returns or sets the Delete Previous Images setting. |
| DisplayFormat | Returns or sets the Format used to display the image. |
| DrawBorder | Returns or sets the DrawBorder setting. |
| ExtraAttribute | Returns or sets the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window. |
| ImageDetails | Returns or sets the image details |
| ImageFile | Returns or sets the path of the image file. |
| MatrixVectors | Returns or sets the matrix vectors |
| OriginLocation | Returns or sets the location on the image that represents its origin. |
| PixelFormat | Returns or sets the Format of the image. |
| PixelsPerInch | Returns or sets the Pixels Per Inch setting. |
| SubimageRectangleHeight | Returns or sets the height of the SubimageRectangle. |
| SubimageRectangleWidth | Returns or sets the width of the SubimageRectangle. |
| SubimageRectangleX | Returns or sets the X coordinate of the upper-left corner of the SubimageRectangle. |
| SubimageRectangleY | Returns or sets the Y coordinate of the upper-left corner of the SubimageRectangle. |
| SuppressDeEmphasis | Returns or sets the SuppressDeEmphasis setting. |
| SuppressSmoothing | Returns or sets the SuppressSmoothing setting. |
| Tag | Returns the Tag for this object. |
| Translucency | Returns or sets the Translucency setting. |
| UseTransparencyPixel | Returns or sets the UseTransparencyPixel setting. |
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. |
| GetBackgroundColor | Returns the BackgroundColor. |
| GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
| GetForegroundColor | Returns the ForegroundColor. |
| GetObject | Returns the object currently being edited by this builder. |
| GetTransparencyPixel | Returns the TransparencyPixel. |
| SetBackgroundColor | Sets the BackgroundColor. |
| SetForegroundColor | Sets the ForegroundColor. |
| SetTransparencyPixel | Sets the TransparencyPixel. |
| 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¶
| ImageTestBuilderAttributeType Enumeration | Indicates the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window. |
| ImageTestBuilderFormatType Enumeration | Indicates the Format used to display the image. |
| ImageTestBuilderOriginLocationType Enumeration | Indicates the location on the image that represents its origin. |
Property Detail¶
DeletePreviousImages¶
-
ImageTestBuilder.DeletePreviousImages¶ Returns or sets the Delete Previous Images setting.
-------------------------------------Getter Method
Signature
DeletePreviousImages()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DeletePreviousImages(deletePreviousImages)Parameters: deletePreviousImages (bool) – New in version NX9.0.0.
License requirements: None.
DisplayFormat¶
-
ImageTestBuilder.DisplayFormat¶ Returns or sets the Format used to display the image.
-------------------------------------Getter Method
Signature
DisplayFormat()Returns: Return type: NXOpen.Display.ImageTestBuilderFormatTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DisplayFormat(displayFormat)Parameters: displayFormat ( NXOpen.Display.ImageTestBuilderFormatType) –New in version NX9.0.0.
License requirements: None.
DrawBorder¶
-
ImageTestBuilder.DrawBorder¶ Returns or sets the DrawBorder setting.
-------------------------------------Getter Method
Signature
DrawBorder()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DrawBorder(drawBorder)Parameters: drawBorder (bool) – New in version NX9.0.0.
License requirements: None.
ExtraAttribute¶
-
ImageTestBuilder.ExtraAttribute¶ Returns or sets the extra display attribute that is enabled for the display object (DISP_OBJ) that displays the image in the graphics window.
-------------------------------------Getter Method
Signature
ExtraAttribute()Returns: Return type: NXOpen.Display.ImageTestBuilderAttributeTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExtraAttribute(extraAttribute)Parameters: extraAttribute ( NXOpen.Display.ImageTestBuilderAttributeType) –New in version NX9.0.0.
License requirements: None.
ImageDetails¶
-
ImageTestBuilder.ImageDetails¶ Returns or sets the image details
-------------------------------------Getter Method
Signature
ImageDetails()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageDetails(imageDetails)Parameters: imageDetails (str) – New in version NX9.0.0.
License requirements: None.
ImageFile¶
-
ImageTestBuilder.ImageFile¶ Returns or sets the path of the image file.
-------------------------------------Getter Method
Signature
ImageFile()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageFile(filename)Parameters: filename (str) – New in version NX9.0.0.
License requirements: None.
MatrixVectors¶
-
ImageTestBuilder.MatrixVectors¶ Returns or sets the matrix vectors
-------------------------------------Getter Method
Signature
MatrixVectors()Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MatrixVectors(matrixVectors)Parameters: matrixVectors (str) – New in version NX9.0.0.
License requirements: None.
OriginLocation¶
-
ImageTestBuilder.OriginLocation¶ Returns or sets the location on the image that represents its origin.
-------------------------------------Getter Method
Signature
OriginLocation()Returns: Return type: NXOpen.Display.ImageTestBuilderOriginLocationTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OriginLocation(originLocation)Parameters: originLocation ( NXOpen.Display.ImageTestBuilderOriginLocationType) –New in version NX9.0.0.
License requirements: None.
PixelFormat¶
-
ImageTestBuilder.PixelFormat¶ Returns or sets the Format of the image.
-------------------------------------Getter Method
Signature
PixelFormat()Returns: Return type: NXOpen.Display.ImageTestBuilderFormatTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PixelFormat(pixelFormat)Parameters: pixelFormat ( NXOpen.Display.ImageTestBuilderFormatType) –New in version NX9.0.0.
License requirements: None.
PixelsPerInch¶
-
ImageTestBuilder.PixelsPerInch¶ Returns or sets the Pixels Per Inch setting.
-------------------------------------Getter Method
Signature
PixelsPerInch()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PixelsPerInch(pixelsPerInch)Parameters: pixelsPerInch (int) – New in version NX9.0.0.
License requirements: None.
SubimageRectangleHeight¶
-
ImageTestBuilder.SubimageRectangleHeight¶ Returns or sets the height of the SubimageRectangle.
-------------------------------------Getter Method
Signature
SubimageRectangleHeight()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SubimageRectangleHeight(subimageRectangleHeight)Parameters: subimageRectangleHeight (int) – New in version NX9.0.0.
License requirements: None.
SubimageRectangleWidth¶
-
ImageTestBuilder.SubimageRectangleWidth¶ Returns or sets the width of the SubimageRectangle.
-------------------------------------Getter Method
Signature
SubimageRectangleWidth()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SubimageRectangleWidth(subimageRectangleWidth)Parameters: subimageRectangleWidth (int) – New in version NX9.0.0.
License requirements: None.
SubimageRectangleX¶
-
ImageTestBuilder.SubimageRectangleX¶ Returns or sets the X coordinate of the upper-left corner of the SubimageRectangle.
-------------------------------------Getter Method
Signature
SubimageRectangleX()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SubimageRectangleX(subimageRectangleX)Parameters: subimageRectangleX (int) – New in version NX9.0.0.
License requirements: None.
SubimageRectangleY¶
-
ImageTestBuilder.SubimageRectangleY¶ Returns or sets the Y coordinate of the upper-left corner of the SubimageRectangle.
-------------------------------------Getter Method
Signature
SubimageRectangleY()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SubimageRectangleY(subimageRectangleY)Parameters: subimageRectangleY (int) – New in version NX9.0.0.
License requirements: None.
SuppressDeEmphasis¶
-
ImageTestBuilder.SuppressDeEmphasis¶ Returns or sets the SuppressDeEmphasis setting.
-------------------------------------Getter Method
Signature
SuppressDeEmphasis()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SuppressDeEmphasis(suppressDeEmphasis)Parameters: suppressDeEmphasis (bool) – New in version NX9.0.0.
License requirements: None.
SuppressSmoothing¶
-
ImageTestBuilder.SuppressSmoothing¶ Returns or sets the SuppressSmoothing setting.
-------------------------------------Getter Method
Signature
SuppressSmoothing()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SuppressSmoothing(suppressSmoothing)Parameters: suppressSmoothing (bool) – New in version NX9.0.0.
License requirements: None.
Translucency¶
-
ImageTestBuilder.Translucency¶ Returns or sets the Translucency setting.
-------------------------------------Getter Method
Signature
Translucency()Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Translucency(translucency)Parameters: translucency (int) – New in version NX9.0.0.
License requirements: None.
UseTransparencyPixel¶
-
ImageTestBuilder.UseTransparencyPixel¶ Returns or sets the UseTransparencyPixel setting.
-------------------------------------Getter Method
Signature
UseTransparencyPixel()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UseTransparencyPixel(useTransparencyPixel)Parameters: useTransparencyPixel (bool) – New in version NX9.0.0.
License requirements: None.
Method Detail¶
GetBackgroundColor¶
-
ImageTestBuilder.GetBackgroundColor¶ Returns the BackgroundColor.
Signature
GetBackgroundColor()Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX9.0.0.
License requirements: None.
GetForegroundColor¶
-
ImageTestBuilder.GetForegroundColor¶ Returns the ForegroundColor.
Signature
GetForegroundColor()Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX9.0.0.
License requirements: None.
GetTransparencyPixel¶
-
ImageTestBuilder.GetTransparencyPixel¶ Returns the TransparencyPixel.
Signature
GetTransparencyPixel()Returns: Array of 3 RGB values, each between 0 and 1 Return type: list of float New in version NX9.0.0.
License requirements: None.
SetBackgroundColor¶
-
ImageTestBuilder.SetBackgroundColor¶ Sets the BackgroundColor.
Signature
SetBackgroundColor(backgroundColor)Parameters: backgroundColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX9.0.0.
License requirements: None.
SetForegroundColor¶
-
ImageTestBuilder.SetForegroundColor¶ Sets the ForegroundColor.
Signature
SetForegroundColor(foregroundColor)Parameters: foregroundColor (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX9.0.0.
License requirements: None.
SetTransparencyPixel¶
-
ImageTestBuilder.SetTransparencyPixel¶ Sets the TransparencyPixel.
Signature
SetTransparencyPixel(transparencyPixel)Parameters: transparencyPixel (list of float) – Array of 3 RGB values, each between 0 and 1 New in version NX9.0.0.
License requirements: None.
Validate¶
-
ImageTestBuilder.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.