NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Display::StudioImageCaptureBuilder Class Reference

Represents a Display::StudioImageCaptureBuilder
To create a new instance of this class, use ViewCollection::CreateStudioImageCaptureBuilder
Default values. More...

Inheritance diagram for NXOpen::Display::StudioImageCaptureBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  AASamplesEnumType {
  AASamplesEnumTypeSam0X, AASamplesEnumTypeSam2X, AASamplesEnumTypeSam4X, AASamplesEnumTypeSam8X,
  AASamplesEnumTypeSam16X
}
 Provide the following anti-aliasing sample size for off screen image capture. More...
enum  DPIEnumType { DPIEnumTypeDpi72, DPIEnumTypeDpi150 }
 Provide the following screen capture resolutions in dots per inch. More...
enum  DrawingSizeEnumType {
  DrawingSizeEnumTypeIsoa4, DrawingSizeEnumTypeIsoa3, DrawingSizeEnumTypeIsoa2, DrawingSizeEnumTypeIsoa1,
  DrawingSizeEnumTypeIsoa0, DrawingSizeEnumTypeAnsia, DrawingSizeEnumTypeAnsib, DrawingSizeEnumTypeAnsic,
  DrawingSizeEnumTypeAnsid, DrawingSizeEnumTypeAnsie, DrawingSizeEnumTypeCustom
}
 Provide the following standard Drawing sizes. More...
enum  OrientEnumType { OrientEnumTypeLandscape, OrientEnumTypePortrait }
 Provide the following options to image orientation. More...
enum  UnitsEnumType { UnitsEnumTypePixels, UnitsEnumTypeMm, UnitsEnumTypeInches }
 Provide the following resolution unit options to screen capture. More...

Public Member Functions

NXOpen::Display::StudioImageCaptureBuilder::AASamplesEnumType AASamplesEnum ()
 Returns the antialiasing samples enum
Created in NX6.0.4.
NXOpen::Display::StudioImageCaptureBuilder::DPIEnumType DpiEnum ()
 Returns the dpi enum
Created in NX6.0.4.
NXOpen::Display::StudioImageCaptureBuilder::DrawingSizeEnumType DrawingSizeEnum ()
 Returns the drawing size enum
Created in NX6.0.4.
std::vector< double > GetImageDimensionsDouble ()
 Gets the double image dimensions, height and width.
std::vector< int > GetImageDimensionsInteger ()
 Gets the integer image dimensions, height and width.
NXString NativeFileBrowser ()
 Returns the native file browser for image type to produce
Created in NX6.0.4.
NXOpen::Display::StudioImageCaptureBuilder::OrientEnumType OrientEnum ()
 Returns the orient enum
Created in NX6.0.4.
void SetAASamplesEnum (NXOpen::Display::StudioImageCaptureBuilder::AASamplesEnumType aASamplesEnum)
 Sets the antialiasing samples enum
Created in NX6.0.4.
void SetDpiEnum (NXOpen::Display::StudioImageCaptureBuilder::DPIEnumType dpiEnum)
 Sets the dpi enum
Created in NX6.0.4.
void SetDrawingSizeEnum (NXOpen::Display::StudioImageCaptureBuilder::DrawingSizeEnumType drawingSizeEnum)
 Sets the drawing size enum
Created in NX6.0.4.
void SetImageDimensionsDouble (const std::vector< double > &imageDimensionsDouble)
 Sets the double image dimensions, height and width
Created in NX6.0.4.
void SetImageDimensionsInteger (const std::vector< int > &imageDimensionsInteger)
 Sets the integer image dimensions, height and width
Created in NX6.0.4.
void SetNativeFileBrowser (const NXString &filename)
 Sets the native file browser for image type to produce
Created in NX6.0.4.
void SetOrientEnum (NXOpen::Display::StudioImageCaptureBuilder::OrientEnumType orientEnum)
 Sets the orient enum
Created in NX6.0.4.
void SetUnitsEnum (NXOpen::Display::StudioImageCaptureBuilder::UnitsEnumType unitsEnum)
 Sets the units enum
Created in NX6.0.4.
NXOpen::Display::StudioImageCaptureBuilder::UnitsEnumType UnitsEnum ()
 Returns the units enum
Created in NX6.0.4.

Detailed Description

Represents a Display::StudioImageCaptureBuilder
To create a new instance of this class, use ViewCollection::CreateStudioImageCaptureBuilder
Default values.

