nxopen

Interface ModelingViewHighQualityImage

All Superinterfaces:

Remote

public interface ModelingViewHighQualityImage
extends Remote

Represents the properties and methods for generating a High Quality Image of a Modeling View
To obtain an instance of this class, refer to ModelingView

Created in NX4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ModelingViewHighQualityImage.DisplayTechniqueType Describes the technique to be used when generating the High Quality Image
static class	ModelingViewHighQualityImage.FormatType Describes the output format of the High Quality Image to be generated
static class	ModelingViewHighQualityImage.ImageCountsData This class holds the data returned from getImageCounts()
static class	ModelingViewHighQualityImage.ShadeMethod Describes the method to be used to generate a High Quality Image

Method Summary

Modifier and Type	Method and Description
ModelingViewHighQualityImage.DisplayTechniqueType	displayTechnique() Returns the display technique to use for the generation of the High Quality Image.
void	erase() Erases the previously generated high qualilty image of a view.
double	facetsQuality() Returns the quality of the facets of the High Quality Image.
ModelingViewHighQualityImage.FormatType	format() Returns the format to use for the generation of the High Quality Image.
void	generate() Generates a high qualilty image of a view based on the previously defined shading parameters for the view.
ModelingViewHighQualityImage.ImageCountsData	getImageCounts() Get information about the last image rendered.
ModelingViewHighQualityImage.ShadeMethod	method() Returns the method to use for the generation of the High Quality Image.
void	plot(SessionVisualizationHighQualityImage.ResolutionType resolution, int dotsPerInch, SessionVisualizationHighQualityImage.PlotQualityType plotQuality, String plotFileName) Plots the previously generated high qualilty image of a view.
void	save(String imageFileName, boolean compressImage) Saves the currently displayed high qualilty image of a view to a file.
void	setDisplayTechnique(ModelingViewHighQualityImage.DisplayTechniqueType displayTechnique) Sets the display technique to use for the generation of the High Quality Image.
void	setFacetsQuality(double facetsQuality) Sets the quality of the facets of the High Quality Image.
void	setFormat(ModelingViewHighQualityImage.FormatType format) Sets the format to use for the generation of the High Quality Image.
void	setMethod(ModelingViewHighQualityImage.ShadeMethod method) Sets the method to use for the generation of the High Quality Image.
void	setShadows(boolean generateShadows) Sets the setting for whether the High Quality Image is to contain shadows License requirements: None.
void	setUseIbl(boolean useIbl) Sets the setting for whether the High Quality Image is to use IBL License requirements: None.
boolean	shadows() Returns the setting for whether the High Quality Image is to contain shadows License requirements: None.
void	showImageInformation() Shows information about the last image rendered.
boolean	useIbl() Returns the setting for whether the High Quality Image is to use IBL License requirements: None.

Method Detail

displayTechnique

ModelingViewHighQualityImage.DisplayTechniqueType displayTechnique()
                                                            throws NXException,
                                                                   RemoteException

Returns the display technique to use for the generation of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setDisplayTechnique

void setDisplayTechnique(ModelingViewHighQualityImage.DisplayTechniqueType displayTechnique)
                  throws NXException,
                         RemoteException

Sets the display technique to use for the generation of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Parameters:

displayTechnique -

Throws:

NXException

RemoteException

facetsQuality

double facetsQuality()
              throws NXException,
                     RemoteException

Returns the quality of the facets of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Returns:

In range 0.1 [smooth] to 2.0 [coarse]

Throws:

NXException

RemoteException

setFacetsQuality

void setFacetsQuality(double facetsQuality)
               throws NXException,
                      RemoteException

Sets the quality of the facets of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Parameters:

facetsQuality - In range 0.1 [smooth] to 2.0 [coarse]

Throws:

NXException

RemoteException

format

ModelingViewHighQualityImage.FormatType format()
                                        throws NXException,
                                               RemoteException

Returns the format to use for the generation of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setFormat

void setFormat(ModelingViewHighQualityImage.FormatType format)
        throws NXException,
               RemoteException

Sets the format to use for the generation of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Parameters:

format -

Throws:

NXException

RemoteException

method

ModelingViewHighQualityImage.ShadeMethod method()
                                         throws NXException,
                                                RemoteException

Returns the method to use for the generation of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

setMethod

void setMethod(ModelingViewHighQualityImage.ShadeMethod method)
        throws NXException,
               RemoteException

Sets the method to use for the generation of the High Quality Image.
License requirements: None.

Created in NX4.0.0

Parameters:

method -

Throws:

NXException

RemoteException

shadows

boolean shadows()
         throws NXException,
                RemoteException

Returns the setting for whether the High Quality Image is to contain shadows
License requirements: None.

Created in NX4.0.0

Returns:

Whether shadows are to be generated for the image

Throws:

NXException

RemoteException

setShadows

void setShadows(boolean generateShadows)
         throws NXException,
                RemoteException

Sets the setting for whether the High Quality Image is to contain shadows
License requirements: None.

Created in NX4.0.0

Parameters:

generateShadows -

Throws:

NXException

RemoteException

useIbl

boolean useIbl()
        throws NXException,
               RemoteException

Returns the setting for whether the High Quality Image is to use IBL
License requirements: None.

Created in NX4.0.0

Returns:

When true, using image-based lighting in lieu of individual lights

Throws:

NXException

RemoteException

setUseIbl

void setUseIbl(boolean useIbl)
        throws NXException,
               RemoteException

Sets the setting for whether the High Quality Image is to use IBL
License requirements: None.

Created in NX4.0.0

Parameters:

useIbl - When true, use image-based lighting in lieu of individual lights for HQI's

Throws:

NXException

RemoteException

generate

void generate()
       throws NXException,
              RemoteException

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.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

save

void save(String imageFileName,
          boolean compressImage)
   throws NXException,
          RemoteException

Saves the currently displayed high qualilty image of a view to a file. Currently the given view must be the work view.
License requirements: None.

Created in NX4.0.0

Parameters:

imageFileName - 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
NOTE: The full Unicode character set is not supported for this parameter.

compressImage - Should the image file be compressed?

Throws:

NXException

RemoteException

erase

void erase()
    throws NXException,
           RemoteException

Erases the previously generated high qualilty image of a view. Currently the given view must be the work view.
License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

plot

void plot(SessionVisualizationHighQualityImage.ResolutionType resolution,
          int dotsPerInch,
          SessionVisualizationHighQualityImage.PlotQualityType plotQuality,
          String plotFileName)
   throws NXException,
          RemoteException

Plots the previously generated high qualilty image of a view. Currently the given view must be the work view.
License requirements: None.

Created in NX4.0.0

Parameters:

resolution - The resolution for the plot

dotsPerInch - Used only when resolution is ...user_defined

plotQuality - The quality level for the plot

plotFileName - Full path name for the plot file to create
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

showImageInformation

void showImageInformation()
                   throws NXException,
                          RemoteException

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.

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException

getImageCounts

ModelingViewHighQualityImage.ImageCountsData getImageCounts()
                                                     throws NXException,
                                                            RemoteException

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.

License requirements: None.

Created in NX4.0.0

Throws:

NXException

RemoteException