Cognex.Vision NamespaceCognex VisionPro 9.20
 
Classes

  ClassDescription
Public classArgumentException
Public classArgumentNullException
Public classArgumentOutOfRangeException
Public classBadFileFormatException
Public classBadFileModeException
Public classBoolCollection

Class which holds a collection of bool.

Public classBulkChangedEventArgs

This class holds data provided by the BulkChanged event. The BulkChanged event is raised after a bulk change to the Polygon, such as a call to SetVertices. Since the amount of changed data could be quite large, the BulkChanged event only reports the new number of vertices after the change.

Public classCancelChangingStringEventArgs

This class provides arguments for a cancellable change to a string. These arguments include a copy of the old string value as well as a copy of the new string value. In addition, these arguments include a reference to an optional exception to be thrown should cancellation be activated. Cancellation is activated when the base class Cancel property is set to true.

Public classCancelEventArgs

This class provides a boolean argument to control the optional cancellation of an action during event processing. Unlike most event argument classes which simply deliver information to the subscriber, this argument class allows two-way communication. Specifically, a recipient of an event notification with an instance of this argument class may optionally set the Cancel property to true, thereby communicating to the source of the event that the action should be cancelled.

Public classCancelToken

An instance of this class is passed to an operation that can be cancelled.

Public classChangedEventArgs

Arguments of a Changed.

Public classChangedEventShareableBase

This is the base class for OMX classes that are both shareable and changeable. It extends the ShareableBase class by adding the IChangedEvent interface.

Public classCircle

Class that represents a circle.

Public classCircularAnnulusSection

A circular annulus section is a four-sided shape bounded by two circular arcs and two radial lines. The arcs are scaled copies of each other, and the radial lines connect the endpoints of the arcs. You specify the ( CenterX, CenterY ), Radius, AngleStart and AngleSpan which define the start arc and then provide a RadialScale that defines the end arc. If the RadialScale is less than 1, the start arc is the outer arc.

Public classCircularArc

A circular arc is a portion of a circle. You specify this shape using the usual circle parameters and two more: AngleStart and AngleSpan. AngleStart defines the angle at which the arc begins and AngleSpan defines the angular extent of the arc.

Public classColorConstants

Implements a set of predefined colors.

Public classCompositeException
Public classCompositeShape

Class that represents a composite shape : a shape made up of many child shapes.

Public classCoordinateAxes

Class that represents a pair of coordinate axes.

Public classCoordinateSpaceAngle

Type that holds an angle measurement and the name of the coordinate space in which it is measured.

Public classCoordinateSpaceTree

Tree of user coordinate spaces and the mappings between them.

Public classDataBinding

This class represents a DataBinding or "link" from one object's property (or sub-property) to another object's property (or sub-property).

Public classDataBindingCollection

Class which holds a collection of DataBinding objects.

Public classDoubleCollection

Class which holds a collection of doubles.

Public classDoubleReadOnlyCollection

Class which holds a read-only collection of doubles.

Public classDraggingEventArgs

This class provides data for the Dragging and DraggingStopped events of graphic shapes.

Public classEllipse

Class that represents an ellipse.

Public classEllipticalAnnulusSection

An elliptical annulus section is a four-sided shape bounded by two elliptical arcs and two straight lines. The arcs are scaled copies of each other. You specify the 'start' arc and then provide a RadialScale that defines the 'end' arc.

Public classEllipticalArc

An elliptical arc is a portion of an ellipse. You specify this shape using the usual ellipse parameters and two more: AngleStart and AngleSpan. AngleStart defines the angle at which the arc begins and AngleSpan defines the angular extent of the arc.

Public classEventArgs

A base class for event args.

Public classFileOpenException
Public classFileReadException
Public classFileWriteException
Public classFont

Class that defines a particular configuration for text, such as format, size and style.

Public classFontFamily

Represents a group of fonts that have a similar font face, but may have different sizes and styles.

Public classGenericException
Public classGraphicChildren

Collection of child graphics.

Public classGraphicCollection

Collection of graphics.

Public classGraphicInteractiveBase

Base implementation class that represents an interactive graphic.

Public classGraphicInteractiveCollection

