NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Preferences::SessionVisualizationHighQualityImage Class Reference

Represents the High Quality Image preferences for the entire session
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX4.0.0. More...

List of all members.

Public Types

enum  ImageSizeType {
  ImageSizeTypeFillView, ImageSizeTypeAnsiA, ImageSizeTypeAnsiB, ImageSizeTypeAnsiC,
  ImageSizeTypeAnsiD, ImageSizeTypeAnsiE, ImageSizeTypeIsoA4, ImageSizeTypeIsoA3,
  ImageSizeTypeIsoA2, ImageSizeTypeIsoA1, ImageSizeTypeIsoA0, ImageSizeTypeUserDefined,
  ImageSizeTypeTrueSize
}
 The size at which to generate a High Quality Image. More...
enum  OrientationType { OrientationTypeLandscape, OrientationTypePortrait }
 Whether the High Quality Image is to be generated with portrait or landscape orientation. More...
enum  PlotQualityType { PlotQualityTypeFine, PlotQualityTypeMedium, PlotQualityTypeRough, PlotQualityTypeCoarse }
 Describes the quality desired when plotting the High Quality Image. More...
enum  ResolutionType {
  ResolutionTypeDraft, ResolutionTypeLow, ResolutionTypeMedium, ResolutionTypeHigh,
  ResolutionTypeUserDefined
}
 The resolution to use when generating a High Quality Image. More...

Public Member Functions

void GetImageSize (NXOpen::Preferences::SessionVisualizationHighQualityImage::ImageSizeType *imageSize, int *xSize, int *ySize)
 Returns the image size to use for the generation of the High Quality Image.
NXOpen::Preferences::SessionVisualizationHighQualityImage::ResolutionType GetResolution (int *dotsPerInch)
 Returns the resolution to use when generating a High Quality Image.
NXOpen::Preferences::SessionVisualizationHighQualityImage::OrientationType Orientation ()
 Returns the orientation for the High Quality Image (portrait or landscape).
NXOpen::Preferences::SessionVisualizationHighQualityImage::PlotQualityType PlotQuality ()
 Returns the quality of the plot of the High Quality Image.
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.
void SetOrientation (NXOpen::Preferences::SessionVisualizationHighQualityImage::OrientationType orientation)
 Sets the orientation for the High Quality Image (portrait or landscape).
void SetPlotQuality (NXOpen::Preferences::SessionVisualizationHighQualityImage::PlotQualityType plotQuality)
 Sets the quality of the plot of the High Quality Image.
void SetResolution (NXOpen::Preferences::SessionVisualizationHighQualityImage::ResolutionType resolution, int dotsPerInch)
 Specifies the resolution to use when generating a High Quality Image.
void SetSubRegion (bool useSubRegion)
 Sets the setting for whether the High Quality Image is generated from a sub-region.
bool SubRegion ()
 Returns the setting for whether the High Quality Image is generated from a sub-region.
tag_t Tag () const
 Returns the tag of this object.

Detailed Description

Represents the High Quality Image preferences for the entire session
To obtain an instance of this class, refer to Preferences::SessionPreferences

Created in NX4.0.0.



Member Enumeration Documentation

The size at which to generate a High Quality Image.

Enumerator:
ImageSizeTypeFillView 

fill view

ImageSizeTypeAnsiA 

ansi a

ImageSizeTypeAnsiB 

ansi b

ImageSizeTypeAnsiC 

ansi c

ImageSizeTypeAnsiD 

ansi d

ImageSizeTypeAnsiE 

ansi e

ImageSizeTypeIsoA4 

iso a4

ImageSizeTypeIsoA3 

iso a3

ImageSizeTypeIsoA2 

iso a2

ImageSizeTypeIsoA1 

iso a1

ImageSizeTypeIsoA0 

iso a0

ImageSizeTypeUserDefined 

user defined

ImageSizeTypeTrueSize 

true size

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

Enumerator:
OrientationTypeLandscape 

landscape

OrientationTypePortrait 

portrait

Describes the quality desired when plotting the High Quality Image.

Enumerator:
PlotQualityTypeFine 

fine

PlotQualityTypeMedium 

medium

PlotQualityTypeRough 

rough

PlotQualityTypeCoarse 

coarse

The resolution to use when generating a High Quality Image.

Enumerator:
ResolutionTypeDraft 

draft

ResolutionTypeLow 

low

ResolutionTypeMedium 

medium

ResolutionTypeHigh 

high

ResolutionTypeUserDefined 

user defined


Member Function Documentation

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:
imageSizeimage size
xSizeX Pixel size. See note above.
ySizeY Pixel size. See note above

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.

Returns:

Created in NX4.0.0.

License requirements : None
Parameters:
dotsPerInchDots per inch. See note above.

Returns 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 : None

Returns 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 : None

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:
imageSizeimage size
xSizeX Pixel size. Used only if image_size is user_defined
ySizeY Pixel size. Used only if image_size is user_defined

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 : None

Parameters:
orientationorientation

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 : None

Parameters:
plotQualityplot quality

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:
resolutionresolution
dotsPerInchDots per inch. Used only if resolution is user_defined

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 : None

Parameters:
useSubRegionuse sub region

Returns 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 : None

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.