NX Open C++ Reference Guide
|
Represents a NXOpen::Gateway::ImageCaptureBuilder builder
To create a new instance of this class, use NXOpen::Gateway::ImageCaptureManager::CreateImageCaptureBuilder
Default values.
More...
Public Types | |
enum | CaptureMethodType { CaptureMethodTypeGraphicsArea, CaptureMethodTypeRegion, CaptureMethodTypeFile, CaptureMethodTypeAutomatic } |
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. More... | |
NXString | File () |
Returns the file Created in NX7.5.0. More... | |
NXOpen::Gateway::ImageCaptureBuilder::ImageFormat | Format () |
Returns the format Created in NX7.5.0. More... | |
void | GetRegion (std::vector< int > &topLeftCorner, std::vector< int > &bottomRightCorner) |
Returns the region Created in NX7.5.0. More... | |
NXString | ImageFile () |
Returns the image file Created in NX7.5.0. More... | |
void | SetCaptureMethod (NXOpen::Gateway::ImageCaptureBuilder::CaptureMethodType captureMethod) |
Sets the capture method Created in NX7.5.0. More... | |
void | SetFile (const NXString &filename) |
Sets the file Created in NX7.5.0. More... | |
void | SetFile (const char *filename) |
Sets the file Created in NX7.5.0. More... | |
void | SetFormat (NXOpen::Gateway::ImageCaptureBuilder::ImageFormat format) |
Sets the format Created in NX7.5.0. More... | |
void | SetImageFile (const NXString &imageFilename) |
Sets the image file Created in NX7.5.0. More... | |
void | SetImageFile (const char *imageFilename) |
Sets the image file Created in NX7.5.0. More... | |
void | SetRegion (const std::vector< int > &topLeftCorner, const std::vector< int > &bottomRightCorner) |
Sets the region Created in NX7.5.0. More... | |
void | SetSize (NXOpen::Gateway::ImageCaptureBuilder::ImageSize size) |
Sets the size Created in NX7.5.0. More... | |
NXOpen::Gateway::ImageCaptureBuilder::ImageSize | Size () |
Returns the size Created in NX7.5.0. More... | |
Public Member Functions inherited from NXOpen::Builder | |
NXOpen::NXObject * | Commit () |
Commits any edits that have been applied to the builder. More... | |
void | Destroy () |
Deletes the builder, and cleans up any objects created by the builder. More... | |
std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
For builders that create more than one object, this method returns the objects that are created by commit. More... | |
NXOpen::NXObject * | GetObject () |
Returns the object currently being edited by this builder. More... | |
void | ShowResults () |
Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. More... | |
Public Member Functions inherited from NXOpen::TaggedObject | |
tag_t | Tag () const |
Returns the tag of this object. More... | |
Represents a NXOpen::Gateway::ImageCaptureBuilder builder
To create a new instance of this class, use NXOpen::Gateway::ImageCaptureManager::CreateImageCaptureBuilder
Default values.
Property | Value |
---|---|
CaptureMethod |
GraphicsArea |
Format |
Bmp |
Size |
Pixels64 |
Created in NX7.5.0.
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
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.
License requirements : drafting ("DRAFTING")
captureMethod | capturemethod |
void NXOpen::Gateway::ImageCaptureBuilder::SetFile | ( | const NXString & | filename | ) |
Sets the file
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
filename | filename |
void NXOpen::Gateway::ImageCaptureBuilder::SetFile | ( | const char * | filename | ) |
Sets the file
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
filename | filename |
void NXOpen::Gateway::ImageCaptureBuilder::SetFormat | ( | NXOpen::Gateway::ImageCaptureBuilder::ImageFormat | format | ) |
Sets the format
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
format | format |
void NXOpen::Gateway::ImageCaptureBuilder::SetImageFile | ( | const NXString & | imageFilename | ) |
Sets the image file
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
imageFilename | imagefilename |
void NXOpen::Gateway::ImageCaptureBuilder::SetImageFile | ( | const char * | imageFilename | ) |
Sets the image file
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
imageFilename | imagefilename |
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")
topLeftCorner | Array of 2 integers for Top Left Corner of Region |
bottomRightCorner | Array of 2 integers for Bottom Right Corner of Region |
void NXOpen::Gateway::ImageCaptureBuilder::SetSize | ( | NXOpen::Gateway::ImageCaptureBuilder::ImageSize | size | ) |
Sets the size
Created in NX7.5.0.
License requirements : drafting ("DRAFTING")
size | size |
NXOpen::Gateway::ImageCaptureBuilder::ImageSize NXOpen::Gateway::ImageCaptureBuilder::Size | ( | ) |
Returns the size
Created in NX7.5.0.
License requirements : None