Common Data Structures#
Geometric Types#
Defined in framework ScanditCaptureCore
-
SDCMeasureUnit
# Added in version 6.0.0
Specifies in what units the value has been specified (fraction, device-independent pixels, pixels).
-
SDCMeasureUnitDIP
# Added in version 6.0.0
Value is measured in device-independent pixels.
-
SDCMeasureUnitPixel
# Added in version 6.0.0
Value is measured in pixels.
-
SDCMeasureUnitFraction
# 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.
-
-
SDCSizingMode
# Added in version 6.0.0
An enumeration of possible ways to define a rectangular size.
-
SDCSizingModeWidthAndHeight
# Added in version 6.0.0
This value will use a SDCSizeWithUnit to determine width and the height.
-
SDCSizingModeWidthAndAspectRatio
# Added in version 6.0.0
This value will use a SDCFloatWithUnit to determine the width and a float multiplier to determine the height.
-
SDCSizingModeHeightAndAspectRatio
# Added in version 6.0.0
This value will use a SDCFloatWithUnit to determine the height and a float multiplier to determine the width.
-
-
SDCPointWithUnit
# struct SDCPointWithUnit { ... };
Added in version 6.0.0
-
x
# SDCFloatWithUnit x
Added in version 6.0.0
X coordinate of the point.
-
y
# SDCFloatWithUnit y
Added in version 6.0.0
Y coordinate of the point.
-
-
SDCRectWithUnit
# struct SDCRectWithUnit { ... };
Added in version 6.0.0
-
origin
# SDCPointWithUnit origin
Added in version 6.0.0
The origin (top-left corner) of the rectangle.
-
size
# SDCSizeWithUnit size
Added in version 6.0.0
The size of the rectangle.
-
-
SDCSizeWithUnit
# struct SDCSizeWithUnit { ... };
Added in version 6.0.0
-
width
# SDCFloatWithUnit width
Added in version 6.0.0
The width.
-
height
# SDCFloatWithUnit height
Added in version 6.0.0
The height.
-
-
SDCSizeWithAspect
# struct SDCSizeWithAspect { ... };
Added in version 6.0.0
Holds values to define a rectangular size using a dimension and an aspect ratio multiplier.
-
size
# SDCFloatWithUnit size
Added in version 6.0.0
The size of one dimension.
-
-
SDCFloatWithUnit
# struct SDCFloatWithUnit { ... };
Added in version 6.0.0
Holds a floating-point value plus a measure unit.
-
unit
# SDCMeasureUnit unit
Added in version 6.0.0
-
-
SDCMarginsWithUnit
# struct SDCMarginsWithUnit { ... };
Added in version 6.0.0
Holds margin values (left, top, right, bottom) that can each be expressed with a different measure unit.
-
left
# SDCFloatWithUnit left
Added in version 6.0.0
Left margin.
-
right
# SDCFloatWithUnit right
Added in version 6.0.0
Right margin.
-
top
# SDCFloatWithUnit top
Added in version 6.0.0
Top margin.
-
bottom
# SDCFloatWithUnit bottom
Added in version 6.0.0
Bottom margin.
-
-
SDCQuadrilateral
# struct SDCQuadrilateral { ... };
Added in version 6.0.0
Polygon represented by 4 corners.
-
SDCSizeWithUnitAndAspect
# @interface SDCSizeWithUnitAndAspect
: NSObjectAdded in version 6.0.0
Holds a SDCSizingMode - and corresponding required values - to define a rectangular size.
-
widthAndHeight
# @property (nonatomic, readonly) SDCSizeWithUnit widthAndHeight
Added in version 6.0.0
The values for width and height.
Note
This value will always be SDCSizeWithUnitZero unless sizingMode is SDCSizingModeWidthAndHeight.
-
widthAndAspectRatio
# @property (nonatomic, readonly) SDCSizeWithAspect widthAndAspectRatio
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 SDCSizingModeWidthAndAspectRatio.
-
heightAndAspectRatio
# @property (nonatomic, readonly) SDCSizeWithAspect heightAndAspectRatio
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 SDCSizingModeHeightAndAspectRatio.
-
sizingMode
# @property (nonatomic, readonly) SDCSizingMode sizingMode
Added in version 6.0.0
The sizing mode.
-
-
SDCPointWithUnitIsNull(pointWithUnit)
# BOOL
SDCPointWithUnitIsNull(SDCPointWithUnit pointWithUnit)Added in version 6.1.0
-
NSStringFromPointWithUnit(pointWithUnit)
# NSString *_Nonnull NSStringFromPointWithUnit(SDCPointWithUnit pointWithUnit)
Added in version 6.1.0
-
SDCPointWithUnitFromJSONString(JSONString, pointWithUnit)
# BOOL
SDCPointWithUnitFromJSONString(NSString *_Nonnull JSONString, SDCPointWithUnit *_Nonnull pointWithUnit)Added in version 6.2.0
-
NSStringFromRectWithUnit(rectWithUnit)
# NSString *_Nonnull NSStringFromRectWithUnit(SDCRectWithUnit rectWithUnit)
Added in version 6.1.0
-
NSStringFromSizeWithUnit(sizeWithUnit)
# NSString *_Nonnull NSStringFromSizeWithUnit(SDCSizeWithUnit sizeWithUnit)
Added in version 6.1.0
-
NSStringFromSizeWithAspect(sizeWithAspect)
# NSString *_Nonnull NSStringFromSizeWithAspect(SDCSizeWithAspect sizeWithAspect)
Added in version 6.1.0
-
SDCFloatWithUnitIsNull(floatWithUnit)
# BOOL
SDCFloatWithUnitIsNull(SDCFloatWithUnit floatWithUnit)Added in version 6.1.0
-
NSStringFromFloatWithUnit(floatWithUnit)
# NSString *_Nonnull NSStringFromFloatWithUnit(SDCFloatWithUnit floatWithUnit)
Added in version 6.1.0
-
NSStringFromMarginsWithUnit(marginsWithUnit)
# NSString *_Nonnull NSStringFromMarginsWithUnit(SDCMarginsWithUnit marginsWithUnit)
Added in version 6.1.0
-
NSStringFromQuadrilateral(quadrilateral)
# NSString *_Nonnull NSStringFromQuadrilateral(SDCQuadrilateral quadrilateral)
Added in version 6.1.0
-
SDCQuadrilateralFromJSONString(JSONString, quadrilateral)
# BOOL
SDCQuadrilateralFromJSONString(NSString *_Nonnull JSONString, SDCQuadrilateral *_Nonnull quadrilateral)Added in version 6.1.0
Misc Types#
Defined in framework ScanditCaptureCore
Defined in framework ScanditCaptureCore
-
SDCEncodingRange
# @interface SDCEncodingRange
: NSObjectAdded in version 6.0.0
Defines the encoding of a range of bytes.
-
ianaName
# @property (nonatomic, nonnull, readonly) NSString *ianaName
Added in version 6.0.0
Charset encoding name as defined by IANA.
-
startIndex
# @property (nonatomic, readonly) NSUInteger startIndex
Added in version 6.0.0
Start index of this encoding range.
-
endIndex
# @property (nonatomic, readonly) NSUInteger endIndex
Added in version 6.0.0
End index (first index after the last) of this encoding range.
-
Defined in framework ScanditCaptureCore