Back to FabImage Library website

You are here: Start » Function Reference » All Functions » Image Drawing » DrawArcs_MultiColor

DrawArcs_MultiColor


This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.

Header: FIL.h
Namespace: fis
Module: FoundationLite

Draws arcs on an image with multiple colors.

Syntax

void fis::DrawArcs_MultiColor
(
	const fil::Image& inImage,
	ftl::Conditional<const ftl::Array<ftl::Conditional<fil::Arc2D>>&> inArcs,
	ftl::Optional<const fil::CoordinateSystem2D&> inArcAlignment,
	ftl::Optional<const ftl::Array<ftl::Conditional<fil::Hash>>&> inColorIds,
	ftl::Optional<const ftl::Array<fil::Pixel>&> inPalette,
	const fil::DrawingStyle& inDrawingStyle,
	const bool inForceRgb,
	fil::Image& outImage
)

Parameters

Name Type Default Description
Input value inImage const Image& Input image
Input value inArcs Conditional<const Array<Conditional<Arc2D>>&> { }
Input value inArcAlignment Optional<const CoordinateSystem2D&> NIL
Input value inColorIds Optional<const Array<Conditional<Hash>>&> NIL
Input value inPalette Optional<const Array<Pixel>&> { Pixel ( X: 200.0f Y: 0.0f Z: 0.0f W: 0.0f ), Pixel ( X: 0.0f Y: 200.0f Z: 0.0f W: 0.0f ) }
Input value inDrawingStyle const DrawingStyle& DrawingStyle ( DrawingMode: HighQuality Opacity: 1.0f Thickness: 1.0f Filled: False PointShape: Nil PointSize: 1.0f )
Input value inForceRgb const bool True Filter will convert monochromatic image to RGB if needed
Output value outImage Image& Output image

In-place Processing

This function supports in-place data processing - you can pass the same reference to inImage and outImage

Read more about In-place Computation.

Hints

  • Define inArcs. 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 DrawArcs_MultiColor on an empty image.

Errors

List of possible exceptions:

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