Collection of interactive graphics.

Public classGraphicLabel

Class that represents a graphical text label.

Public classGraphicParentChildCollection

Collection of parent-child graphics.

Public classGraphicParentChildReadOnlyCollection

Read-only collection of parent-child graphics.

Public classIImageCollection

This class holds a collection of IImage.

Public classImage16Grey

An object that describes a rectangular array of 16 bit grey scale pixels.

Public classImage16Root

An object that holds raw 16-bit pixel data of an image.

Public classImage24PlanarColor

An object that describes three coincident rectangular arrays, or planes, of 8-bit pixels. Typically used for color images, where the 3 planes represent either RGB or HSI values.

Public classImage8Grey

An object that describes a rectangular array of 8 bit grey scale pixels.

Public classImage8GreyCollection

Class which holds a collection of Image8Grey.

Public classImage8Root

An object that holds raw 8-bit pixel data of an image.

Public classImageException
Public classInt32Collection

Class which holds a collection of 32-bit integers.

Public classInt64Collection

Class which holds a collection of 64-bit integers.

Public classInternalErrorException
Public classInvalidCastException
Public classInvalidOperationException
Public classIRegionCollection

A collection of IRegion objects.

Public classKeyNotFoundException
Public classLine

Class that represents a line.

Public classLineSegment

Class that represents a line segment.

Public classMaskGraphic

Class that represents a mask graphic.

Public classNameChangeEventArgs

This class provides data for the NameChanged event of a CoordinateSpaceTree.

Public classNoDataAvailableToProcessException
Public classNoFileOpenException
Public classNotImplementedException
Public classNotSupportedException
Public classObjectBase

This is the base class for non-shareable Vision classes. This class provides support for the IObject interface.

Public classOperatorInvalidRegionException
Public classOperatorInvalidShapeException
Public classOperatorNoInputImageException
Public classOperatorNoRunParamsException
Public classOperatorNoTrainImageException
Public classOperatorNotTrainedException
Public classOutOfMemoryException
Public classPelRect

Class that represents a simple coordinate axes aligned rectangle used to represent a rectangular window region in an integer coordinate system.

Public classPelRectCollection

Class which holds a collection of PelRect.

Public classPointMarker

Class that represents a graphical point marker.

Public classPolygon

Class that represents a polygon.

Public classPropertyWatcher

This class watches a property or sub-property of an object, and raises a Changed event when the value of the property has changed. Can also be used to set the value of a watched property.

Public classRecord

Class that holds information about the state of a tool.

Public classRecordCollection

Class that holds a collection of Record objects.

Public classRecordDisplayMethod

This class exists to be placed as content in a Record. This content may then be used by the RecordDisplay to drive the addition of an appropriately scaled coordinate space to the RecordDisplay's UserPixelTree. This can be useful when displaying standalone graphics such as a histogram diagram.

Public classRectangle

Class that represents a rectangle.

Public classRectangleAffine

Class that represents an affine rectangle.

Public classRectangleAffineCollection

Class which holds a collection of RectangleAffines.

Public classRectangleCollection

Class which holds a collection of Rectangles.

Public classRegionSizeMismatchException
Public classRegistration_
Public classScriptException
Public classSecurityViolationException
Public classSerializationException
Public classSerializer

This class provides convenient functions for serializing Vision objects. It allows you to save (load) an object to (from) files or streams. You should use these functions for serializing all Vision objects.

Public classShapeException
Public classShareableBase

This is the base class for shareable OMX classes. This class provides the ability of a class to supply a shared pointer to itself, and adds support for the IObject interface.

Public classSimpleColor

Class of simple nominal color value.

Public classSpaceAddEventArgs

This class provides data for the SpaceAdded of a CoordinateSpaceTree.

Public classSpaceTreeException
Public classStartup
This class is used to initialize and shutdown the product.
Public classStringCollection

Class which holds a collection of strings.

Public classStringDictionary

Class which holds a keyed collection of strings.

Public classStringReadOnlyCollection

Class which holds a read-only collection of strings.

Public classSubtreeDeleteEventArgs

This class provides data for the SubtreeDeleted of a CoordinateSpaceTree.

Public classSubtreeMoveEventArgs

This class provides data for the SubtreeMoved of a CoordinateSpaceTree.

Public classTimeoutExpiredException
Public classToolCollection

Class which holds a collection of Vision Tools.

Public classToolNoOperatorException
Public classToolNoResultException
Public classToolTrackingCollection

An ordered collection of Vision Tools that raises events whenever a change is made.

Public classTransform2DComposed

A Transform2DComposed is a transform object that can compose transforms of different types. The composed transform maps points through all its contained transformations (from 'Right' to 'Left'), and thus acts as their composition.

Public classTransform2DLinear

Linear 2D coordinate transform.

Public classTransform2DLinearCollection

Class which holds a collection of Transform2DLinears.

Public classTransform2DRigid

Rigid 2D coordinate transform.

Public classTransform2DRigidCollection

Class which holds a collection of Transform2DRigids.

Public classTransformChangeEventArgs

This class provides data for the TransformChanged of a CoordinateSpaceTree.

Public classTransformException
Public classTreeAddEventArgs

This class provides data for the TreeAdded of a CoordinateSpaceTree.

Public classUInt16Collection

Class which holds a collection of 16-bit unsigned integers.

Public classUInt8Collection

Class which holds a collection of 8-bit unsigned integers.

Public classVariantCollection

Class which holds a collection of Variants.

Public classVect2

This value class encapsulates a two dimensional point or vector. Note that this class is immutable - it may not be changed once it has been constructed. The default values for properties X and Y are 0.0.

Public classVect2Collection

Class which holds a collection of Vect2.

Public classVect2SetCollection

Class which holds a collection of Vect2Collection objects.

Public classVertexAddedEventArgs

This class holds data provided by the VertexAdded. The VertexAdded is raised after one, or possibly several vertices are added to a Polygon as a result of calling AddVertex or setting NumVertices.

Public classVertexChangedEventArgs

This class holds data provided by the VertexChanged. The VertexChanged is raised in addition to the standard Changed after the x-coordinate, y-coordinate, or both have changed for a single vertex. The change may occur as a result of calling a Polygon's SetVertexX, SetVertexY, or SetVetex methods. It also may occur if the vertex position is manipulated interactively in a display.

Public classVertexRemovedEventArgs

This class holds data provided by the VertexRemoved. The VertexRemoved is raised after one, or possibly several vertices are removed from a Polygon as a result of calling RemoveVertex or setting NumVertices.

Public classVisionException
Structures

  StructureDescription
Public structureColor32
Interfaces

  InterfaceDescription
Public interfaceIChangedEvent

This interface contains the ChangedEvent and methods for suspending and resuming it.

Public interfaceIDiamondGraphicShape
Public interfaceIGraphic

Interface to make an object renderable in a CognexDisplay control.

Public interfaceIGraphicHighlight

Interface of a highlight capable graphic.

Public interfaceIGraphicInteractive

Interface of an interactive graphic.

Public interfaceIGraphicMultiPen

IGraphicMultiPen defines an object that can hold pens used to draw graphics that may have many multi-colored sub-parts.

Public interfaceIGraphicParentChild

Interface implemented by any graphic that can be a parent and/or child.

Public interfaceIImage

Interface that describes a rectangular array of pixels.

Public interfaceIImage16GreyData

Interface that allows direct access to 16-bit grey scale pixel data.

Public interfaceIImage16PixelMemory

Interface to an object that provides direct pointer access to 8-bit image pixel memory.

Public interfaceIImage16Root

Interface to a root object that holds raw 16-bit pixel data of an image.

Public interfaceIImage16RootBuffer

Interface to a root object that holds raw 16-bit pixel data of an image in a static buffer.

Public interfaceIImage24PlanarColorData

Interface that allows direct access to all three planes of 8-bit image data.

Public interfaceIImage8GreyData

Interface that allows direct access to 8-bit grey scale pixel data.

Public interfaceIImage8PixelMemory

Interface to an object that provides direct pointer access to 8-bit image pixel memory.

Public interfaceIImage8Root

Interface to a root object that holds raw 8-bit pixel data of an image.

