CogOCVMaxFont.GetLineSpacingY Method

CogOCVMaxFont GetLineSpacingY Method

Cognex VisionPro 9.7

This is the (vertical) spacing between adjacent line origins in this font, as interpreted using the supplied CogOCVMaxFontRenderParams object. Generally this will be the same as the value returned by the LineSpacingY property getter. If, however, SpotSpacingUsed is true for this font, then the value returned by this method will be the value returned by the LineSpacingY getter multiplied by the supplied render params object's SpotSpacingScaleY property.

Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public double GetLineSpacingY(
	CogOCVMaxFontRenderParams renderParams
)

public double GetLineSpacingY(
	CogOCVMaxFontRenderParams renderParams
)

Public Function GetLineSpacingY ( 
	renderParams As CogOCVMaxFontRenderParams
) As Double

Public Function GetLineSpacingY ( 
	renderParams As CogOCVMaxFontRenderParams
) As Double

public:
double GetLineSpacingY(
	CogOCVMaxFontRenderParams^ renderParams
)

public:
double GetLineSpacingY(
	CogOCVMaxFontRenderParams^ renderParams
)

Parameters

renderParams: Type: Cognex.VisionPro.OCVMax CogOCVMaxFontRenderParams
A CogOCVMaxFontRenderParams object that will be used to interpret the cached LineSpacingY value.

Return Value

Type: Double
A System::Double, this is typically a positive number.

Exceptions

Exception	Condition
ObjectDisposedException	If this CogOCVMaxFont object has already been disposed.
ArgumentNullException	If the renderParams argument is NULL.
InvalidOperationException	If a font has not yet been imported, or if an internal error occurs.