Back to Aurora Vision Studio website
You are here: Start » Filter Reference » Image » Image Drawing » DrawPaths_MultiColor
Module: | FoundationLite |
---|
Draws paths on an image with multiple colors.
Name | Type | Description | |
---|---|---|---|
![]() |
inImage | Image | Input image |
![]() |
inPaths | Path?Array? | |
![]() |
inPathAlignment | CoordinateSystem2D* | |
![]() |
inColorIds | Hash?Array* | |
![]() |
inPalette | PixelArray* | |
![]() |
inDrawingStyle | DrawingStyle | |
![]() |
inForceRgb | Bool | 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
- 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 inPaths. 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
![](../../img/filters/DrawPaths_MultiColor.png)
Example usage of the DrawPaths_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 inPaths has objects to draw in DrawPaths_MultiColor. |
DomainError | No palette defined with inPalette for specified inColorIds in DrawPaths_MultiColor. |
DomainError | The sizes inPaths and inColorIds do not match in DrawPaths_MultiColor. |
Complexity Level
This filter is available on Advanced Complexity Level.
Filter Group
This filter is member of DrawPaths filter group.
See Also
- DrawLines – group of filters.
- DrawSegments – group of filters.