Common Data Structures

Geometric Types

Defined in framework ScanditCaptureCore

enum MeasureUnit

Added in version 6.0.0

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

dip

Added in version 6.0.0

Value is measured in device-independent pixels.

pixel

Added in version 6.0.0

Value is measured in pixels.

fraction

Added in version 6.0.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.

enum SizingMode

Added in version 6.0.0

An enumeration of possible ways to define a rectangular size.

widthAndHeight

Added in version 6.0.0

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

widthAndAspectRatio

Added in version 6.0.0

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

heightAndAspectRatio

Added in version 6.0.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 : Equatable

Added in version 6.0.0

init

init()

Added in version 6.0.0

Construct a new point at position x and y.

init

init(x: FloatWithUnit, y: FloatWithUnit)

Added in version 6.0.0

Construct a new point at position x and y.

x

open var x: FloatWithUnit { get, set }

Added in version 6.0.0

X coordinate of the point.

y

open var y: FloatWithUnit { get, set }

Added in version 6.0.0

Y coordinate of the point.

jsonString

open var jsonString: String { get }

Added in version 6.1.0

Returns the string representation of this point with unit.

==

static func ==(lhs: PointWithUnit, rhs: PointWithUnit) -> Bool

Added in version 6.6.0

Checks if two PointWithUnit instances are equal. Two instances are considered equal if their coordinates are also equal (FloatWithUnit.==()).

zero

static let zero: PointWithUnit { get }

Added in version 6.0.0

Returns a PointWithUnit with value set to 0.0f.

null

static let null: PointWithUnit { get }

Added in version 6.2.0

Returns a PointWithUnit representing null.

isNull

open var isNull: Bool { get }

Added in version 6.1.0

Checks is the PointWithUnit is null.

RectWithUnit

struct RectWithUnit { ... };

Added in version 6.0.0

init

init()

Added in version 6.0.0

Construct a new rectangle with unit.

init

init(origin: PointWithUnit, size: SizeWithUnit)

Added in version 6.0.0

Construct a new rectangle with unit.

origin

open var origin: PointWithUnit { get, set }

Added in version 6.0.0

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

size

open var size: SizeWithUnit { get, set }

Added in version 6.0.0

The size of the rectangle.

zero

static let zero: RectWithUnit { get }

Added in version 6.0.0

Returns a RectWithUnit with value set to 0.0f.

SizeWithUnit

struct SizeWithUnit { ... };

Added in version 6.0.0

init

init()

Added in version 6.0.0

Construct a new size with unit.

init

init(width: FloatWithUnit, height: FloatWithUnit)

Added in version 6.0.0

Construct a new size with unit.

width

open var width: FloatWithUnit { get, set }

Added in version 6.0.0

The width.

height

open var height: FloatWithUnit { get, set }

Added in version 6.0.0

The height.

zero

static let zero: SizeWithUnit { get }

Added in version 6.0.0

Returns a SizeWithUnit with value set to 0.0f.

SizeWithAspect

struct SizeWithAspect { ... };

Added in version 6.0.0

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

init

init()

Added in version 6.0.0

Construct a new size with aspect.

init

init(size: FloatWithUnit, aspect: CGFloat)

Added in version 6.0.0

Construct a new size with aspect.

size

open var size: FloatWithUnit { get, set }

Added in version 6.0.0

The size of one dimension.

aspect

open var aspect: CGFloat { get, set }

Added in version 6.0.0

The aspect ratio for the other dimension.

zero

static let zero: SizeWithAspect { get }

Added in version 6.0.0

Returns a SizeWithAspect with value set to 0.0f.

FloatWithUnit

struct FloatWithUnit : Equatable

Added in version 6.0.0

Holds a floating-point value plus a measure unit.

init

init()

Added in version 6.0.0

Construct a new float with unit.

init

init(value: CGFloat, unit: MeasureUnit)

Added in version 6.0.0

Construct a new float with unit.

value

open var value: CGFloat { get, set }

Added in version 6.0.0

unit

open var unit: MeasureUnit { get, set }

Added in version 6.0.0

jsonString

open var jsonString: String { get }

Added in version 6.1.0

Returns the string representation of this float with unit.

==

static func ==(lhs: FloatWithUnit, rhs: FloatWithUnit) -> Bool

Added in version 6.6.0

Checks if two FloatWithUnit instances are equal. Two instances are considered equal if they have the same value and unit.

zero

static let zero: FloatWithUnit { get }

Added in version 6.0.0

