Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Image Drawing » DrawDimensionLines_SingleColor

DrawDimensionLines_SingleColor


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: FIL.h
Namespace: fis
Module: FoundationLite

Draws dimension lines on an image with a single color.

Syntax

void fis::DrawDimensionLines_SingleColor
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Segment2D>>&> inSegments,
	ftl::Optional<const fil::CoordinateSystem2D&> inSegmentAlignment,
	const fil::Pixel& inColor,
	const fil::DrawingStyle& inDrawingStyle,
	float inHeadSize,
	float inScale,
	fil::MetricUnit::Type inMetricUnit,
	const int inFractionalDigitCount,
	float inTextSize,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name Type Range Default Description
Input value inImage const Image& Input image
Input value inSegments Conditional<const Array<Conditional<Segment2D>>&> { }
Input value inSegmentAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColor const Pixel&
Input value inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
Input value inHeadSize float 0.0 - 5.0f
Input value inScale float 0.0 - 1.0f px / mm
Input value inMetricUnit MetricUnit::Type Millimetres
Input value inFractionalDigitCount const int 0 - 100 3 How many characters the fractional part of the number should have
Input value inTextSize float 10.0 - 12.0f
Input value inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
Output value outImage Image& Output image

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

Read more about In-place Computation.

Hints

  • Define inSegments. This will be the primitives to be drawn.
  • Define inColor. Please note, that on an N-channel image only first N components of the color will be used.
  • Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.

Examples

Example usage of the DrawDimensionLines_SingleColor on an empty image.