Back to Adaptive Vision Library Lite website
You are here: Start » Image Drawing » DrawSegments_SingleColor
DrawSegments_SingleColor
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Draws segments on an image with a single color.
Syntax
void avs::DrawSegments_SingleColor ( const avl::Image& inImage, const atl::Conditional<atl::Array<atl::Conditional<avl::Segment2D> > >& inSegments, atl::Optional<const avl::CoordinateSystem2D&> inSegmentAlignment, const avl::Pixel& inColor, const avl::DrawingStyle& inDrawingStyle, const avl::MarkerType::Type& inMarkerType, const float inMarkerSize, const bool inForceRgb, avl::Image& outImage )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inImage | const Image& | Input image | |||
inSegments | const Conditional<Array<Conditional<Segment2D> > >& | { } | |||
inSegmentAlignment | 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 ) | |||
inMarkerType | const MarkerType::Type& | Arrow | |||
inMarkerSize | const float | 0.0 - | 5.0f | ||
inForceRgb | const bool | True | Filter will convert monochromatic image to RGB if needed | ||
outImage | Image& | Output image |
Description
The operation draws an array of segments on the inImage using common drawing parameters for all of them. Segments may exceed the image dimensions - those will be drawn partially or not at all, but the filter execution will succeed.
Hints
- Define inSegments. 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 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
See Also
- DrawCircle – Draws a circle on an image.
- DrawLine – Draws a line on an image.
- DrawPath – Draws a path on an image.
- DrawRectangle – Draws a rectangle on an image.