Public interfaceIImage8RootBuffer

Interface to a root object that holds raw 8-bit pixel data of an image in a static buffer.

Public interfaceIOwnedParams
Public interfaceIRecordConstructor

Interface implemented by an object that constructs the Content, Annotation, and SubRecords of a record when they are requested. This may allow one to avoid time-consuming computations and/or the creation of memory-consuming objects when they are not needed.

Public interfaceIRegion

Base interface for all closed shapes.

Public interfaceIRunStatus

This interface is returned by the RunStatus property of the ITool interface and provides general information about the last call to the tool's Run method. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run.

Public interfaceIShape

Base interface for all shapes.

Public interfaceITool

This interface is implemented by all Vision tools.

Public interfaceITransform2D

Common interface for all 2D transforms.

Enumerations

  EnumerationDescription
Public enumerationAddSpaceConstants

In a coordinate space tree each child of a given parent space must have a unique name. This enumeration specifies what action will be taken when the user attempts to add a duplicate child space name to an existing parent in the tree.

Public enumerationCircleDOFConstants

Enumeration that describes which degrees of freedom (DOF) are enabled for an interactive Circle shape. You can OR these constants to combine different degrees of freedom.

Public enumerationCircularAnnulusSectionCenterArcAdornmentConstants

Enumeration for circular annulus section center arc adornment.

Public enumerationCircularAnnulusSectionDirectionAdornmentConstants

Enumeration for circular annulus section direction adornments.

Public enumerationCircularAnnulusSectionDOFConstants

Enumeration that describes which degrees of freedom (DOF) are enabled for an interactive CircularAnnulusSection. You can OR these constants to combine different degrees of freedom.

Public enumerationCircularArcAdornmentConstants

Enumeration for circular arc end point adornments.

Public enumerationCircularArcDirectionAdornmentConstants

Enumeration for circular arc direction adornments. These adornment arrows can be used indicate the radial or arc direction.

Public enumerationCircularArcDisplayModeConstants

Enumeration for circular arc display modes.

Public enumerationCircularArcDOFConstants

Enumeration for the graphic degree of freedom enable constants of an interactive circular arc shape.

Public enumerationCompositeShapeCompositionModeConstants

Enumeration of composite shape composition modes.

Public enumerationCompositeShapeDirectionAdornmentConstants

Enumeration for composite shape direction adornments.

Public enumerationCompositeShapeDOFConstants

Enumeration for the graphic degree of freedom enable constants of an interactive composite shape.

Public enumerationCoordinateAxesDOFConstants

Enumeration for the graphic degree of freedom enable constants of an interactive coordinate axes.

Public enumerationCoordinateAxesEndPointAdornmentConstants

Enumeration for coordinate axes endpoint adornments.

Public enumerationCoordinateAxesModeConstants

Constants that determine which properties are used to draw the CoordinateAxes and how interactive manipulation affects the mathematical properties of the axes.

Public enumerationCoordinateSpaceAngleNormalizationModeConstants

Determines if a CoordinateSpaceAngle value rolls over at zero, 180, or never.

Public enumerationCopyShapeConstants

Enumeration of copy constants for duplicating shapes.

Public enumerationEllipseDirectionAdornmentConstants

Enumeration for ellipse direction adornments.

Public enumerationEllipseDOFConstants

Enumeration for the degree of freedom constants of an interactive ellipse shape.

Public enumerationEllipticalAnnulusSectionCenterArcAdornmentConstants

Enumeration for selecting a center arc adornment for the elliptical annulus section.

Public enumerationEllipticalAnnulusSectionDirectionAdornmentConstants

Enumeration for elliptical annulus section direction adornments. These adornment arrows can be used indicate the radial or arc direction.

Public enumerationEllipticalAnnulusSectionDOFConstants

Enumeration for the degree of freedom constants of an interactive elliptical annulus section shape. These constants control how the shape can be manipulated on a display.

Public enumerationEllipticalArcAdornmentConstants

Enumeration for elliptical arc endpoint adornments.

Public enumerationEllipticalArcDirectionAdornmentConstants

