|
NXOpen .NET Reference Guide
1899
|
|
NXOpen .NET Reference Guide
1899
|
Captures the image in the active graphics window (or in a rectangular region of the active graphics window), and then exports/saves the image in a file of a specified format. More...
Public Types | |
| enum | BackgroundOptions { Original, CustomColor, Transparent } |
| The background style of the captured image. More... | |
| enum | FileFormats { Png, Jpg, Gif, Tiff, Bmp, Xwd } |
| The format of the exported image file. More... | |
Public Member Functions | |
| unsafe double[] | GetCustomBackgroundColor () |
| Returns the background color the image will be captured with if Gateway.ImageExportBuilder.BackgroundOption is set to Custom Color. More... | |
| unsafe int[] | GetRegionTopLeftPoint () |
| Returns the top left point of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true. More... | |
| unsafe void | SetCustomBackgroundColor (double[] customBackgroundColor) |
| Sets the background color the image will be captured with if Gateway.ImageExportBuilder.BackgroundOption is set to Custom Color. More... | |
| unsafe void | SetRegionTopLeftPoint (int[] regionTopLeftPoint) |
| Sets the top left point of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true. More... | |
 Public Member Functions inherited from NXOpen.Builder | |
| unsafe NXOpen.NXObject | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| unsafe void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| unsafe NXOpen.NXObject[] | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| unsafe NXOpen.NXObject | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| unsafe void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| unsafe bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen.TaggedObject | |
| void | PrintTestData (String variableName) |
| <exclude> More... | |
| void | PrintTestData (String variableName, int lineNumber) |
| <exclude> More... | |
| override string | ToString () |
| Returns a String that represents the current Object. More... | |
| Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject | |
| IMessageCtrl | AsyncProcessMessage (IMessage msg, IMessageSink replySink) |
| Asynchronously processes the given message. More... | |
| IMessage | SyncProcessMessage (IMessage msg) |
| Synchronously processes the given message. More... | |
Properties | |
| unsafe NXOpen.Gateway.ImageExportBuilder.BackgroundOptions | BackgroundOption [get, set] |
| Returns or sets the background style used when capturing the image. More... | |
| unsafe bool | EnhanceEdges [get, set] |
| Returns or sets a boolean value that, if true, indicates the image will be captured with antialiasing disabled and edge emphasis enabled. More... | |
| unsafe NXOpen.Gateway.ImageExportBuilder.FileFormats | FileFormat [get, set] |
| Returns or sets the file format of the exported image file. More... | |
| unsafe string | FileName [get, set] |
| Returns or sets the full path of the exported image file. More... | |
| unsafe int | RegionHeight [get, set] |
| Returns or sets the height of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true. More... | |
| unsafe bool | RegionMode [get, set] |
| Returns or sets a boolean value that, if true, indicates that a rectangular region of the graphics window will be captured, rather than the entire graphics window. More... | |
| unsafe int | RegionWidth [get, set] |
| Returns or sets the width of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true. More... | |
| Properties inherited from NXOpen.Builder | |
| unsafe NXOpen.PreviewBuilder | PreviewBuilder [get] |
| Returns the preview builder subobject. More... | |
| Properties inherited from NXOpen.TaggedObject | |
| Tag | Tag [get] |
| Returns the tag of this object. More... | |
| Properties inherited from NXOpen.Utilities.NXRemotableObject | |
| IMessageSink | NextSink [get] |
| Gets the next message sink in the sink chain. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from NXOpen.TaggedObject | |
| new void | initialize () |
| <exclude> More... | |
Captures the image in the active graphics window (or in a rectangular region of the active graphics window), and then exports/saves the image in a file of a specified format.
This class can be used to export an image file that contains the contents of the active graphics window. The image may be limited to a rectangular region of the display via Gateway.ImageExportBuilder.RegionMode . Gateway.ImageExportBuilder.FileFormats enumerates the file formats exported images may be saved in. The background of the exported image may be changed to any of the options available in Gateway.ImageExportBuilder.BackgroundOptions . After configuring the image export, an image file is saved by calling the Commit method.
To create a new instance of this class, use NXOpen.UI.CreateImageExportBuilder
Default values.
| Property | Value |
|---|---|
|
BackgroundOption |
Original |
|
FileFormat |
Png |
Created in NX12.0.1
The background style of the captured image.
| Enumerator | |
|---|---|
| Original |
Use the currently displayed background |
| CustomColor |
Use the solid color set by Gateway.ImageExportBuilder.SetCustomBackgroundColor |
| Transparent |
Use a transparent background (only available in PNG and TIFF file formats) |
|
inline |
Returns the background color the image will be captured with if Gateway.ImageExportBuilder.BackgroundOption is set to Custom Color.
Created in NX12.0.1
License requirements: None.
|
inline |
Returns the top left point of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true.
This value is a window coordinate. See Gateway.ImageExportBuilder.RegionMode for more information on capturing a region of the graphics window.
Created in NX12.0.1
License requirements: None.
|
inline |
Sets the background color the image will be captured with if Gateway.ImageExportBuilder.BackgroundOption is set to Custom Color.
Created in NX12.0.1
License requirements: None.
| customBackgroundColor | Array of 3 RGB values, each between 0 and 1 |
|
inline |
Sets the top left point of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true.
This value is a window coordinate. See Gateway.ImageExportBuilder.RegionMode for more information on capturing a region of the graphics window.
Created in NX12.0.1
License requirements: None.
| regionTopLeftPoint | Array of 2 int values representing the x and y window coordinate of the top left point of the captured region |
|
getset |
Returns or sets the background style used when capturing the image.
The image may be captured with any of the background styles enumerated in Gateway.ImageExportBuilder.BackgroundOptions . If the Custom Color background option is used, the background color may be specified with Gateway.ImageExportBuilder.SetCustomBackgroundColor .
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets a boolean value that, if true, indicates the image will be captured with antialiasing disabled and edge emphasis enabled.
When capturing an image with many edges, such as a wireframe view of a part, antialiasing may cause thin edges to blur with the background of the image. This effect may be particularly noticeable when using a transparent background. Disabling antialiasing and enabling edge emphasis helps to eliminate this blurring at the cost of a more pixelated image.
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the file format of the exported image file.
The exported image may be stored in any of the file formats enumerated in Gateway.ImageExportBuilder.FileFormats . Please note that transparency is only available in TIFF and PNG formats.
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the full path of the exported image file.
This value should be set to the desired destination of the exported image file.
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the height of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true.
See Gateway.ImageExportBuilder.RegionMode for more information on capturing a region of the graphics window.
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets a boolean value that, if true, indicates that a rectangular region of the graphics window will be captured, rather than the entire graphics window.
The region used to generate the image file is defined using Gateway.ImageExportBuilder.SetRegionTopLeftPoint , Gateway.ImageExportBuilder.RegionWidth and Gateway.ImageExportBuilder.RegionHeight .
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
|
getset |
Returns or sets the width of the region of the graphics window that will be captured if Gateway.ImageExportBuilder.RegionMode is true.
See Gateway.ImageExportBuilder.RegionMode for more information on capturing a region of the graphics window.
Created in NX12.0.1
License requirements to get this property: None.
License requirements to set this property: None.
