ModelingViewHighQualityImage Class — NXOpen Python API Reference 12.0.0 documentation

# ModelingViewHighQualityImage Class

class `NXOpen.``ModelingViewHighQualityImage`

  Bases: `object`

  Represents the properties and methods for generating a High Quality Image of a Modeling View

  To obtain an instance of this class, refer to `NXOpen.ModelingView`

  New in version NX4.0.0.

# Properties

Property | Description
--- | ---
DisplayTechnique | Returns or sets the display technique to use for the generation of the High Quality Image.
FacetsQuality | Returns or sets the quality of the facets of the High Quality Image.
Format | Returns or sets the format to use for the generation of the High Quality Image.
Method | Returns or sets the method to use for the generation of the High Quality Image.
Shadows | Returns or sets the setting for whether the High Quality Image is to contain shadows
UseIbl | Returns or sets the setting for whether the High Quality Image is to use IBL

# Methods

Method | Description
--- | ---
Erase | Erases the previously generated high qualilty image of a view.
Generate | Generates a high qualilty image of a view based on the previously defined shading parameters for the view.
GetImageCounts | Get information about the last image rendered.
Plot | Plots the previously generated high qualilty image of a view.
Save | Saves the currently displayed high quality image of a view to a file.
ShowImageInformation | Shows information about the last image rendered.

# Enumerations

ModelingViewHighQualityImageDisplayTechniqueType Enumeration | Describes the technique to be used when generating the High Quality Image
ModelingViewHighQualityImageFormatType Enumeration | Describes the output format of the High Quality Image to be generated
ModelingViewHighQualityImageShadeMethod Enumeration | Describes the method to be used to generate a High Quality Image

# Property Detail

## DisplayTechnique

`ModelingViewHighQualityImage.``DisplayTechnique`

  Returns or sets the display technique to use for the generation of the High Quality Image.

  `-------------------------------------`

  Getter Method

  Signature `DisplayTechnique`

  Returns: |
  Return type: | `NXOpen.ModelingViewHighQualityImageDisplayTechniqueType`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplayTechnique`

  Parameters: | displayTechnique (`NXOpen.ModelingViewHighQualityImageDisplayTechniqueType`) –

  New in version NX4.0.0.

  License requirements: None.

## FacetsQuality

`ModelingViewHighQualityImage.``FacetsQuality`

  Returns or sets the quality of the facets of the High Quality Image.

  `-------------------------------------`

  Getter Method

  Signature `FacetsQuality`

  Returns: | In range 0.1 [smooth] to 2.0 [coarse]
  Return type: | float

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FacetsQuality`

  Parameters: | facetsQuality (float) – In range 0.1 [smooth] to 2.0 [coarse]

  New in version NX4.0.0.

  License requirements: None.

## Format

`ModelingViewHighQualityImage.``Format`

  Returns or sets the format to use for the generation of the High Quality Image.

  `-------------------------------------`

  Getter Method

  Signature `Format`

  Returns: |
  Return type: | `NXOpen.ModelingViewHighQualityImageFormatType`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Format`

  Parameters: | format (`NXOpen.ModelingViewHighQualityImageFormatType`) –

  New in version NX4.0.0.

  License requirements: None.

## Method

`ModelingViewHighQualityImage.``Method`

  Returns or sets the method to use for the generation of the High Quality Image.

  `-------------------------------------`

  Getter Method

  Signature `Method`

  Returns: |
  Return type: | `NXOpen.ModelingViewHighQualityImageShadeMethod`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Method`

  Parameters: | method (`NXOpen.ModelingViewHighQualityImageShadeMethod`) –

  New in version NX4.0.0.

  License requirements: None.

## Shadows

`ModelingViewHighQualityImage.``Shadows`

  Returns or sets the setting for whether the High Quality Image is to contain shadows

  `-------------------------------------`

  Getter Method

  Signature `Shadows`

  Returns: | Whether shadows are to be generated for the image
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Shadows`

  Parameters: | generateShadows (bool) –

  New in version NX4.0.0.

  License requirements: None.

## UseIbl

`ModelingViewHighQualityImage.``UseIbl`

  Returns or sets the setting for whether the High Quality Image is to use IBL

  `-------------------------------------`

  Getter Method

  Signature `UseIbl`

  Returns: | When true, using image-based lighting in lieu of individual lights
  Return type: | bool

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseIbl`

  Parameters: | useIbl (bool) – When true, use image-based lighting in lieu of individual lights for HQI’s

  New in version NX4.0.0.

  License requirements: None.

# Method Detail

## Erase

`ModelingViewHighQualityImage.``Erase`

  Erases the previously generated high qualilty image of a view.

  Currently the given view must be the work view.

  Signature `Erase()`

  New in version NX4.0.0.

  License requirements: None.

## Generate

`ModelingViewHighQualityImage.``Generate`

  Generates a high qualilty image of a view based on the previously defined shading parameters for the view.

  Currently the given view must be the work view.

  Signature `Generate()`

  New in version NX4.0.0.

  License requirements: None.

## GetImageCounts

`ModelingViewHighQualityImage.``GetImageCounts`

  Get information about the last image rendered.

  If no image has been rendered in this session, all zeroes are returned.

  Currently the input modeling_view is not used in this function, as the information is returned for the last image regardless of which view it was rendered for. This might change in the future.

  Signature `GetImageCounts()`

  Returns: | a tuple
  Return type: | A tuple consisting of (numberBodiesRendered, numberFacesRendered, numberPolygonsGenerated, polygonGenerationSeconds, shadowGenerationSeconds, imageGenerationSeconds) numberBodiesRendered is a int. How many bodies were rendered for the image numberFacesRendered is a int. How many faces were rendered for the image numberPolygonsGenerated is a int. How many polygons were created from the faces for the image polygonGenerationSeconds is a float. Number of seconds to generate the polygons shadowGenerationSeconds is a float. Number of seconds to generate the shadows imageGenerationSeconds is a float. Number of seconds to generate the image

  New in version NX4.0.0.

  License requirements: None.

## Plot

`ModelingViewHighQualityImage.``Plot`

  Plots the previously generated high qualilty image of a view.

  Currently the given view must be the work view.

  Signature `Plot(resolution, dotsPerInch, plotQuality, plotFileName)`

  Parameters:

  - resolution (`NXOpen.Preferences.SessionVisualizationHighQualityImageResolutionType`) – The resolution for the plot
  - dotsPerInch (int) – Used only when resolution is …user_defined
  - plotQuality (`NXOpen.Preferences.SessionVisualizationHighQualityImagePlotQualityType`) – The quality level for the plot
  - plotFileName (str) – Full path name for the plot file to create

  New in version NX4.0.0.

  License requirements: None.

## Save

`ModelingViewHighQualityImage.``Save`

  Saves the currently displayed high quality image of a view to a file.

  Currently the given view must be the work view. This function only works in interactive mode, not in batch mode.

  Refer to function UF_DISP_batch_shade in batch mode.

  Signature `Save(imageFileName, compressImage)`

  Parameters:

  - imageFileName (str) – File name for the saved image. This may * include an extension, which may be .tif, * .jpg, .gif or .wrl. If no extension is * provided, or if the extension is invalid, * a .tif file will be created
  - compressImage (bool) – Should the image file be compressed?

  New in version NX4.0.0.

  License requirements: None.

## ShowImageInformation

`ModelingViewHighQualityImage.``ShowImageInformation`

  Shows information about the last image rendered.

  The information is what is shown by the Information button on the High Quality Image dialog. It is displayed in the listing window.

  If no image has been rendered in this session, the information shown is meaningless, and so this method should not be used unless an image has been rendered in the session.

  Currently the input modeling_view is not used in this function, as the information is returned for the last image regardless of which view it was rendered for. This might change in the future.

  Internal mode only.

  Signature `ShowImageInformation()`

  New in version NX4.0.0.

  License requirements: None.