DrawVectors_SingleColor

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

Header:	AVL.h
Namespace:	avs

Draws vectors on an image with a single color.

Syntax

void avs::DrawVectors_SingleColor
(
	const avl::Image& inImage,
	atl::Conditional<const atl::Array<atl::Conditional<avl::Vector2D>>&> inVectors,
	atl::Conditional<const atl::Array<atl::Conditional<avl::Point2D>>&> inInitialPoints,
	atl::Optional<const avl::CoordinateSystem2D&> inVectorAlignment,
	const avl::Pixel& inColor,
	const avl::DrawingStyle& inDrawingStyle,
	float inHeadSize,
	const bool inForceRgb,
	avl::Image& outImage
)

Parameters

Name	Type	Default	Description
inImage	const Image&		Input image
inVectors	Conditional<const Array<Conditional<Vector2D>>&>	{ }
inInitialPoints	Conditional<const Array<Conditional<Point2D>>&>	{ }
inVectorAlignment	Optional<const CoordinateSystem2D&>	NIL
inColor	const Pixel&
inDrawingStyle	const DrawingStyle&	DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
inHeadSize	float	5.0f
inForceRgb	const bool	True	Filter will convert monochromatic image to RGB if needed
outImage	Image&		Output image

In-place Processing

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

Hints

Define inVectors. 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 DrawVectors_SingleColor on an empty image.

Errors

List of possible exceptions:

Error type	Description
DomainError	Inconsistent input array sizes in DrawVectors_SingleColor.