CogSurfaceFXTool PropertiesCognex VisionPro 9.21 SR1

The CogSurfaceFXTool type exposes the following members.

Properties

  NameDescription
Protected propertyCanRaiseEvents
Gets a value indicating whether the component can raise an event.
(Inherited from Component.)
Public propertyChangedEventSuspended
If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventComponentBase.)
Public propertyContainer
Gets the IContainer that contains the Component.
(Inherited from Component.)
Public propertyCurrentRecordEnable
Enable the creation of graphical tool records by bitwise ORing the desired values from CogSurfaceFXCurrentRecordConstants.
Public propertyDataBindings
Gets the data bindings for the tool.
(Inherited from CogToolBase.)
Protected propertyDesignMode
Gets a value that indicates whether the Component is currently in design mode.
(Inherited from Component.)
Protected propertyEvents
Gets the list of event handlers that are attached to this Component.
(Inherited from Component.)
Public propertyFailOnInvalidDataBinding
Specifies that the Run method is to fail if executed while one or more data bindings are invalid.
(Inherited from CogToolBase.)
Public propertyHasChanged (Inherited from CogSerializableChangedEventComponentBase.)
Public propertyInputVisionData
Gets or Sets the input vision data container. When a CogSurfaceFXTool is first constructed, the InputVisionData property is pre - populated with a CogVisionDataContainer that has four "null" images. As a convenience, the keys that identify these images are pre - defined to be "LitFromRight", "LitFromBottom", etc. If the user hates these keys they can replace the entire CogVisionDataContainer with a new one that has completely different keys.

When a user replaces the InputVisionData property, the CogSurfaceFXTool will immediately verify that the container has four items, with keys that are suitable as names in a coordinate space tree. Each item must be an ICogImage, or null. We only insist that each image is a CogImage8Grey at runtime. Replacing the InputVisionData container fires a Changed event for that property, and also for the individual image properties if they are different.

At runtime, the CogSurfaceFX operator will check that the InputVisionData property contains exactly four images of type CogImage8Grey. It will assume that the first image in the container was lit from the right, the second image was lit from below, etc. The key strings that are associated with each image will only be used as a space name in the merged coordinate space tree of the output image, if they are used at all.

Public propertyLastRunRecordDiagEnable
Enable the creation of graphical tool records by bitwise ORing the desired values from CogSurfaceFXLastRunRecordDiagConstants.
Public propertyLastRunRecordEnable
Enable the creation of graphical tool records by bitwise ORing the desired values from CogSurfaceFXLastRunRecordConstants.
Public propertyLitFromBottomInputImage
Gets or sets the Lit from bottom input image that will be used at run time.

This property sets the value of the second record in the InputVisionData container.

Public propertyLitFromLeftInputImage
Gets or sets the Lit from left input image that will be used at run time.

This property sets the value of the third record in the InputVisionData container.

Public propertyLitFromRightInputImage
Gets or sets the Lit from right input image that will be used at run time.

This property sets the value of the first record in the InputVisionData container.

Public propertyLitFromTopInputImage
Gets or sets the Lit from top input image that will be used at run time.

This property sets the value of the fourth record in the InputVisionData container.

Public propertyName
Gets or sets a user-supplied name for the tool.
(Inherited from CogToolBase.)
Public propertyOutputImage
Gets the OutputImage from the last run of the tool.
Public propertyRegion
Gets or sets the region. The region bounding box specifies the portion of each image to be processed. The output image size is based on the region bounding box size.
Public propertyRunParams
Gets or sets the parameters to be used when this SurfaceFX tool is run.
Public propertyRunStatus
Gets general information about the last call to the tool's Run function. 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.
(Inherited from CogToolBase.)
Public propertySite
Gets or sets the ISite of the Component.
(Inherited from Component.)
Public propertyStateFlags
Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventComponentBase.)
Public propertyUserData
Gets a CogDictionary object that can be used to store application-specific information.
(Inherited from CogToolBase.)
Top
See Also