ImageCaptureBuilder Class¶
-
class
NXOpen.Gateway.
ImageCaptureBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Gateway.ImageCaptureBuilder
builderTo create a new instance of this class, use
NXOpen.Gateway.ImageCaptureManager.CreateImageCaptureBuilder()
Default values.
Property Value CaptureMethod GraphicsArea Format Bmp Size Pixels64 New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
CaptureMethod | Returns or sets the capture method |
File | Returns or sets the file |
Format | Returns or sets the format |
ImageFile | Returns or sets the image file |
Size | Returns or sets the size |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
GetRegion | Returns the region |
SetRegion | Sets the region |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
ImageCaptureBuilderCaptureMethodType Enumeration | the selection method |
ImageCaptureBuilderImageFormat Enumeration | the image format |
ImageCaptureBuilderImageSize Enumeration | the image size |
Property Detail¶
CaptureMethod¶
-
ImageCaptureBuilder.
CaptureMethod
¶ Returns or sets the capture method
-------------------------------------
Getter Method
Signature
CaptureMethod
Returns: Return type: NXOpen.Gateway.ImageCaptureBuilderCaptureMethodType
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CaptureMethod
Parameters: captureMethod ( NXOpen.Gateway.ImageCaptureBuilderCaptureMethodType
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
File¶
-
ImageCaptureBuilder.
File
¶ Returns or sets the file
-------------------------------------
Getter Method
Signature
File
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
File
Parameters: filename (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Format¶
-
ImageCaptureBuilder.
Format
¶ Returns or sets the format
-------------------------------------
Getter Method
Signature
Format
Returns: Return type: NXOpen.Gateway.ImageCaptureBuilderImageFormat
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Format
Parameters: format ( NXOpen.Gateway.ImageCaptureBuilderImageFormat
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
ImageFile¶
-
ImageCaptureBuilder.
ImageFile
¶ Returns or sets the image file
-------------------------------------
Getter Method
Signature
ImageFile
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ImageFile
Parameters: imageFilename (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Size¶
-
ImageCaptureBuilder.
Size
¶ Returns or sets the size
-------------------------------------
Getter Method
Signature
Size
Returns: Return type: NXOpen.Gateway.ImageCaptureBuilderImageSize
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Size
Parameters: size ( NXOpen.Gateway.ImageCaptureBuilderImageSize
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
GetRegion¶
-
ImageCaptureBuilder.
GetRegion
¶ Returns the region
Signature
GetRegion()
Returns: a tuple Return type: A tuple consisting of (topLeftCorner, bottomRightCorner) topLeftCorner is a list of int. Array of 2 integers for Top Left Corner of Region bottomRightCorner is a list of int. Array of 2 integers for Bottom Right Corner of Region New in version NX7.5.0.
License requirements: None.
SetRegion¶
-
ImageCaptureBuilder.
SetRegion
¶ Sets the region
Signature
SetRegion(topLeftCorner, bottomRightCorner)
Parameters: - topLeftCorner (list of int) – Array of 2 integers for Top Left Corner of Region
- bottomRightCorner (list of int) – Array of 2 integers for Bottom Right Corner of Region
New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
ImageCaptureBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.