NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Gateway::ImageCaptureBuilder Class Reference

Represents a Gateway::ImageCaptureBuilder builder
To create a new instance of this class, use Gateway::ImageCaptureManager::CreateImageCaptureBuilder
Default values. More...

Inheritance diagram for NXOpen::Gateway::ImageCaptureBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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 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 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.

Detailed Description

Represents a Gateway::ImageCaptureBuilder builder
To create a new instance of this class, use Gateway::ImageCaptureManager::CreateImageCaptureBuilder
Default values.

Property Value

CaptureMethod

GraphicsArea

Format

Bmp

Size

Pixels64


Created in NX7.5.0.


Member Enumeration Documentation

the selection method

Enumerator:
CaptureMethodTypeGraphicsArea 

the graphics area

CaptureMethodTypeRegion 

the region area

CaptureMethodTypeFile 

the input from file

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

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

Returns the capture method
Created in NX7.5.0.



License requirements : None

Returns the file
Created in NX7.5.0.



License requirements : None

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:
topLeftCornerArray of 2 integers for Top Left Corner of Region
bottomRightCornerArray of 2 integers for Bottom Right Corner of Region

Returns the image file
Created in NX7.5.0.



License requirements : None

Sets the capture method
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
captureMethodcapturemethod

Sets the file
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
filenamefilename

Sets the format
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
formatformat

Sets the image file
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
imageFilenameimagefilename
void NXOpen::Gateway::ImageCaptureBuilder::SetRegion ( const std::vector< int > &  topLeftCorner,
const std::vector< int > &  bottomRightCorner 
)

Sets the region
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
topLeftCornerArray of 2 integers for Top Left Corner of Region
bottomRightCornerArray of 2 integers for Bottom Right Corner of Region

Sets the size
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters:
sizesize

Returns the size
Created in NX7.5.0.



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.