This class encapsulates properties typically used to control rendering, or rendering-based processing of text in a particular font. These are the properties that allow one to fine-tune the correspondence between a CogOCVMaxFont and what is actually observed by a camera.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.OCVMax CogOCVMaxFontRenderParams
Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 69.0.0.0
Syntax
The CogOCVMaxFontRenderParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogOCVMaxFontRenderParams | |
| CogOCVMaxFontRenderParams(CogOCVMaxFontRenderParams) | |
 | CogOCVMaxFontRenderParams(SerializationInfo, StreamingContext) |
Methods
| Name | Description | |
|---|---|---|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData | (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| 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 CogSerializableChangedEventBase.) |
| 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 CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfBackgroundGrey | This bit will be set in the EventArgs of a Changed event every time the value returned by BackgroundGrey may have changed. |
| SfCharacterSpacingAddedX | This bit will be set in the EventArgs of a Changed event every time the value returned by CharacterSpacingAddedX may have changed. |
| SfCharacterSpacingAddedY | This bit will be set in the EventArgs of a Changed event every time the value returned by CharacterSpacingAddedY may have changed. |
| SfForegroundGrey | This bit will be set in the EventArgs of a Changed event every time the value returned by ForegroundGrey may have changed. |
| SfImagePelPadding | This bit will be set in the EventArgs of a Changed event every time the value returned by ImagePelPadding may have changed. |
| SfLineSpacingAddedX | This bit will be set in the EventArgs of a Changed event every time the value returned by LineSpacingAddedX may have changed. |
| SfLineSpacingAddedY | This bit will be set in the EventArgs of a Changed event every time the value returned by LineSpacingAddedY may have changed. |
 | SfNextSf | |
| SfSpotSizeScale | This bit will be set in the EventArgs of a Changed event every time the value returned by SpotSizeScale may have changed. |
| SfSpotSpacingScaleX | This bit will be set in the EventArgs of a Changed event every time the value returned by SpotSpacingScaleX may have changed. |
| SfSpotSpacingScaleY | This bit will be set in the EventArgs of a Changed event every time the value returned by SpotSpacingScaleY may have changed. |
| SfStrokeWidthAdded | This bit will be set in the EventArgs of a Changed event every time the value returned by StrokeWidthAdded may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | BackgroundGrey | The background greyscale value to be used in rendering the space surrounding some text. This property is ignored by those operations that do not actually draw into a pelbuffer. |
| ChangedEventSuspended |
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 CogSerializableChangedEventBase.) |
| CharacterSpacingAddedX | Add to the X-axis distance between one character origin and the origin of the next character on the same line. A positive value increases inter-character spacing, a negative value decreases inter-character spacing, and the default value 0.0 produces no change in rendered text. |
| CharacterSpacingAddedY | Add to the Y-axis distance between one character origin and the origin of the next character on the same line. A non-zero value produces a staircase-like line of text, while the default value 0.0 produces no change in rendered text. This property is rarely used. |
| ForegroundGrey | The foreground greyscale value to be used in rendering text. This property is ignored by those operations that do not actually draw into a pelbuffer. |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| ImagePelPadding | The number of pels of background to add to each side of some rendered text image. A value of zero means do not pad. |
| LineSpacingAddedX | Add to the X-axis distance between one line origin and the origin of the next line in the same paragraph. A non-zero value produces a paragraph with lines staggered like a staircase, while the default value 0.0 produces no change in rendered text. This property is rarely used. |
| LineSpacingAddedY | Add to the Y-Axis distance between one line origin and the origin of the next line in the same paragraph. A positive value increases inter-line spacing, a negative value decreases inter-line spacing, and the default value 0.0 produces no change in rendered text. |
| SpotSizeScale | Scale (multiply) the rendered text spot size by this value. Ignored by fonts for which SpotSizeUsed is false (e.g. outline fonts). The default value of 1.0 produces no change in rendered text. |
| SpotSpacingScaleX | Scale (multiply) the spacing along the X axis of rendered text spots by this value. Ignored by fonts for which SpotSpacingUsed is false (e.g. outline fonts). The default value of 1.0 produces no change in rendered text. |
| SpotSpacingScaleY | Scale (multiply) the spacing along the Y axis of rendered text spots by this value. Ignored by fonts for which SpotSpacingUsed is false (e.g. outline fonts). The default value of 1.0 produces no change in rendered text. |
| 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 CogSerializableChangedEventBase.) |
| StrokeWidthAdded | Add to the nominal stroke width of text for a given font using morphology. A positive value increases stroke width, a negative value decreases it, and the default value 0.0 produces no change in rendered text. This property is typically only useful with fonts for which SpotSizeScale does not apply, such as outline fonts. |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also