You are here: Start » Image Drawing » DrawPaths_TwoColors

DrawPaths_TwoColors

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

Draws paths on an image with two colors, depending on the status of each path (usually: green or red for pass/fail status).

Syntax

void fis::DrawPaths_TwoColors
(
	const fil::Image& inImage,
	const ftl::Conditional<ftl::Array<ftl::Conditional<fil::Path> > >& inPaths,
	ftl::Optional<const fil::CoordinateSystem2D&> inPathAlignment,
	const fil::Pixel& inColorIfTrue,
	const fil::Pixel& inColorIfFalse,
	const ftl::Conditional< ftl::Array<ftl::Conditional<bool> > >& inConditions,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inPaths	const Conditional<Array<Conditional<Path> > >&	{ }
inPathAlignment	Optional<const CoordinateSystem2D&>	NIL
inColorIfTrue	const Pixel&	Pixel ( X: 0.0f Y: 200.0f Z: 0.0f W: 0.0f )
inColorIfFalse	const Pixel&	Pixel ( X: 200.0f Y: 0.0f Z: 0.0f W: 0.0f )
inConditions	const Conditional< Array<Conditional<bool> > >&	{ }
inDrawingStyle	const DrawingStyle&	DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
inForceRgb	const bool	True	Filter will convert monochromatic image to RGB if needed
outImage	Image&		Output image

Description

The operation draws an array of paths on the inImage using common drawing parameters for all of them. Paths may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.

Hints

Define inPaths. This will be the primitives to be drawn.
Define inConditions with the boolean values indicating the class (usually: OK/NOK) for each input primitive.
Set the inColorIfTrue and inColorIfFalse inputs to define the two colors used for drawing.
Set inForceRgb to True, if you want to get a 3-channel output regardless of what is on the input.
Set inDrawingStyle to control quality, opacity, thickness, filling, point shapes and sizes.

Examples

Example usage of the DrawPaths_TwoColors on an empty image.

Errors

Error type	Description
DomainError	Inconsistent input array sizes in DrawPaths_TwoColors.