Base interface for all shapes.
Namespace: Cognex.VisionProAssembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 65.1.0.0
Syntax
The ICogShape type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| DistanceToPoint | Shortest distance from a boundary of this shape to the given point. Points within closed shapes return a distance less than zero. | |
| EnclosingRectangle | Minimum enclosing rectangle of this shape. | |
| FitToBoundingBox | Adjust the shape's geometric properties so that the shape fits inside passed in rectangle. | |
| FitToImage | Adjust the shape's geometric properties such that its default size is based on the image and its SelectedSpaceName. XScale and YScale are multipliers where 1.0 designates 100% scaling. | |
| Map | Maps this shape through the given transform. | |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and raises the Changed event if the
ChangedEventSuspended count is reduced to zero and any changes were
made while events were suspended. Must be called once for each call to
SuspendChangedEvent.
(Inherited from ICogChangedEvent.) | |
| SuspendChangedEvent |
Temporarily suspends the raising of the Changed event. May be called
more than once, and a corresponding call to ResumeAndRaiseChangedEvent
must be made for each call to SuspendChangedEvent.
(Inherited from ICogChangedEvent.) |
Properties
| Name | Description | |
|---|---|---|
| ChangedEventSuspended |
Indicates if the raising of the Changed event has been suspended.
(Inherited from ICogChangedEvent.) | |
| SelectedSpaceName | Coordinate space in which this shape is to be interpreted. | |
| StateFlags |
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 ICogChangedEvent.) |
Events
| Name | Description | |
|---|---|---|
| Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from ICogChangedEvent.) |
Remarks
Base interface for all closed shapes.
See Also