NXOpen::ModelingViewHighQualityImage Class Reference

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

Public Types
enum	DisplayTechniqueType {   DisplayTechniqueTypeRgbPlusNoise, DisplayTechniqueTypeFsRgb, DisplayTechniqueTypeFsRgbPlusNoise, DisplayTechniqueTypeMonochrome,   DisplayTechniqueTypeGrayScale, DisplayTechniqueTypeNearestRgb, DisplayTechniqueTypeOrderedDither, DisplayTechniqueTypeTcPlusNoise }
	Describes the technique to be used when generating the High Quality Image. More...
enum	FormatType { FormatTypeRasterImage, FormatTypeQtvrPanorama, FormatTypeQtvrObjectLow, FormatTypeQtvrObjectHigh }
	Describes the output format of the High Quality Image to be generated. More...
enum	ShadeMethod {   ShadeMethodFlat, ShadeMethodGouraud, ShadeMethodPhong, ShadeMethodImproved,   ShadeMethodPreview, ShadeMethodPhotoRealistic, ShadeMethodRayTraced, ShadeMethodRayTracedFfa,   ShadeMethodRadiosity, ShadeMethodHybridRadiosity }
	Describes the method to be used to generate a High Quality Image. More...

Public Member Functions
NXOpen::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.
NXOpen::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.
void	GetImageCounts (int *numberBodiesRendered, int *numberFacesRendered, int *numberPolygonsGenerated, double *polygonGenerationSeconds, double *shadowGenerationSeconds, double *imageGenerationSeconds)
	Get information about the last image rendered.
NXOpen::ModelingViewHighQualityImage::ShadeMethod	Method ()
	Returns the method to use for the generation of the High Quality Image.
void	Plot (NXOpen::Preferences::SessionVisualizationHighQualityImage::ResolutionType resolution, int dotsPerInch, NXOpen::Preferences::SessionVisualizationHighQualityImage::PlotQualityType plotQuality, const NXString &plotFileName)
	Plots the previously generated high qualilty image of a view.
void	Plot (NXOpen::Preferences::SessionVisualizationHighQualityImage::ResolutionType resolution, int dotsPerInch, NXOpen::Preferences::SessionVisualizationHighQualityImage::PlotQualityType plotQuality, const char *plotFileName)
	Plots the previously generated high qualilty image of a view.
void	Save (const NXString &imageFileName, bool compressImage)
	Saves the currently displayed high qualilty image of a view to a file.
void	Save (const char *imageFileName, bool compressImage)
	Saves the currently displayed high qualilty image of a view to a file.
