Back to FabImage Library website
You are here: Start » Function Reference » Region » Region Basics » CreateRectangleBorderRegion
Header: | FIL.h |
---|---|
Namespace: | fil |
Module: | FoundationLite |
Creates a frame-shaped region with given parameters.
Syntax
C++
C#
void fil::CreateRectangleBorderRegion ( const fil::Rectangle2D& inRectangle, ftl::Optional<const fil::CoordinateSystem2D&> inRectangleAlignment, float inBorderWidth, fil::BorderPosition::Type inBorderPosition, int inFrameWidth, int inFrameHeight, fil::Region& outRegion, ftl::Optional<fil::Rectangle2D&> outAlignedRectangle = ftl::NIL )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
inRectangle | const Rectangle2D& | ||||
inRectangleAlignment | Optional<const CoordinateSystem2D&> | NIL | Adjusts the rectangle to the position of the inspected object | ||
inBorderWidth | float | 0.0 - | 1.0f | ||
inBorderPosition | BorderPosition::Type | Centered | |||
inFrameWidth | int | 0 - 65535 | Width of the created region's frame | ||
inFrameHeight | int | 0 - 65535 | Height of the created region's frame | ||
outRegion | Region& | Output region | |||
outAlignedRectangle | Optional<Rectangle2D&> | NIL | The input rectangle transformed to the absolute coordinate system |
Optional Outputs
The computation of following outputs can be switched off by passing value ftl::NIL
to these parameters: outAlignedRectangle.
Read more about Optional Outputs.
Errors
List of possible exceptions:
Error type | Description |
---|---|
DomainError | Incorrect BorderPosition in CreateRectangleBorderRegion. |