Returns a FloatWithUnit with value set to 0.0f.

null

static let null: FloatWithUnit { get }

Added in version 6.2.0

Returns a FloatWithUnit representing null.

isNull

open var isNull: Bool { get }

Added in version 6.1.0

Checks is the FloatWithUnit is null.

MarginsWithUnit

struct MarginsWithUnit { ... };

Added in version 6.0.0

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

init

init()

Added in version 6.0.0

Constructs a new MarginsWithUnit instance.

init

init(left: FloatWithUnit, top: FloatWithUnit, right: FloatWithUnit, bottom: FloatWithUnit)

Added in version 6.0.0

Constructs a new MarginsWithUnit instance.

left

open var left: FloatWithUnit { get, set }

Added in version 6.0.0

Left margin.

right

open var right: FloatWithUnit { get, set }

Added in version 6.0.0

Right margin.

top

open var top: FloatWithUnit { get, set }

Added in version 6.0.0

Top margin.

bottom

open var bottom: FloatWithUnit { get, set }

Added in version 6.0.0

Bottom margin.

jsonString

open var jsonString: String { get }

Added in version 6.1.0

Returns the string representation of these margins with unit.

Quadrilateral

struct Quadrilateral { ... };

Added in version 6.0.0

Polygon represented by 4 corners.

init

init()

Added in version 6.0.0

Constructs a new Quadrilateral instance.

init

init(topLeft: CGPoint, topRight: CGPoint, bottomRight: CGPoint, bottomLeft: CGPoint)

Added in version 6.0.0

Constructs a new Quadrilateral instance.

topLeft

open var topLeft: CGPoint { get, set }

Added in version 6.0.0

topRight

open var topRight: CGPoint { get, set }

Added in version 6.0.0

bottomRight

open var bottomRight: CGPoint { get, set }

Added in version 6.0.0

bottomLeft

open var bottomLeft: CGPoint { get, set }

Added in version 6.0.0

jsonString

open var jsonString: String { get }

Added in version 6.1.0

Returns the string representation of this quadrilateral.

SizeWithUnitAndAspect

open class SizeWithUnitAndAspect : NSObject

Added in version 6.0.0

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

widthAndHeight

open var widthAndHeight: SizeWithUnit { get }

Added in version 6.0.0

The values for width and height.

Note

This value will always be SDCSizeWithUnitZero unless sizingMode is SizingMode.widthAndHeight.

widthAndAspectRatio

open var widthAndAspectRatio: SizeWithAspect { get }

Added in version 6.0.0

The value for width and the aspect ratio for height.

Note

This value will always be SDCSizeWithAspectZero unless sizingMode is SizingMode.widthAndAspectRatio.

heightAndAspectRatio

open var heightAndAspectRatio: SizeWithAspect { get }

Added in version 6.0.0

The value for height and the aspect ratio for width.

Note

This value will always be SDCSizeWithAspectZero unless sizingMode is SizingMode.heightAndAspectRatio.

shorterDimensionAndAspectRatio

open var shorterDimensionAndAspectRatio: SizeWithAspect { 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 SDCSizeWithAspectZero unless sizingMode is SizingMode.shorterDimensionAndAspectRatio.

sizingMode

open var sizingMode: SizingMode { get }

Added in version 6.0.0

The sizing mode.

jsonString

open var jsonString: String { get }

Added in version 6.1.0

SDCPointWithUnitFromJSONString

open func SDCPointWithUnitFromJSONString(_ JSONString: String, _ pointWithUnit: UnsafeMutablePointer<PointWithUnit>) -> Bool

Added in version 6.2.0

SDCQuadrilateralFromJSONString

open func SDCQuadrilateralFromJSONString(_ JSONString: String, _ quadrilateral: UnsafeMutablePointer<Quadrilateral>) -> Bool

Added in version 6.1.0

Misc Types

Defined in framework ScanditCaptureCore

EncodingRange

open class EncodingRange : NSObject

Added in version 6.0.0

Defines the encoding of a range of bytes.

init

init()

Added in version 6.0.0

Construct a new encoding range.

ianaName

open var ianaName: String { get }

Added in version 6.0.0

Charset encoding name as defined by IANA.

startIndex

open var startIndex: UInt { get }

Added in version 6.0.0

Start index of this encoding range.

endIndex

open var endIndex: UInt { get }

Added in version 6.0.0

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

jsonString

open var jsonString: String { get }

Added in version 6.1.0

Defined in framework ScanditCaptureCore