void	SetDisplayTechnique (NXOpen::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 (NXOpen::ModelingViewHighQualityImage::FormatType format)
	Sets the format to use for the generation of the High Quality Image.
void	SetMethod (NXOpen::ModelingViewHighQualityImage::ShadeMethod method)
	Sets the method to use for the generation of the High Quality Image.
void	SetShadows (bool generateShadows)
	Sets the setting for whether the High Quality Image is to contain shadows Created in NX4.0.0.
void	SetUseIbl (bool useIbl)
	Sets the setting for whether the High Quality Image is to use IBL Created in NX4.0.0.
bool	Shadows ()
	Returns the setting for whether the High Quality Image is to contain shadows Created in NX4.0.0.
void	ShowImageInformation ()
	Shows information about the last image rendered.
tag_t	Tag () const
	Returns the tag of this object.
bool	UseIbl ()
	Returns the setting for whether the High Quality Image is to use IBL Created in NX4.0.0.

Detailed Description

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.

Member Enumeration Documentation

enum NXOpen::ModelingViewHighQualityImage::DisplayTechniqueType

Describes the technique to be used when generating the High Quality Image.

Enumerator:

DisplayTechniqueTypeRgbPlusNoise	The RGB algorithm is augmented with the addition of random noise to the initial RGB values before the dither takes place.
DisplayTechniqueTypeFsRgb	The pixel conversion process uses the Floyd-Steinberg dither algorithm to distribute the color error across the picture. This is a recommended mode for 8 bit plane display devices.
DisplayTechniqueTypeFsRgbPlusNoise	The Floyd-Steinberg algorithm is augmented with the addition of random noise to the initial RGB values before the dither takes place. For some images this method avoids artifacts that can occur using the FS RGB method.
DisplayTechniqueTypeMonochrome	Pixels are converted to black and white and dithered using the Floyd-Steinberg algorithm. This mode is useful on 1 bit display devices.
DisplayTechniqueTypeGrayScale	Each pixel is converted to a gray level using the NTSC color to gray scale conversion.
DisplayTechniqueTypeNearestRgb	Conversion is to the nearest RGB value in the color lookup table.
DisplayTechniqueTypeOrderedDither	A color dither matrix screens pixel colors. This is a trade of color resolution for screen resolution. This method is faster then the Floyd-Steinberg dither methods but tends to introduce a noticeable pattern in the output image.
DisplayTechniqueTypeTcPlusNoise	Random noise is added to each pixel where the noise is specifically tailored for true color display devices.

enum NXOpen::ModelingViewHighQualityImage::FormatType

Describes the output format of the High Quality Image to be generated.

Enumerator:

FormatTypeRasterImage	A normal single raster image.
FormatTypeQtvrPanorama	Quick Time Virtual Reality panoramic movie, which is a set of images from a fixed viewpoint. The viewer can look in all directions.
FormatTypeQtvrObjectLow	Quick Time Virtual Reality object movie, which is a set of image of an object in different rotations. The viewer can rotate the object to look at it in any orientation. A low number of frames is generated.
FormatTypeQtvrObjectHigh	Quick Time Virtual Reality object movie , which is a set of image of an object in different rotations. The viewer can rotate the object to look at it in any orientation. A high number of frames is generated.

enum NXOpen::ModelingViewHighQualityImage::ShadeMethod

Describes the method to be used to generate a High Quality Image.

Enumerator:

ShadeMethodFlat	The fastest shading method. Each facet is assigned a uniform color.
ShadeMethodGouraud	Provides smooth interpolated colors. Not quite as fast as Flat shading.
ShadeMethodPhong	Provides smoother highlights than Gouraud shading, but otherwise supports the same level of functionality.
ShadeMethodImproved	Shading with textures material parameters highlights and shadows. imilar quality to photo-realistic but significantly faster.
ShadeMethodPreview	An improvement over the Improved method. Preview adds support for transparency without the requirement to also anti-alias the image.
ShadeMethodPhotoRealistic	All the features of the Improved method, plus support for anti-aliasing and transparency. Images shaded with this mode could take two to three times longer to render than those using the Improved method.
ShadeMethodRayTraced	Produces photo-realistic images generated with ray tracing. This method is slower than photo-realistic, but it correctly anti-aliases, or renders, textures.
ShadeMethodRayTracedFfa	Same as the Ray Traced option, but with Feature Following Anti-aliasing.
ShadeMethodRadiosity	An iterative light processing method where indirect lighting in a scene is derived from direct light bouncing off of surfaces before an image is rendered. Use this method when physically accurate lighting is required for your modeled scene.
ShadeMethodHybridRadiosity	Uses standard rendering techniques to calculate direct lighting together with radiosity processing for indirect lighting for image rendering. Use this method over Radiosity when precise direct lighting effects are also required.

Member Function Documentation

NXOpen::ModelingViewHighQualityImage::DisplayTechniqueType NXOpen::ModelingViewHighQualityImage::DisplayTechnique

(

)

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

Created in NX4.0.0.

License requirements : None

void NXOpen::ModelingViewHighQualityImage::Erase

(

)

Erases the previously generated high qualilty image of a view.

   Currently the given view must be the work view.

Created in NX4.0.0.

License requirements : None

double NXOpen::ModelingViewHighQualityImage::FacetsQuality

(

)

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

Created in NX4.0.0.

License requirements : None

NXOpen::ModelingViewHighQualityImage::FormatType NXOpen::ModelingViewHighQualityImage::Format

(

)

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

Created in NX4.0.0.

License requirements : None

void NXOpen::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.

Created in NX4.0.0.

License requirements : None

void NXOpen::ModelingViewHighQualityImage::GetImageCounts	(	int *	numberBodiesRendered,
		int *	numberFacesRendered,
		int *	numberPolygonsGenerated,
		double *	polygonGenerationSeconds,
		double *	shadowGenerationSeconds,
		double *	imageGenerationSeconds
	)

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.

Created in NX4.0.0.

License requirements : None

Parameters

numberBodiesRendered	How many bodies were rendered for the image
numberFacesRendered	How many faces were rendered for the image
numberPolygonsGenerated	How many polygons were created from the faces for the image
polygonGenerationSeconds	Number of seconds to generate the polygons
shadowGenerationSeconds	Number of seconds to generate the shadows
imageGenerationSeconds	Number of seconds to generate the image

NXOpen::ModelingViewHighQualityImage::ShadeMethod NXOpen::ModelingViewHighQualityImage::Method

(

)

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

Created in NX4.0.0.

License requirements : None

void NXOpen::ModelingViewHighQualityImage::Plot	(	NXOpen::Preferences::SessionVisualizationHighQualityImage::ResolutionType	resolution,
		int	dotsPerInch,
		NXOpen::Preferences::SessionVisualizationHighQualityImage::PlotQualityType	plotQuality,
		const NXString &	plotFileName
	)

Plots the previously generated high qualilty image of a view.

   Currently the given view must be the work view.

Created in NX4.0.0.

License requirements : None

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.

void NXOpen::ModelingViewHighQualityImage::Plot	(	NXOpen::Preferences::SessionVisualizationHighQualityImage::ResolutionType	resolution,
		int	dotsPerInch,
		NXOpen::Preferences::SessionVisualizationHighQualityImage::PlotQualityType	plotQuality,
		const char *	plotFileName
	)

Plots the previously generated high qualilty image of a view.

   Currently the given view must be the work view.

Created in NX4.0.0.

License requirements : None

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.

void NXOpen::ModelingViewHighQualityImage::Save	(	const NXString &	imageFileName,
		bool	compressImage
	)

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

   Currently the given view must be the work view.

Created in NX4.0.0.

License requirements : None

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?

void NXOpen::ModelingViewHighQualityImage::Save	(	const char *	imageFileName,
		bool	compressImage
	)

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

   Currently the given view must be the work view.

Created in NX4.0.0.

License requirements : None

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?

void NXOpen::ModelingViewHighQualityImage::SetDisplayTechnique

(

NXOpen::ModelingViewHighQualityImage::DisplayTechniqueType

displayTechnique

)

Sets the display technique to use for the generation of the High Quality Image.

Created in NX4.0.0.

License requirements : None

Parameters

displayTechnique

display technique

void NXOpen::ModelingViewHighQualityImage::SetFacetsQuality

(

double

facetsQuality

)

Sets the quality of the facets of the High Quality Image.

Created in NX4.0.0.

License requirements : None

Parameters

facetsQuality

In range 0.1 [smooth] to 2.0 [coarse]

void NXOpen::ModelingViewHighQualityImage::SetFormat

(

NXOpen::ModelingViewHighQualityImage::FormatType

format

)

Sets the format to use for the generation of the High Quality Image.

Created in NX4.0.0.

License requirements : None

Parameters

format

format

void NXOpen::ModelingViewHighQualityImage::SetMethod

(

NXOpen::ModelingViewHighQualityImage::ShadeMethod

method

)

Sets the method to use for the generation of the High Quality Image.

Created in NX4.0.0.

License requirements : None

Parameters

method

method

void NXOpen::ModelingViewHighQualityImage::SetShadows

(

bool

generateShadows

)

Sets the setting for whether the High Quality Image is to contain shadows
Created in NX4.0.0.

License requirements : None

Parameters

generateShadows

generate shadows

void NXOpen::ModelingViewHighQualityImage::SetUseIbl

(

bool

useIbl

)

Sets the setting for whether the High Quality Image is to use IBL
Created in NX4.0.0.

License requirements : None

Parameters

useIbl

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

bool NXOpen::ModelingViewHighQualityImage::Shadows

(

)

Returns the setting for whether the High Quality Image is to contain shadows
Created in NX4.0.0.

License requirements : None

void NXOpen::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.

Created in NX4.0.0.

License requirements : None

tag_t NXOpen::ModelingViewHighQualityImage::Tag

(

)

const

Returns the tag of this object.

bool NXOpen::ModelingViewHighQualityImage::UseIbl

(

)

Returns the setting for whether the High Quality Image is to use IBL
Created in NX4.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• ModelingViewHighQualityImage.hxx