Property Value

AASamplesEnum

Sam0X

DpiEnum

Dpi72

DrawingSizeEnum

Isoa4

OrientEnum

Landscape

UnitsEnum

Pixels


Created in NX6.0.4.


Member Enumeration Documentation

Provide the following anti-aliasing sample size for off screen image capture.

Enumerator:
AASamplesEnumTypeSam0X 

Do not set sampling option.

AASamplesEnumTypeSam2X 

Set sampling at 2 times.

AASamplesEnumTypeSam4X 

Set sampling at 4 times.

AASamplesEnumTypeSam8X 

Set sampling at 8 times.

AASamplesEnumTypeSam16X 

Set sampling at 16 times.

Provide the following screen capture resolutions in dots per inch.

Enumerator:
DPIEnumTypeDpi72 

Set image at 72 DPI resolution.

DPIEnumTypeDpi150 

Set image at 150 DPI resolution.

Provide the following standard Drawing sizes.

Enumerator:
DrawingSizeEnumTypeIsoa4 

Use ISO A4 drawing size.

DrawingSizeEnumTypeIsoa3 

Use ISO A3 drawing size.

DrawingSizeEnumTypeIsoa2 

Use ISO A2 drawing size.

DrawingSizeEnumTypeIsoa1 

Use ISO A1 drawing size.

DrawingSizeEnumTypeIsoa0 

Use ISO A0 drawing size.

DrawingSizeEnumTypeAnsia 

Use ANSI A drawing size.

DrawingSizeEnumTypeAnsib 

Use ANSI B drawing size.

DrawingSizeEnumTypeAnsic 

Use ANSI C drawing size.

DrawingSizeEnumTypeAnsid 

Use ANSI D drawing size.

DrawingSizeEnumTypeAnsie 

Use ANSI E drawing size.

DrawingSizeEnumTypeCustom 

Use custom defined drawing size.

Provide the following options to image orientation.

Enumerator:
OrientEnumTypeLandscape 

Capture image in landscape mode.

OrientEnumTypePortrait 

Capture image in portrait mode.

Provide the following resolution unit options to screen capture.

Enumerator:
UnitsEnumTypePixels 

Use pixel to define resolution.

UnitsEnumTypeMm 

Use Millimeters to define resolution.

UnitsEnumTypeInches 

Use Inched to define resolution.


Member Function Documentation

Returns the antialiasing samples enum
Created in NX6.0.4.



License requirements : None

Returns the dpi enum
Created in NX6.0.4.



License requirements : None

Returns the drawing size enum
Created in NX6.0.4.



License requirements : None

Gets the double image dimensions, height and width.

Returns:
array of 2 doubles
Created in NX6.0.4.

License requirements : None

Gets the integer image dimensions, height and width.

Returns:
array of 2 integers
Created in NX6.0.4.

License requirements : None

Returns the native file browser for image type to produce
Created in NX6.0.4.



License requirements : None

Returns the orient enum
Created in NX6.0.4.



License requirements : None

Sets the antialiasing samples enum
Created in NX6.0.4.



License requirements : None

Parameters:
aASamplesEnumaasamplesenum

Sets the dpi enum
Created in NX6.0.4.



License requirements : None

Parameters:
dpiEnumdpienum

Sets the drawing size enum
Created in NX6.0.4.



License requirements : None

Parameters:
drawingSizeEnumdrawingsizeenum
void NXOpen::Display::StudioImageCaptureBuilder::SetImageDimensionsDouble ( const std::vector< double > &  imageDimensionsDouble)

Sets the double image dimensions, height and width
Created in NX6.0.4.



License requirements : None

Parameters:
imageDimensionsDoublearray of 2 doubles
void NXOpen::Display::StudioImageCaptureBuilder::SetImageDimensionsInteger ( const std::vector< int > &  imageDimensionsInteger)

Sets the integer image dimensions, height and width
Created in NX6.0.4.



License requirements : None

Parameters:
imageDimensionsIntegerarray of 2 integers

Sets the native file browser for image type to produce
Created in NX6.0.4.



License requirements : None

Parameters:
filenamefilename

Sets the orient enum
Created in NX6.0.4.



License requirements : None

Parameters:
orientEnumorientenum

Sets the units enum
Created in NX6.0.4.



License requirements : None

Parameters:
unitsEnumunitsenum

Returns the units enum
Created in NX6.0.4.



License requirements : None


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