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

Inheritance diagram for NXOpen.ModelingViewHighQualityImage:

Public Types
enum	ShadeMethod { Flat, Gouraud, Phong, Improved, Preview, PhotoRealistic, RayTraced, RayTracedFfa, Radiosity, HybridRadiosity }
	Describes the method to be used to generate a High Quality Image More...

enum	FormatType { RasterImage, QtvrPanorama, QtvrObjectLow, QtvrObjectHigh }
	Describes the output format of the High Quality Image to be generated More...

enum	DisplayTechniqueType { RgbPlusNoise, FsRgb, FsRgbPlusNoise, Monochrome, GrayScale, NearestRgb, OrderedDither, TcPlusNoise }
	Describes the technique to be used when generating the High Quality Image More...

Public Member Functions
unsafe void	Generate ()
	Generates a high qualilty image of a view based on the previously defined shading parameters for the view. More...

unsafe void	Save (string imageFileName, bool compressImage)
	Saves the currently displayed high quality image of a view to a file. More...

unsafe void	Erase ()
	Erases the previously generated high qualilty image of a view. More...

unsafe void	Plot (NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType resolution, int dotsPerInch, NXOpen.Preferences.SessionVisualizationHighQualityImage.PlotQualityType plotQuality, string plotFileName)
	Plots the previously generated high qualilty image of a view. More...

unsafe void	ShowImageInformation ()
	Shows information about the last image rendered. More...

unsafe void	GetImageCounts (out int numberBodiesRendered, out int numberFacesRendered, out int numberPolygonsGenerated, out double polygonGenerationSeconds, out double shadowGenerationSeconds, out double imageGenerationSeconds)
	Get information about the last image rendered. More...

Properties
Tag	Tag `[get]`
	Returns the tag of this object. More...

unsafe NXOpen.ModelingViewHighQualityImage.DisplayTechniqueType	DisplayTechnique `[get, set]`
	Returns or sets the display technique to use for the generation of the High Quality Image. More...

unsafe double	FacetsQuality `[get, set]`
	Returns or sets the quality of the facets of the High Quality Image. More...

unsafe NXOpen.ModelingViewHighQualityImage.FormatType	Format `[get, set]`
	Returns or sets the format to use for the generation of the High Quality Image. More...

unsafe NXOpen.ModelingViewHighQualityImage.ShadeMethod	Method `[get, set]`
	Returns or sets the method to use for the generation of the High Quality Image. More...

unsafe bool	Shadows `[get, set]`
	Returns or sets the setting for whether the High Quality Image is to contain shadows More...

unsafe bool	UseIbl `[get, set]`
	Returns or sets the setting for whether the High Quality Image is to use IBL More...

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 NXOpen.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
RgbPlusNoise	The RGB algorithm is augmented with the addition of random noise to the initial RGB values before the dither takes place.
FsRgb	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.
FsRgbPlusNoise	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.
Monochrome	Pixels are converted to black and white and dithered using the Floyd-Steinberg algorithm. This mode is useful on 1 bit display devices.
GrayScale	Each pixel is converted to a gray level using the NTSC color to gray scale conversion.
NearestRgb	Conversion is to the nearest RGB value in the color lookup table.
OrderedDither	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.
TcPlusNoise	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
RasterImage	A normal single raster image
QtvrPanorama	Quick Time Virtual Reality panoramic movie, which is a set of images from a fixed viewpoint. The viewer can look in all directions.
QtvrObjectLow	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.
QtvrObjectHigh	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
Flat	The fastest shading method. Each facet is assigned a uniform color.
Gouraud	Provides smooth interpolated colors. Not quite as fast as Flat shading.
Phong	Provides smoother highlights than Gouraud shading, but otherwise supports the same level of functionality.
Improved	Shading with textures material parameters highlights and shadows. imilar quality to photo-realistic but significantly faster.
Preview	An improvement over the Improved method. Preview adds support for transparency without the requirement to also anti-alias the image.
PhotoRealistic	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.
RayTraced	Produces photo-realistic images generated with ray tracing. This method is slower than photo-realistic, but it correctly anti-aliases, or renders, textures.
RayTracedFfa	Same as the Ray Traced option, but with Feature Following Anti-aliasing.
Radiosity	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.
HybridRadiosity	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

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

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

unsafe void NXOpen.ModelingViewHighQualityImage.GetImageCounts	(	out int	numberBodiesRendered,
		out int	numberFacesRendered,
		out int	numberPolygonsGenerated,
		out double	polygonGenerationSeconds,
		out double	shadowGenerationSeconds,
		out 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

unsafe void NXOpen.ModelingViewHighQualityImage.Plot	(	NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType	resolution,
		int	dotsPerInch,
		NXOpen.Preferences.SessionVisualizationHighQualityImage.PlotQualityType	plotQuality,
		string	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

unsafe void NXOpen.ModelingViewHighQualityImage.Save	(	string	imageFileName,
		bool	compressImage
	)

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.

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
compressImage	Should the image file be compressed?

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

Property Documentation

unsafe NXOpen.ModelingViewHighQualityImage.DisplayTechniqueType NXOpen.ModelingViewHighQualityImage.DisplayTechnique

getset

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

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe double NXOpen.ModelingViewHighQualityImage.FacetsQuality

getset

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

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.ModelingViewHighQualityImage.FormatType NXOpen.ModelingViewHighQualityImage.Format

getset

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

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.ModelingViewHighQualityImage.ShadeMethod NXOpen.ModelingViewHighQualityImage.Method

getset

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

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.ModelingViewHighQualityImage.Shadows

getset

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

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.ModelingViewHighQualityImage.Tag

get

Returns the tag of this object.

unsafe bool NXOpen.ModelingViewHighQualityImage.UseIbl

getset

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

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

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

dotnet_pool/ModelingViewHighQualityImage.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation