Represents the High Quality Image preferences for the entire session More...

Inheritance diagram for NXOpen.Preferences.SessionVisualizationHighQualityImage:

Public Types
enum	ImageSizeType { FillView, AnsiA, AnsiB, AnsiC, AnsiD, AnsiE, IsoA4, IsoA3, IsoA2, IsoA1, IsoA0, UserDefined, TrueSize }
	The size at which to generate a High Quality Image. More...

enum	OrientationType { Landscape, Portrait }
	Whether the High Quality Image is to be generated with portrait or landscape orientation More...

enum	PlotQualityType { Fine, Medium, Rough, Coarse }
	Describes the quality desired when plotting the High Quality Image More...

enum	ResolutionType { Draft, Low, Medium, High, UserDefined }
	The resolution to use when generating a High Quality Image. More...

Public Member Functions
unsafe void	GetImageSize (out NXOpen.Preferences.SessionVisualizationHighQualityImage.ImageSizeType imageSize, out int xSize, out int ySize)
	Returns the image size to use for the generation of the High Quality Image. More...

unsafe NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType	GetResolution (out int dotsPerInch)
	Returns the resolution to use when generating a High Quality Image. More...

unsafe void	SetImageSize (NXOpen.Preferences.SessionVisualizationHighQualityImage.ImageSizeType imageSize, int xSize, int ySize)
	Specifies the image size to use for the generation of the High Quality Image. More...

unsafe void	SetResolution (NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType resolution, int dotsPerInch)
	Specifies the resolution to use when generating a High Quality Image. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Preferences.SessionVisualizationHighQualityImage.OrientationType	Orientation `[get, set]`
	Returns or sets the orientation for the High Quality Image (portrait or landscape). More...

unsafe NXOpen.Preferences.SessionVisualizationHighQualityImage.PlotQualityType	PlotQuality `[get, set]`
	Returns or sets the quality of the plot of the High Quality Image. More...

unsafe bool	SubRegion `[get, set]`
	Returns or sets the setting for whether the High Quality Image is generated from a sub-region. More...

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

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void	initialize ()
	<exclude> More...

Detailed Description

Represents the High Quality Image preferences for the entire session

To obtain an instance of this class, refer to NXOpen.Preferences.SessionPreferences

Created in NX4.0.0

Member Enumeration Documentation

enum NXOpen.Preferences.SessionVisualizationHighQualityImage.ImageSizeType

The size at which to generate a High Quality Image.

Enumerator
FillView
AnsiA
AnsiB
AnsiC
AnsiD
AnsiE
IsoA4
IsoA3
IsoA2
IsoA1
IsoA0
UserDefined
TrueSize

enum NXOpen.Preferences.SessionVisualizationHighQualityImage.OrientationType

Whether the High Quality Image is to be generated with portrait or landscape orientation

Enumerator
Landscape
Portrait

enum NXOpen.Preferences.SessionVisualizationHighQualityImage.PlotQualityType

Describes the quality desired when plotting the High Quality Image

Enumerator
Fine
Medium
Rough
Coarse

enum NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType

The resolution to use when generating a High Quality Image.

Enumerator
Draft
Low
Medium
High
UserDefined

Member Function Documentation

unsafe void NXOpen.Preferences.SessionVisualizationHighQualityImage.GetImageSize	(	out NXOpen.Preferences.SessionVisualizationHighQualityImage.ImageSizeType	imageSize,
		out int	xSize,
		out int	ySize
	)

inline

Returns the image size to use for the generation of the High Quality Image.

x_size and y_size vary only for User Defined image size type. For other image size types, the values returned in them are the x and y sizes fixed for the image size type.

Created in NX4.0.0

License requirements: None.

Parameters

imageSize
xSize	X Pixel size. See note above.
ySize	Y Pixel size. See note above

unsafe NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType NXOpen.Preferences.SessionVisualizationHighQualityImage.GetResolution ( out int dotsPerInch )

inline

Returns the resolution to use when generating a High Quality Image.

The resolution is not used if the image_size is fill_view. dots_per_inch is variable only for User Defined resolution type. For other resolution types, the returned dots_per_inch is the number of dots per inch which is fixed for the given resolution type.

Created in NX4.0.0

License requirements: None.

Returns

Parameters

dotsPerInch Dots per inch. See note above.

unsafe void NXOpen.Preferences.SessionVisualizationHighQualityImage.SetImageSize	(	NXOpen.Preferences.SessionVisualizationHighQualityImage.ImageSizeType	imageSize,
		int	xSize,
		int	ySize
	)

inline

Specifies the image size to use for the generation of the High Quality Image.

x_size and y_size only apply for User Defined image size type. For other image size types, they are ignored.

Created in NX4.0.0

License requirements: None.

Parameters

imageSize
xSize	X Pixel size. Used only if image_size is user_defined
ySize	Y Pixel size. Used only if image_size is user_defined

unsafe void NXOpen.Preferences.SessionVisualizationHighQualityImage.SetResolution	(	NXOpen.Preferences.SessionVisualizationHighQualityImage.ResolutionType	resolution,
		int	dotsPerInch
	)

inline

Specifies the resolution to use when generating a High Quality Image.

The given resolution is not used if the image_size is fill_view. dots_per_inch is used only for User Defined resolution. For other resolutions types, the input dots_per_inch is ignored.

Created in NX4.0.0

License requirements: None.

Parameters

resolution
dotsPerInch	Dots per inch. Used only if resolution is user_defined

Property Documentation

unsafe NXOpen.Preferences.SessionVisualizationHighQualityImage.OrientationType NXOpen.Preferences.SessionVisualizationHighQualityImage.Orientation

getset

Returns or sets the orientation for the High Quality Image (portrait or landscape).

orientation is not used if image_size is fill_view or user_defined.

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Preferences.SessionVisualizationHighQualityImage.PlotQualityType NXOpen.Preferences.SessionVisualizationHighQualityImage.PlotQuality

getset

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

plot_quality is not used if image_size is fill_view

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Preferences.SessionVisualizationHighQualityImage.SubRegion

getset

Returns or sets the setting for whether the High Quality Image is generated from a sub-region.

sub_region is only used when image_size is fill_view

Created in NX4.0.0

License requirements to get this property: None.

License requirements to set this property: None.

Tag NXOpen.Preferences.SessionVisualizationHighQualityImage.Tag

get

Returns the tag of this object.

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

Preferences_SessionVisualizationHighQualityImage.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation