Common Data Structures#
Geometric Types#
Defined in package com.scandit.datacapture.core.geometry
-
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.
-
-
SizingMode
# Added in version 6.0.0
An enumeration of possible ways to define a rectangular size.
-
WIDTH_AND_HEIGHT
# Added in version 6.0.0
This value will use a SizeWithUnit to determine width and the height.
-
WIDTH_AND_ASPECT_RATIO
# Added in version 6.0.0
This value will use a FloatWithUnit to determine the width and a float multiplier to determine the height.
-
HEIGHT_AND_ASPECT_RATIO
# Added in version 6.0.0
This value will use a FloatWithUnit to determine the height and a float multiplier to determine the width.
-
SHORTER_DIMENSION_AND_ASPECT_RATIO
# 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.
-
-
Point
# class Point
Added in version 6.0.0
-
Point()
# Point
(float
x,float
y)Added in version 6.0.0
Construct a new point at position x and y.
-
x
# float
getX
()Added in version 6.0.0
X coordinate of the point.
-
y
# float
getY
()Added in version 6.0.0
Y coordinate of the point.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
PointWithUnit
# class PointWithUnit
Added in version 6.0.0
-
PointWithUnit()
# PointWithUnit
(@NonNull FloatWithUnit x, @NonNull FloatWithUnit y)Added in version 6.0.0
Construct a new point at position x and y.
-
x
# @NonNull FloatWithUnit
getX
()Added in version 6.0.0
X coordinate of the point.
-
y
# @NonNull FloatWithUnit
getY
()Added in version 6.0.0
Y coordinate of the point.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
Rect
# class Rect
Added in version 6.0.0
-
Rect()
# Rect
(@NonNull Point origin, @NonNull Size2 size)Added in version 6.0.0
Construct a new rectangle.
-
origin
# @NonNull Point
getOrigin
()Added in version 6.0.0
The origin (top-left corner) of the rectangle.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
RectWithUnit
# class RectWithUnit
Added in version 6.0.0
-
RectWithUnit()
# RectWithUnit
(@NonNull PointWithUnit point, @NonNull SizeWithUnit size)Added in version 6.0.0
Construct a new rectangle with unit.
-
origin
# @NonNull PointWithUnit
getOrigin
()Added in version 6.0.0
The origin (top-left corner) of the rectangle.
-
size
# @NonNull SizeWithUnit
getSize
()Added in version 6.0.0
The size of the rectangle.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
Size2
# class Size2
Added in version 6.0.0
-
Size2()
# Size2
(float
width,float
height)Added in version 6.0.0
Construct a new Size2 instance.
-
width
# float
getWidth
()Added in version 6.0.0
The width.
-
height
# float
getHeight
()Added in version 6.0.0
The height.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
SizeWithUnit
# class SizeWithUnit
Added in version 6.0.0
-
SizeWithUnit()
# SizeWithUnit
(@NonNull FloatWithUnit width, @NonNull FloatWithUnit height)Added in version 6.0.0
Construct a new size with unit.
-
width
# @NonNull FloatWithUnit
getWidth
()Added in version 6.0.0
The width.
-
height
# @NonNull FloatWithUnit
getHeight
()Added in version 6.0.0
The height.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
SizeWithAspect
# class SizeWithAspect
Added in version 6.0.0
Holds values to define a rectangular size using a dimension and an aspect ratio multiplier.
-
SizeWithAspect()
# SizeWithAspect
(@NonNull FloatWithUnit size,float
aspect)Added in version 6.0.0
Construct a new size with aspect.
-
size
# @NonNull FloatWithUnit
getSize
()Added in version 6.0.0
The size of one dimension.
-
aspect
# float
getAspect
()Added in version 6.0.0
The aspect ratio for the other dimension.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
FloatWithUnit
# class FloatWithUnit
Added in version 6.0.0
Holds a floating-point value plus a measure unit.
-
FloatWithUnit()
# FloatWithUnit
(float
value, MeasureUnit unit)Added in version 6.0.0
Construct a new float with unit.
-
value
# float
getValue
()Added in version 6.0.0
-
unit
# MeasureUnit
getUnit
()Added in version 6.0.0
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
MarginsWithUnit
# class MarginsWithUnit
Added in version 6.0.0
Holds margin values (left, top, right, bottom) that can each be expressed with a different measure unit.
-
MarginsWithUnit()
# MarginsWithUnit
(@NonNull FloatWithUnit left, @NonNull FloatWithUnit top, @NonNull FloatWithUnit right, @NonNull FloatWithUnit bottom)Added in version 6.0.0
Constructs a new MarginsWithUnit instance.
-
left
# @NonNull FloatWithUnit
getLeft
()Added in version 6.0.0
Left margin.
-
right
# @NonNull FloatWithUnit
getRight
()Added in version 6.0.0
Right margin.
-
top
# @NonNull FloatWithUnit
getTop
()Added in version 6.0.0
Top margin.
-
bottom
# @NonNull FloatWithUnit
getBottom
()Added in version 6.0.0
Bottom margin.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
Quadrilateral
# class Quadrilateral
Added in version 6.0.0
Polygon represented by 4 corners.
-
Quadrilateral()
# Quadrilateral
(@NonNull Point topLeft, @NonNull Point topRight, @NonNull Point bottomRight, @NonNull Point bottomLeft)Added in version 6.0.0
Constructs a new Quadrilateral instance.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
-
SizeWithUnitAndAspect
# class SizeWithUnitAndAspect
Added in version 6.0.0
Holds a SizingMode - and corresponding required values - to define a rectangular size.
-
widthAndHeight
# @Nullable SizeWithUnit
getWidthAndHeight
()Added in version 6.0.0
The values for width and height.
Note
This value will always be null unless sizingMode is SizingMode.WIDTH_AND_HEIGHT.
-
widthAndAspectRatio
# @Nullable SizeWithAspect
getWidthAndAspectRatio
()Added in version 6.0.0
The value for width and the aspect ratio for height.
Note
This value will always be null unless sizingMode is SizingMode.WIDTH_AND_ASPECT_RATIO.
-
heightAndAspectRatio
# @Nullable SizeWithAspect
getHeightAndAspectRatio
()Added in version 6.0.0
The value for height and the aspect ratio for width.
Note
This value will always be null unless sizingMode is SizingMode.HEIGHT_AND_ASPECT_RATIO.
-
shorterDimensionAndAspectRatio
# @Nullable SizeWithAspect
getShorterDimensionAndAspectRatio
()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.SHORTER_DIMENSION_AND_ASPECT_RATIO.
-
sizingMode
# SizingMode
getSizingMode
()Added in version 6.0.0
The sizing mode.
-
Misc Types#
Defined in package com.scandit.datacapture.core.common.async
-
Callback
# interface Callback
<T
>Added in version 6.0.0
Interface for a callback/callable accepting a generic parameter of type T.
-
run(value)
# void
run
(@NonNullT
value)Added in version 6.0.0
Called when the callback is invoked.
-
Defined in package com.scandit.datacapture.core.common.buffer
-
EncodingRange
# class EncodingRange
Added in version 6.0.0
Defines the encoding of a range of bytes.
-
EncodingRange()
# EncodingRange
(@NonNull String ianaName,int
startIndex,int
endIndex)Added in version 6.0.0
Construct a new encoding range.
-
ianaName
# @NonNull String
getIanaName
()Added in version 6.0.0
Charset encoding name as defined by IANA.
-
startIndex
# int
getStartIndex
()Added in version 6.0.0
Start index of this encoding range.
-
endIndex
# int
getEndIndex
()Added in version 6.0.0
End index (first index after the last) of this encoding range.
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-
Defined in package com.scandit.datacapture.core
Defined in package com.scandit.datacapture.core.time
-
TimeInterval
# class TimeInterval
Added in version 6.0.0
Represents a duration/time interval.
-
millis(duration)
# static @NonNull TimeInterval
millis
(long
duration)Added in version 6.0.0
Returns a new time interval from the provided duration in milliseconds.
-
seconds(duration)
# static @NonNull TimeInterval
seconds
(float
duration)Added in version 6.0.0
Returns a new time interval from the provided duration in seconds.
-
asSeconds()
# float
asSeconds
()Added in version 6.0.0
Returns the duration in seconds.
-
asMillis()
# long
asMillis
()Added in version 6.0.0
Returns the duration in milliseconds
-
equals(obj)
# boolean
equals
(@Nullable Object obj)Added in version 6.1.0
Indicates whether some other object is equal to this one.
-
hashCode()
# int
hashCode
()Added in version 6.1.0
Returns a hash code value for the object.
-