Enumeration for elliptical arc direction adornments. These adornment arrows indicate the direction from the start point of the arc to its end point.

Public enumerationEllipticalArcDOFConstants

Enumeration that describes which degrees of freedom (DOF) are enabled for an interactive EllipticalArc. You can OR these constants to combine different degrees of freedom.

Public enumerationFontStyleConstants

An enumeration that defines the style information applied to text.

Public enumerationGraphicDOFConstants

Enumeration for the degree of freedom for any shape.

Public enumerationGraphicLabelAlignmentConstants

Enumeration of alignment options for a GraphicLabel.

Public enumerationGraphicLabelDOFConstants

Enumeration for the graphic degree of freedom enable constants of an interactive text label.

Public enumerationGraphicLineStyleConstants

Enumeration of line style constants for drawing graphics.

Public enumerationGraphicMultiPenPenTypeConstants

Enumeration of pen types in IGraphicMultiPen.

Public enumerationImage16EncodingConstants

Enumeration of 16 bit image encoding.

Public enumerationImageColorSpaceConstants

Enumeration of color spaces.

Public enumerationImageConvertBayerTypeConstants

Enumeration of Bayer image types.

Public enumerationImageCopyModeConstants

Enumeration of modes that image copying supports.

Public enumerationImageDataModeConstants

Enumeration of modes for accessing pixel data of an image.

Public enumerationImagePlaneConstants

Enumeration of image planes.

Public enumerationLineAdornmentConstants

Enumeration for the line's reference point adornment.

Public enumerationLineDOFConstants

Enumeration for the graphic degree of freedom enable constants of an interactive line.

Public enumerationLineSegmentAdornmentConstants

Enumeration for line segment endpoint adornments.

Public enumerationLineSegmentDOFConstants

Enumeration for the degree of freedom constants of an interactive line segment.

Public enumerationLinkStateConstants

Enumeration of the possible states of a Link/DataBinding.

Public enumerationPinModeConstants

An enumeration used to describe how a ToolPin manages its value. Generally, ToolPins on a ToolBlock employ StoreValue mode while other tools employ FetchValue mode.

Public enumerationPointMarkerDOFConstants

Enumeration for the graphic degree of freedom enable constants of an interactive point marker.

Public enumerationPointMarkerGraphicTypeConstants

Enumeration of selections for GraphicType property in ICogPointMarker.

Public enumerationPolygonDOFConstants

Enumeration for the degree of freedom constants of an interactive polygon shape.

Public enumerationPolygonFillConstants

Enumeration of selections for FillMode property in Polygon.

Public enumerationPolygonVertexAdornmentConstants

Enumeration of vertex adornments.

Public enumerationPolygonVertexColorConstants

Enumeration of selections for VertexAdornmentColor property.

Public enumerationRecordUsageConstants

Constants that can be assigned to the RecordUsage property of a CogRecord to specify how it is used.

Public enumerationRectangleAffineDirectionAdornmentConstants

Enumeration for affine rectangle direction adornments.

Public enumerationRectangleAffineDOFConstants

Enumeration for the DOF constants of an interactive affine rectangle shape.

Public enumerationRectangleDOFConstants

Enumeration for the degree of freedom constants of an interactive rectangle shape.

Public enumerationRegionModeConstants

Enumeration of Region modes. Region mode specifies how a region is applied to an image.

Public enumerationSerializerOptionsConstants

This enumeration contains constants that are used to specify particular fields to be serialized or deserialized.

Public enumerationSpaceTreePathnameConstants

This enumeration controls the formatting of coordinate space names that are returned from a CoordinateSpaceTree.

Public enumerationStandardCursorConstants

Enumerates the standard mouse cursors that can be used with interactive graphics. The selected cursor will appear in the display whenever the mouse is hovering near the interactive graphic.

Public enumerationStartup ProductKey
Enumeration of product types. Do not change the values.
Public enumerationStartupWaitType
Enumeration of flags used for specifying the mode of waiting.
Public enumerationToolCopyModeConstants

Enumeration of modes that tool copying supports.

Public enumerationToolResultConstants

Enumeration of constants that indicate the overall result of running a tool.

Public enumerationVisionExceptionCodes