Represents a Display::StudioImageCaptureBuilder
This class is restricted to being called from a program running during an Interactive NX session. More...

Inheritance diagram for NXOpen::Display::StudioImageCaptureBuilder:

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	SetNativeFileBrowser (const char *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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Display::StudioImageCaptureBuilder
This class is restricted to being called from a program running during an Interactive NX session.

If run from a non-interactive session it will return NULL.

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

enum NXOpen::Display::StudioImageCaptureBuilder::AASamplesEnumType

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.

enum NXOpen::Display::StudioImageCaptureBuilder::DPIEnumType

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.

enum NXOpen::Display::StudioImageCaptureBuilder::DrawingSizeEnumType

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.

enum NXOpen::Display::StudioImageCaptureBuilder::OrientEnumType

Provide the following options to image orientation.

Enumerator:

OrientEnumTypeLandscape	Capture image in landscape mode.
OrientEnumTypePortrait	Capture image in portrait mode.

enum NXOpen::Display::StudioImageCaptureBuilder::UnitsEnumType

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

NXOpen::Display::StudioImageCaptureBuilder::AASamplesEnumType NXOpen::Display::StudioImageCaptureBuilder::AASamplesEnum ( )

Returns the antialiasing samples enum
Created in NX6.0.4.

License requirements : None

NXOpen::Display::StudioImageCaptureBuilder::DPIEnumType NXOpen::Display::StudioImageCaptureBuilder::DpiEnum ( )

Returns the dpi enum
Created in NX6.0.4.

License requirements : None

NXOpen::Display::StudioImageCaptureBuilder::DrawingSizeEnumType NXOpen::Display::StudioImageCaptureBuilder::DrawingSizeEnum ( )

Returns the drawing size enum
Created in NX6.0.4.

License requirements : None

std::vector<double> NXOpen::Display::StudioImageCaptureBuilder::GetImageDimensionsDouble ( )

Gets the double image dimensions, height and width.

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

License requirements : None

std::vector<int> NXOpen::Display::StudioImageCaptureBuilder::GetImageDimensionsInteger ( )

Gets the integer image dimensions, height and width.

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

License requirements : None

NXString NXOpen::Display::StudioImageCaptureBuilder::NativeFileBrowser ( )

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

License requirements : None

NXOpen::Display::StudioImageCaptureBuilder::OrientEnumType NXOpen::Display::StudioImageCaptureBuilder::OrientEnum ( )

Returns the orient enum
Created in NX6.0.4.

License requirements : None

void NXOpen::Display::StudioImageCaptureBuilder::SetAASamplesEnum ( NXOpen::Display::StudioImageCaptureBuilder::AASamplesEnumType aASamplesEnum )

Sets the antialiasing samples enum
Created in NX6.0.4.

License requirements : None

Parameters

aASamplesEnum aasamplesenum

void NXOpen::Display::StudioImageCaptureBuilder::SetDpiEnum ( NXOpen::Display::StudioImageCaptureBuilder::DPIEnumType dpiEnum )

Sets the dpi enum
Created in NX6.0.4.

License requirements : None

Parameters

dpiEnum dpienum

void NXOpen::Display::StudioImageCaptureBuilder::SetDrawingSizeEnum ( NXOpen::Display::StudioImageCaptureBuilder::DrawingSizeEnumType drawingSizeEnum )

Sets the drawing size enum
Created in NX6.0.4.

License requirements : None

Parameters

drawingSizeEnum drawingsizeenum

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

imageDimensionsDouble array 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

imageDimensionsInteger array of 2 integers

void NXOpen::Display::StudioImageCaptureBuilder::SetNativeFileBrowser ( const NXString & filename )

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

License requirements : None

Parameters

filename filename

void NXOpen::Display::StudioImageCaptureBuilder::SetNativeFileBrowser ( const char * filename )

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

License requirements : None

Parameters

filename filename

void NXOpen::Display::StudioImageCaptureBuilder::SetOrientEnum ( NXOpen::Display::StudioImageCaptureBuilder::OrientEnumType orientEnum )

Sets the orient enum
Created in NX6.0.4.

License requirements : None

Parameters

orientEnum orientenum

void NXOpen::Display::StudioImageCaptureBuilder::SetUnitsEnum ( NXOpen::Display::StudioImageCaptureBuilder::UnitsEnumType unitsEnum )

Sets the units enum
Created in NX6.0.4.

License requirements : None

Parameters

unitsEnum unitsenum

NXOpen::Display::StudioImageCaptureBuilder::UnitsEnumType NXOpen::Display::StudioImageCaptureBuilder::UnitsEnum ( )

Returns the units enum
Created in NX6.0.4.

License requirements : None

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

Display_StudioImageCaptureBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation