Back to Aurora Vision Studio website
You are here: Start » Filter Reference » Image » Image Drawing » DrawDimensionLines_MultiColor
Module: | FoundationLite |
---|
Draws dimension lines on an image with multiple colors.
Name | Type | Range | Description | |
---|---|---|---|---|
inImage | Image | Input image | ||
inSegments | Segment2D?Array? | |||
inSegmentAlignment | CoordinateSystem2D* | |||
inColorIds | Hash?Array* | |||
inPalette | PixelArray* | |||
inDrawingStyle | DrawingStyle | |||
inHeadSize | Real | 0.0 - | ||
inScale | Real | 0.0 - | px / mm | |
inMetricUnit | MetricUnit | |||
inFractionalDigitCount | Integer | 0 - 100 | How many characters the fractional part of the number should have | |
inTextSize | Real | 10.0 - | ||
inForceRgb | Bool | Filter will convert monochromatic image to RGB if needed | ||
outImage | Image | Output image |
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 inSegments. 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
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 inSegments has objects to draw in DrawDimensionLines_MultiColor. |
DomainError | No palette defined with inPalette for specified inColorIds in DrawDimensionLines_MultiColor. |
DomainError | The sizes inSegments and inColorIds do not match in DrawDimensionLines_MultiColor. |
Complexity Level
This filter is available on Advanced Complexity Level.
Filter Group
This filter is member of DrawDimensionLines filter group.