You are here: Start » Function Reference » Image Drawing » DrawDimensionLines_Palette

DrawDimensionLines_Palette

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 dimension lines on an image with multiple colors.

Syntax

void avs::DrawDimensionLines_Palette
(
	const avl::Image& inImage,
	atl::Conditional<const atl::Array<atl::Conditional<avl::Segment2D> > &> inSegments,
	atl::Optional<const avl::CoordinateSystem2D&> inSegmentAlignment,
	const atl::Optional<const atl::Array<avl::Pixel>&>& inColors,
	const avl::DrawingStyle& inDrawingStyle,
	float inHeadSize,
	float inScale,
	avl::MetricUnit::Type inMetricUnit,
	const int inFractionalDigitCount,
	float inTextSize,
	const bool inForceRgb,
	avl::Image& outImage
)

Parameters

Name	Type	Range	Default	Description
inImage	const Image&			Input image
inSegments	Conditional<const Array<Conditional<Segment2D> > &>		{ }
inSegmentAlignment	Optional<const CoordinateSystem2D&>		NIL
inColors	const Optional<const Array<Pixel>&>&		NIL
inDrawingStyle	const DrawingStyle&		DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
inHeadSize	float	0.0 -	5.0f
inScale	float	0.0 -	1.0f	px / mm
inMetricUnit	MetricUnit::Type		Millimetres
inFractionalDigitCount	const int	0 - 100	3	How many characters the fractional part of the number should have
inTextSize	float	10.0 -	12.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 inSegments. This will be the primitives to be drawn.
Leave the inColors input not set to have all the primitives drawn with random colors. Set a custom array of colors here to decide explicitly how each of the primitives should be drawn.
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 DrawDimensionLines_Palette on an empty image.