You are here: Start » Filter Reference » Image » Image Drawing » DrawLines_MultiColor

DrawLines_MultiColor

Module:	FoundationLite

Draws lines on an image with multiple colors.

Name	Type	Description
inImage	Image	Input image
inLines	Line2D ?Array ?
inLineAlignment	CoordinateSystem2D *
inColorIds	Hash ?Array *
inPalette	Pixel Array *
inDrawingStyle	DrawingStyle
inForceRgb	Bool	Filter will convert monochromatic image to RGB if needed
outImage	Image	Output image

Description

The operation draws an array of lines on the inImage using common drawing parameters for all of them. As the length of every line is infinite, they are drawn partially.

Hints

Connect an image source to the inImage input. Drawing will be done on this image.
- If you want to draw on an empty background, use EmptyImage filter before.
Define inLines. This will be the primitives to be drawn.
Leave inPalette and inColorIds not set to have all the primitives drawn with random colors. Set a custom palette of colors here to decide explicitly how each of the primitives should be drawn using inColorIds.
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 DrawLines_MultiColor on an empty image.

Errors

This filter can throw an exception to report error. Read how to deal with errors in Error Handling.

List of possible exceptions:

Error type	Description
DomainError	Empty inPalette while inLines has objects to draw in DrawLines_MultiColor.
DomainError	No palette defined with inPalette for specified inColorIds in DrawLines_MultiColor.
DomainError	The sizes inLines and inColorIds do not match in DrawLines_MultiColor.

Complexity Level

This filter is available on Advanced Complexity Level.

Filter Group

This filter is member of DrawLines filter group.