Back to Aurora Vision Studio website

You are here: Start » Filter Reference » Region » Region Spatial Transforms » TranslateRegion

TranslateRegion


Module: FoundationLite

Translates a region by a given number of pixels along each axis.

Name Type Range Description
Input value inRegion Region Input region
Input value inDeltaX Integer Horizontal shift
Input value inDeltaY Integer Vertical shift
Input value inInverse Bool Negates the delta values
Input value inFrameWidth Integer* 0 - 65535 Output region frame width
Input value inFrameHeight Integer* 0 - 65535 Output region frame height
Output value outRegion Region Output region

Examples

Description of usage of this filter can be found in examples and tutorial: Brick destroy (Game).

TranslateRegion performed on the sample region with inDeltaX and inDeltaY both set to 50.

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 Input and output regions are not distinct in TranslateRegion.

Complexity Level

This filter is available on Advanced Complexity Level.

See Also

  • RotateRegion – Rotates a region around a specified point.