| Class | Description | |
|---|---|---|
| ArgumentException | ||
| ArgumentNullException | ||
| ArgumentOutOfRangeException | ||
| BadFileFormatException | ||
| BadFileModeException | ||
| BoolCollection | Class which holds a collection of bool. | |
| BulkChangedEventArgs | 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. | |
| CancelChangingStringEventArgs | 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. | |
| CancelEventArgs | 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. | |
| CancelToken | An instance of this class is passed to an operation that can be cancelled. | |
| ChangedEventArgs | Arguments of a Changed. | |
| ChangedEventShareableBase | This is the base class for OMX classes that are both shareable and changeable. It extends the ShareableBase class by adding the IChangedEvent interface. | |
| Circle | Class that represents a circle. | |
| CircularAnnulusSection | 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. | |
| CircularArc | 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. | |
| ColorConstants | Implements a set of predefined colors. | |
| CompositeException | ||
| CompositeShape | Class that represents a composite shape : a shape made up of many child shapes. | |
| CoordinateAxes | Class that represents a pair of coordinate axes. | |
| CoordinateSpaceAngle | Type that holds an angle measurement and the name of the coordinate space in which it is measured. | |
| CoordinateSpaceTree | Tree of user coordinate spaces and the mappings between them. | |
| DataBinding | This class represents a DataBinding or "link" from one object's property (or sub-property) to another object's property (or sub-property). | |
| DataBindingCollection | Class which holds a collection of DataBinding objects. | |
| DoubleCollection | Class which holds a collection of doubles. | |
| DoubleReadOnlyCollection | Class which holds a read-only collection of doubles. | |
| DraggingEventArgs | This class provides data for the Dragging and DraggingStopped events of graphic shapes. | |
| Ellipse | Class that represents an ellipse. | |
| EllipticalAnnulusSection | 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. | |
| EllipticalArc | 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. | |
| EventArgs | A base class for event args. | |
| FileOpenException | ||
| FileReadException | ||
| FileWriteException | ||
| Font | Class that defines a particular configuration for text, such as format, size and style. | |
| FontFamily | Represents a group of fonts that have a similar font face, but may have different sizes and styles. | |
| GenericException | ||
| GraphicChildren | Collection of child graphics. | |
| GraphicCollection | Collection of graphics. | |
| GraphicInteractiveBase | Base implementation class that represents an interactive graphic. | |
| GraphicInteractiveCollection | Collection of interactive graphics. | |
| GraphicLabel | Class that represents a graphical text label. | |
| GraphicParentChildCollection | Collection of parent-child graphics. | |
| GraphicParentChildReadOnlyCollection | Read-only collection of parent-child graphics. | |
| IImageCollection | This class holds a collection of IImage. | |
| Image16Grey | An object that describes a rectangular array of 16 bit grey scale pixels. | |
| Image16Root | An object that holds raw 16-bit pixel data of an image. | |
| Image24PlanarColor | 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. | |
| Image8Grey | An object that describes a rectangular array of 8 bit grey scale pixels. | |
| Image8GreyCollection | Class which holds a collection of Image8Grey. | |
| Image8Root | An object that holds raw 8-bit pixel data of an image. | |
| ImageException | ||
| Int32Collection | Class which holds a collection of 32-bit integers. | |
| Int64Collection | Class which holds a collection of 64-bit integers. | |
| InternalErrorException | ||
| InvalidCastException | ||
| InvalidOperationException | ||
| IRegionCollection | A collection of IRegion objects. | |
| KeyNotFoundException | ||
| Line | Class that represents a line. | |
| LineSegment | Class that represents a line segment. | |
| MaskGraphic | Class that represents a mask graphic. | |
| NameChangeEventArgs | This class provides data for the NameChanged event of a CoordinateSpaceTree. | |
| NoDataAvailableToProcessException | ||
| NoFileOpenException | ||
| NotImplementedException | ||
| NotSupportedException | ||
| ObjectBase | This is the base class for non-shareable Vision classes. This class provides support for the IObject interface. | |
| OperatorInvalidRegionException | ||
| OperatorInvalidShapeException | ||
| OperatorNoInputImageException | ||
| OperatorNoRunParamsException | ||
| OperatorNoTrainImageException | ||
| OperatorNotTrainedException | ||
| OutOfMemoryException | ||
| PelRect | Class that represents a simple coordinate axes aligned rectangle used to represent a rectangular window region in an integer coordinate system. | |
| PelRectCollection | Class which holds a collection of PelRect. | |
| PointMarker | Class that represents a graphical point marker. | |
| Polygon | Class that represents a polygon. | |
| PropertyWatcher | 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. | |
| Record | Class that holds information about the state of a tool. | |
| RecordCollection | Class that holds a collection of Record objects. | |
| RecordDisplayMethod | 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. | |
| Rectangle | Class that represents a rectangle. | |
| RectangleAffine | Class that represents an affine rectangle. | |
| RectangleAffineCollection | Class which holds a collection of RectangleAffines. | |
| RectangleCollection | Class which holds a collection of Rectangles. | |
| RegionSizeMismatchException | ||
| Registration_ | ||
| ScriptException | ||
| SecurityViolationException | ||
| SerializationException | ||
| Serializer | 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. | |
| ShapeException | ||
| ShareableBase | 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. | |
| SimpleColor | Class of simple nominal color value. | |
| SpaceAddEventArgs | This class provides data for the SpaceAdded of a CoordinateSpaceTree. | |
| SpaceTreeException | ||
| Startup | This class is used to initialize and shutdown the product. | |
| StringCollection | Class which holds a collection of strings. | |
| StringDictionary | Class which holds a keyed collection of strings. | |
| StringReadOnlyCollection | Class which holds a read-only collection of strings. | |
| SubtreeDeleteEventArgs | This class provides data for the SubtreeDeleted of a CoordinateSpaceTree. | |
| SubtreeMoveEventArgs | This class provides data for the SubtreeMoved of a CoordinateSpaceTree. | |
| TimeoutExpiredException | ||
| ToolCollection | Class which holds a collection of Vision Tools. | |
| ToolNoOperatorException | ||
| ToolNoResultException | ||
| ToolTrackingCollection | An ordered collection of Vision Tools that raises events whenever a change is made. | |
| Transform2DComposed | 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. | |
| Transform2DLinear | Linear 2D coordinate transform. | |
| Transform2DLinearCollection | Class which holds a collection of Transform2DLinears. | |
| Transform2DRigid | Rigid 2D coordinate transform. | |
| Transform2DRigidCollection | Class which holds a collection of Transform2DRigids. | |
| TransformChangeEventArgs | This class provides data for the TransformChanged of a CoordinateSpaceTree. | |
| TransformException | ||
| TreeAddEventArgs | This class provides data for the TreeAdded of a CoordinateSpaceTree. | |
| UInt16Collection | Class which holds a collection of 16-bit unsigned integers. | |
| UInt8Collection | Class which holds a collection of 8-bit unsigned integers. | |
| VariantCollection | Class which holds a collection of Variants. | |
| Vect2 | 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. | |
| Vect2Collection | Class which holds a collection of Vect2. | |
| Vect2SetCollection | Class which holds a collection of Vect2Collection objects. | |
| VertexAddedEventArgs | 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. | |
| VertexChangedEventArgs | 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. | |
| VertexRemovedEventArgs | 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. | |
| VisionException |
| Structure | Description | |
|---|---|---|
| Color32 |
| Interface | Description | |
|---|---|---|
| IChangedEvent | This interface contains the ChangedEvent and methods for suspending and resuming it. | |
| IDiamondGraphicShape | ||
| IGraphic | Interface to make an object renderable in a CognexDisplay control. | |
| IGraphicHighlight | Interface of a highlight capable graphic. | |
| IGraphicInteractive | Interface of an interactive graphic. | |
| IGraphicMultiPen | IGraphicMultiPen defines an object that can hold pens used to draw graphics that may have many multi-colored sub-parts. | |
| IGraphicParentChild | Interface implemented by any graphic that can be a parent and/or child. | |
| IImage | Interface that describes a rectangular array of pixels. | |
| IImage16GreyData | Interface that allows direct access to 16-bit grey scale pixel data. | |
| IImage16PixelMemory | Interface to an object that provides direct pointer access to 8-bit image pixel memory. | |
| IImage16Root | Interface to a root object that holds raw 16-bit pixel data of an image. | |
| IImage16RootBuffer | Interface to a root object that holds raw 16-bit pixel data of an image in a static buffer. | |
| IImage24PlanarColorData | Interface that allows direct access to all three planes of 8-bit image data. | |
| IImage8GreyData | Interface that allows direct access to 8-bit grey scale pixel data. | |
| IImage8PixelMemory | Interface to an object that provides direct pointer access to 8-bit image pixel memory. | |
| IImage8Root | Interface to a root object that holds raw 8-bit pixel data of an image. | |
| IImage8RootBuffer | Interface to a root object that holds raw 8-bit pixel data of an image in a static buffer. | |
| IOwnedParams | ||
| IRecordConstructor | 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. | |
| IRegion | Base interface for all closed shapes. | |
| IRunStatus | 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. | |
| IShape | Base interface for all shapes. | |
| ITool | This interface is implemented by all Vision tools. | |
| ITransform2D | Common interface for all 2D transforms. |
| Enumeration | Description | |
|---|---|---|
| AddSpaceConstants | 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. | |
| CircleDOFConstants | ||
| CircularAnnulusSectionCenterArcAdornmentConstants | Enumeration for circular annulus section center arc adornment. | |
| CircularAnnulusSectionDirectionAdornmentConstants | Enumeration for circular annulus section direction adornments. | |
| CircularAnnulusSectionDOFConstants | 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. | |
| CircularArcAdornmentConstants | Enumeration for circular arc end point adornments. | |
| CircularArcDirectionAdornmentConstants | Enumeration for circular arc direction adornments. These adornment arrows can be used indicate the radial or arc direction. | |
| CircularArcDisplayModeConstants | Enumeration for circular arc display modes. | |
| CircularArcDOFConstants | Enumeration for the graphic degree of freedom enable constants of an interactive circular arc shape. | |
| CompositeShapeCompositionModeConstants | Enumeration of composite shape composition modes. | |
| CompositeShapeDirectionAdornmentConstants | Enumeration for composite shape direction adornments. | |
| CompositeShapeDOFConstants | Enumeration for the graphic degree of freedom enable constants of an interactive composite shape. | |
| CoordinateAxesDOFConstants | Enumeration for the graphic degree of freedom enable constants of an interactive coordinate axes. | |
| CoordinateAxesEndPointAdornmentConstants | Enumeration for coordinate axes endpoint adornments. | |
| CoordinateAxesModeConstants | Constants that determine which properties are used to draw the CoordinateAxes and how interactive manipulation affects the mathematical properties of the axes. | |
| CoordinateSpaceAngleNormalizationModeConstants | Determines if a CoordinateSpaceAngle value rolls over at zero, 180, or never. | |
| CopyShapeConstants | Enumeration of copy constants for duplicating shapes. | |
| EllipseDirectionAdornmentConstants | Enumeration for ellipse direction adornments. | |
| EllipseDOFConstants | Enumeration for the degree of freedom constants of an interactive ellipse shape. | |
| EllipticalAnnulusSectionCenterArcAdornmentConstants | Enumeration for selecting a center arc adornment for the elliptical annulus section. | |
| EllipticalAnnulusSectionDirectionAdornmentConstants | Enumeration for elliptical annulus section direction adornments. These adornment arrows can be used indicate the radial or arc direction. | |
| EllipticalAnnulusSectionDOFConstants | 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. | |
| EllipticalArcAdornmentConstants | Enumeration for elliptical arc endpoint adornments. | |
| EllipticalArcDirectionAdornmentConstants | Enumeration for elliptical arc direction adornments. These adornment arrows indicate the direction from the start point of the arc to its end point. | |
| EllipticalArcDOFConstants | 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. | |
| FontStyleConstants | An enumeration that defines the style information applied to text. | |
| GraphicDOFConstants | Enumeration for the degree of freedom for any shape. | |
| GraphicLabelAlignmentConstants | Enumeration of alignment options for a GraphicLabel. | |
| GraphicLabelDOFConstants | Enumeration for the graphic degree of freedom enable constants of an interactive text label. | |
| GraphicLineStyleConstants | Enumeration of line style constants for drawing graphics. | |
| GraphicMultiPenPenTypeConstants | Enumeration of pen types in IGraphicMultiPen. | |
| Image16EncodingConstants | Enumeration of 16 bit image encoding. | |
| ImageColorSpaceConstants | Enumeration of color spaces. | |
| ImageConvertBayerTypeConstants | Enumeration of Bayer image types. | |
| ImageCopyModeConstants | Enumeration of modes that image copying supports. | |
| ImageDataModeConstants | Enumeration of modes for accessing pixel data of an image. | |
| ImagePlaneConstants | Enumeration of image planes. | |
| LineAdornmentConstants | Enumeration for the line's reference point adornment. | |
| LineDOFConstants | Enumeration for the graphic degree of freedom enable constants of an interactive line. | |
| LineSegmentAdornmentConstants | Enumeration for line segment endpoint adornments. | |
| LineSegmentDOFConstants | Enumeration for the degree of freedom constants of an interactive line segment. | |
| LinkStateConstants | Enumeration of the possible states of a Link/DataBinding. | |
| PinModeConstants | ||
| PointMarkerDOFConstants | Enumeration for the graphic degree of freedom enable constants of an interactive point marker. | |
| PointMarkerGraphicTypeConstants | Enumeration of selections for GraphicType property in ICogPointMarker. | |
| PolygonDOFConstants | Enumeration for the degree of freedom constants of an interactive polygon shape. | |
| PolygonFillConstants | Enumeration of selections for FillMode property in Polygon. | |
| PolygonVertexAdornmentConstants | Enumeration of vertex adornments. | |
| PolygonVertexColorConstants | Enumeration of selections for VertexAdornmentColor property. | |
| RecordUsageConstants | Constants that can be assigned to the RecordUsage property of a CogRecord to specify how it is used. | |
| RectangleAffineDirectionAdornmentConstants | Enumeration for affine rectangle direction adornments. | |
| RectangleAffineDOFConstants | Enumeration for the DOF constants of an interactive affine rectangle shape. | |
| RectangleDOFConstants | Enumeration for the degree of freedom constants of an interactive rectangle shape. | |
| RegionModeConstants | Enumeration of Region modes. Region mode specifies how a region is applied to an image. | |
| SerializerOptionsConstants | This enumeration contains constants that are used to specify particular fields to be serialized or deserialized. | |
| SpaceTreePathnameConstants | This enumeration controls the formatting of coordinate space names that are returned from a CoordinateSpaceTree. | |
| StandardCursorConstants | 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. | |
| Startup ProductKey | Enumeration of product types. Do not change the values. | |
| StartupWaitType | Enumeration of flags used for specifying the mode of waiting. | |
| ToolCopyModeConstants | Enumeration of modes that tool copying supports. | |
| ToolResultConstants | Enumeration of constants that indicate the overall result of running a tool. | |
| VisionExceptionCodes |