A CogShapeModel is an object that holds the weight and polarity information that should be applied to a shape (and its subfeatures, if any) when it is used as a synthetic model.
Namespace: Cognex.VisionProAssembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 73.0.0.0
Syntax
The ICogShapeModel type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CreateSubFeatureIterator | Returns a newly created iterator for iterating over all subfeatures. The iterator is positioned at the subfeature specified by InitialIndex. A value of -1 creates an iterator that is positioned just after the last valid subfeature. |
| GetEffectivePolarity | If this feature has no ParentFeature, then its effective polarity is the value of the Polarity property. If this feature has a ParentFeature, then the effective polarity is the Polarity times the effective polarity of the ParentFeature. (Inherited from ICogModelFeature.) |
| GetEffectiveWeight | If this feature has no ParentFeature, then its effective weight is the value of the Weight property. If this feature has a ParentFeature, then the effective weight is the Weight times the effective weight of the ParentFeature. (Inherited from ICogModelFeature.) |
Properties
| Name | Description | |
|---|---|---|
 | Color | Color of this graphic. Can be any OLE_COLOR. |
| Interactive | Interactive property allow this graphic object to be selected. See GraphicDOFEnable for information on governing interactive manipulation of an object. |
| LineStyle | Line style of this graphic. |
| LineWidthInScreenPixels | Line width (in screen pixels) of this graphic. |
| ParentFeature | If this feature has a ParentFeature, then Weight and Polarity are defined with respect to the parent. The effective weight (or polarity) of this feature is its Weight (or Polarity) times the parent's effective weight (or polarity). (Inherited from ICogModelFeature.) |
| Polarity | Returns/sets the polarity of this feature. The polarity of a given feature may be -1, 0(undefined), or +1. Polarities of +1 or -1 define where to find brighter pixels relative to the feature geometry, and 0 means undefined. (Inherited from ICogModelFeature.) |
| PolarityAdornment | Returns/sets the polarity adornment of this CogShapeModel. |
| SelectedSpaceName | Coordinate space in which this shape is to be interpreted. |
| Shape | Returns a reference to the shape object associated with this model feature. The Weight and Polarity are applied to this shape when it is used as a synthetic model. |
| SubFeatureCount | Returns the number of subfeatures of this CogShapeModel. The subfeatures can be iterated by calling CreateSubFeatureIterator. |
| TipText | Text to describe this graphic in a tool tip. |
| Visible | Visible property of this graphic. |
| Weight | Returns/sets the weight of this feature. The weight of a feature determines its relative importance compared to other features of the model. The weight defaults to 1.0. (Inherited from ICogModelFeature.) |
Remarks
A shape model is an object that holds the weight and polarity information that should be applied to a shape (and its subfeatures, if any) when it is used as a synthetic model.
See Also