Represents a NXOpen.Gateway.ImageCaptureBuilder builder More...

Inheritance diagram for NXOpen.Gateway.ImageCaptureBuilder:

Public Types
enum	CaptureMethodType { GraphicsArea, Region, File, Automatic }
	the selection method More...

enum	ImageFormat { Bmp, Jpg, Gif, Png, Tiff }
	the image format More...

enum	ImageSize { Pixels16, Pixels24, Pixels32, Pixels48, Pixels64, Pixels96, Pixels128 }
	the image size More...

Public Member Functions
unsafe void	GetRegion (out int[] topLeftCorner, out int[] bottomRightCorner)
	Returns the region More...

unsafe void	SetRegion (int[] topLeftCorner, int[] bottomRightCorner)
	Sets the region 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.ImageCaptureBuilder.CaptureMethodType	CaptureMethod `[get, set]`
	Returns or sets the capture method More...

unsafe string	File `[get, set]`
	Returns or sets the file More...

unsafe NXOpen.Gateway.ImageCaptureBuilder.ImageFormat	Format `[get, set]`
	Returns or sets the format More...

unsafe string	ImageFile `[get, set]`
	Returns or sets the image file More...

unsafe NXOpen.Gateway.ImageCaptureBuilder.ImageSize	Size `[get, set]`
	Returns or sets the size 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...

Detailed Description

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

Member Enumeration Documentation

enum NXOpen.Gateway.ImageCaptureBuilder.CaptureMethodType

the selection method

Enumerator
GraphicsArea	the graphics area
Region	the region area
File	the input from file
Automatic	the automatic preview mode

enum NXOpen.Gateway.ImageCaptureBuilder.ImageFormat

the image format

Enumerator
Bmp	the bmp image format
Jpg	the jpg image format
Gif	the gif image format
Png	the png image format
Tiff	the tiff image format

enum NXOpen.Gateway.ImageCaptureBuilder.ImageSize

the image size

Enumerator
Pixels16	the 16 pixel size
Pixels24	the 24 pixel size
Pixels32	the 32 pixel size
Pixels48	the 48 pixel size
Pixels64	the 64 pixel size
Pixels96	the 96 pixel size
Pixels128	the 128 pixel size

Member Function Documentation

unsafe void NXOpen.Gateway.ImageCaptureBuilder.GetRegion	(	out int[]	topLeftCorner,
		out int[]	bottomRightCorner
	)

inline

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

unsafe void NXOpen.Gateway.ImageCaptureBuilder.SetRegion	(	int[]	topLeftCorner,
		int[]	bottomRightCorner
	)

inline

Sets the region

Created in NX7.5.0

License requirements: drafting ("DRAFTING")

Parameters

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

Property Documentation

unsafe NXOpen.Gateway.ImageCaptureBuilder.CaptureMethodType NXOpen.Gateway.ImageCaptureBuilder.CaptureMethod

getset

Returns or sets the capture method

Created in NX7.5.0

License requirements to get this property: None.