Common Data Structures

Geometric Types

Defined in namespace Scandit.DataCapture.Core.Geometry

MeasureUnit

Added in version 6.2.0

Specifies in what units the value has been specified (fraction, device-independent pixels, pixels).

Dip

Added in version 6.2.0

Value is measured in device-independent pixels.

Pixel

Added in version 6.2.0

Value is measured in pixels.

Fraction

Added in version 6.2.0

Value is measured as a fraction. Valid values range from 0 to 1. This can be used to specify values in relative coordinates with respect to a reference, e.g. the view width or height.

SizingMode

Added in version 6.2.0

An enumeration of possible ways to define a rectangular size.

WidthAndHeight

Added in version 6.2.0

This value will use a SizeWithUnit to determine width and the height.

WidthAndAspectRatio

Added in version 6.2.0

This value will use a FloatWithUnit to determine the width and a float multiplier to determine the height.

HeightAndAspectRatio

Added in version 6.2.0

This value will use a FloatWithUnit to determine the height and a float multiplier to determine the width.

ShorterDimensionAndAspectRatio

Added in version 6.8.0

This value will use a FloatWithUnit to determine the rectangle length on the short side of the reference and a float multiplier to determine the length on the long side.

PointWithUnit

struct PointWithUnit

Added in version 6.2.0

PointWithUnit()

PointWithUnit(FloatWithUnit x, FloatWithUnit y)

Added in version 6.2.0

Construct a new point at position x and y.

X

FloatWithUnit X

Added in version 6.2.0

X coordinate of the point.

Y

FloatWithUnit Y

Added in version 6.2.0

Y coordinate of the point.

RectWithUnit

struct RectWithUnit

Added in version 6.2.0

Origin

PointWithUnit Origin

Added in version 6.2.0

The origin (top-left corner) of the rectangle.

Size

SizeWithUnit Size

Added in version 6.2.0

The size of the rectangle.

SizeWithUnit

struct SizeWithUnit

Added in version 6.2.0

SizeWithUnit()

SizeWithUnit(FloatWithUnit width, FloatWithUnit height)

Added in version 6.2.0

Construct a new size with unit.

Width

FloatWithUnit Width

Added in version 6.2.0

The width.

Height

FloatWithUnit Height

Added in version 6.2.0

The height.

SizeWithAspect

struct SizeWithAspect

Added in version 6.2.0

Holds values to define a rectangular size using a dimension and an aspect ratio multiplier.

SizeWithAspect()

SizeWithAspect(FloatWithUnit size, nfloat aspect)

Added in version 6.2.0

Construct a new size with aspect.

Size

FloatWithUnit Size

Added in version 6.2.0

The size of one dimension.

Aspect

nfloat Aspect

Added in version 6.2.0

The aspect ratio for the other dimension.

FloatWithUnit

struct FloatWithUnit

Added in version 6.2.0

Holds a floating-point value plus a measure unit.

FloatWithUnit()

FloatWithUnit(nfloat value, MeasureUnit unit)

Added in version 6.2.0

Construct a new float with unit.

Value

nfloat Value

Added in version 6.2.0

Unit

MeasureUnit Unit

Added in version 6.2.0

MarginsWithUnit

struct MarginsWithUnit

Added in version 6.2.0

Holds margin values (left, top, right, bottom) that can each be expressed with a different measure unit.

MarginsWithUnit()

MarginsWithUnit(FloatWithUnit left, FloatWithUnit top, FloatWithUnit right, FloatWithUnit bottom)

Added in version 6.2.0

Constructs a new MarginsWithUnit instance.

Left

FloatWithUnit Left

Added in version 6.2.0

Left margin.

Right

FloatWithUnit Right

Added in version 6.2.0

Right margin.

Top

FloatWithUnit Top

Added in version 6.2.0

Top margin.

Bottom

FloatWithUnit Bottom

Added in version 6.2.0

Bottom margin.

Quadrilateral

struct Quadrilateral

Added in version 6.2.0

Polygon represented by 4 corners.

Quadrilateral()

Quadrilateral(CGPoint topLeft, CGPoint topRight, CGPoint bottomRight, CGPoint bottomLeft)

Added in version 6.2.0

Constructs a new Quadrilateral instance.

TopLeft

CGPoint TopLeft

Added in version 6.2.0

TopRight

CGPoint TopRight

Added in version 6.2.0

BottomRight

CGPoint BottomRight

Added in version 6.2.0

BottomLeft

CGPoint BottomLeft

Added in version 6.2.0

SizeWithUnitAndAspect

class SizeWithUnitAndAspect

Added in version 6.2.0

Holds a SizingMode - and corresponding required values - to define a rectangular size.

WidthAndHeight

SizeWithUnit WidthAndHeight { get; }

Added in version 6.2.0

The values for width and height.

Note

This value will always be null unless SizingMode is SizingMode.WidthAndHeight.

WidthAndAspectRatio

SizeWithAspect WidthAndAspectRatio { get; }

Added in version 6.2.0

The value for width and the aspect ratio for height.

Note

This value will always be null unless SizingMode is SizingMode.WidthAndAspectRatio.

HeightAndAspectRatio

SizeWithAspect HeightAndAspectRatio { get; }

Added in version 6.2.0

The value for height and the aspect ratio for width.

Note

This value will always be null unless SizingMode is SizingMode.HeightAndAspectRatio.

ShorterDimensionAndAspectRatio

SizeWithAspect ShorterDimensionAndAspectRatio { get; }

Added in version 6.8.0

The value for the short dimension of the reference view and the aspect ratio for the long dimension of the reference view.

Note

This value will always be null unless SizingMode is SizingMode.ShorterDimensionAndAspectRatio.

SizingMode

SizingMode SizingMode { get; }

Added in version 6.2.0

The sizing mode.

ToJson()

string ToJson()

Added in version 6.2.0

Misc Types

Defined in namespace Scandit.DataCapture.Core.Common.Async

Defined in namespace Scandit.DataCapture.Core.Common.Buffer

EncodingRange

class EncodingRange

Added in version 6.2.0

Defines the encoding of a range of bytes.

IanaName

string IanaName { get; }

Added in version 6.2.0

Charset encoding name as defined by IANA.

StartIndex

uint StartIndex { get; }

Added in version 6.2.0

Start index of this encoding range.

EndIndex

uint EndIndex { get; }

Added in version 6.2.0

End index (first index after the last) of this encoding range.

ToJson()

string ToJson()

Added in version 6.2.0

Defined in namespace Scandit.DataCapture.Core.UI.Orientation

Defined in namespace Scandit.DataCapture.Core.Time