Represents a @link Gateway::ImageCaptureBuilder Gateway::ImageCaptureBuilder@endlink  builder  <br> To create a new instance of this class, use @link Gateway::ImageCaptureManager::CreateImageCaptureBuilder  Gateway::ImageCaptureManager::CreateImageCaptureBuilder @endlink  <br>

Default values. More...

Inheritance diagram for NXOpen::Gateway::ImageCaptureBuilder:

Public Types
enum	CaptureMethodType { CaptureMethodTypeGraphicsArea, CaptureMethodTypeRegion, CaptureMethodTypeFile }
	the selection method More...

enum	ImageFormat { ImageFormatBmp, ImageFormatJpg, ImageFormatGif, ImageFormatPng, ImageFormatTiff }
	the image format More...

enum	ImageSize { ImageSizePixels16, ImageSizePixels24, ImageSizePixels32, ImageSizePixels48, ImageSizePixels64, ImageSizePixels96, ImageSizePixels128 }
	the image size More...

Public Member Functions
NXOpen::Gateway::ImageCaptureBuilder::CaptureMethodType	CaptureMethod ()
	Returns the capture method Created in NX7.5.0.

NXString	File ()
	Returns the file Created in NX7.5.0.

NXOpen::Gateway::ImageCaptureBuilder::ImageFormat	Format ()
	Returns the format Created in NX7.5.0.

void	GetRegion (std::vector< int > &topLeftCorner, std::vector< int > &bottomRightCorner)
	Returns the region Created in NX7.5.0.

NXString	ImageFile ()
	Returns the image file Created in NX7.5.0.

void	SetCaptureMethod (NXOpen::Gateway::ImageCaptureBuilder::CaptureMethodType captureMethod)
	Sets the capture method Created in NX7.5.0.

void	SetFile (const NXString &filename)
	Sets the file Created in NX7.5.0.

void	SetFile (const char *filename)
	Sets the file Created in NX7.5.0.

void	SetFormat (NXOpen::Gateway::ImageCaptureBuilder::ImageFormat format)
	Sets the format Created in NX7.5.0.

void	SetImageFile (const NXString &imageFilename)
	Sets the image file Created in NX7.5.0.

void	SetImageFile (const char *imageFilename)
	Sets the image file Created in NX7.5.0.

void	SetRegion (const std::vector< int > &topLeftCorner, const std::vector< int > &bottomRightCorner)
	Sets the region Created in NX7.5.0.

void	SetSize (NXOpen::Gateway::ImageCaptureBuilder::ImageSize size)
	Sets the size Created in NX7.5.0.

NXOpen::Gateway::ImageCaptureBuilder::ImageSize	Size ()
	Returns the size Created in NX7.5.0.

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 @link Gateway::ImageCaptureBuilder Gateway::ImageCaptureBuilder@endlink  builder  <br> To create a new instance of this class, use @link Gateway::ImageCaptureManager::CreateImageCaptureBuilder  Gateway::ImageCaptureManager::CreateImageCaptureBuilder @endlink  <br>

Default values.

Property

Value

CaptureMethod

GraphicsArea

Format

Bmp

Size

Pixels64

Created in NX7.5.0.

Member Enumeration Documentation

enum NXOpen::Gateway::ImageCaptureBuilder::CaptureMethodType

the selection method

Enumerator:

CaptureMethodTypeGraphicsArea	the graphics area
CaptureMethodTypeRegion	the region area
CaptureMethodTypeFile	the input from file

enum NXOpen::Gateway::ImageCaptureBuilder::ImageFormat

the image format

Enumerator:

ImageFormatBmp	the bmp image format
ImageFormatJpg	the jpg image format
ImageFormatGif	the gif image format
ImageFormatPng	the png image format
ImageFormatTiff	the tiff image format

enum NXOpen::Gateway::ImageCaptureBuilder::ImageSize

the image size

Enumerator:

ImageSizePixels16	the 16 pixel size
ImageSizePixels24	the 24 pixel size
ImageSizePixels32	the 32 pixel size
ImageSizePixels48	the 48 pixel size
ImageSizePixels64	the 64 pixel size
ImageSizePixels96	the 96 pixel size
ImageSizePixels128	the 128 pixel size

Member Function Documentation

NXOpen::Gateway::ImageCaptureBuilder::CaptureMethodType NXOpen::Gateway::ImageCaptureBuilder::CaptureMethod ( )

Returns the capture method
Created in NX7.5.0.

License requirements : None

NXString NXOpen::Gateway::ImageCaptureBuilder::File ( )

Returns the file
Created in NX7.5.0.

License requirements : None

NXOpen::Gateway::ImageCaptureBuilder::ImageFormat NXOpen::Gateway::ImageCaptureBuilder::Format ( )

Returns the format
Created in NX7.5.0.

License requirements : None

void NXOpen::Gateway::ImageCaptureBuilder::GetRegion	(	std::vector< int > &	topLeftCorner,
		std::vector< int > &	bottomRightCorner
	)

Returns the region
Created in NX7.5.0.

License requirements : None

Parameters

topLeftCorner	Array of 2 integers for Top Left Corner of Region
bottomRightCorner	Array of 2 integers for Bottom Right Corner of Region

NXString NXOpen::Gateway::ImageCaptureBuilder::ImageFile ( )

Returns the image file
Created in NX7.5.0.

License requirements : None

void NXOpen::Gateway::ImageCaptureBuilder::SetCaptureMethod ( NXOpen::Gateway::ImageCaptureBuilder::CaptureMethodType captureMethod )

Sets the capture method
Created in NX7.5.0.