pspdfkit/com.pspdfkit.annotations.measurements/Scale

Scale

class Scale

A ratio of the size of an object as displayed on a document page to the size of a corresponding real-world object. Scale objects are used for measurement annotations. This class is immutable - you must create a new Scale object if you want to change any of the members.

Constructors

Link copied to clipboard
constructor(@FloatRange(from = MeasurementToolsConstants.minimumScaleValue) valueFrom: Float, @NonNull unitFrom: Scale.UnitFrom, @FloatRange(from = MeasurementToolsConstants.minimumScaleValue) valueTo: Float, @NonNull unitTo: Scale.UnitTo)
Creates an instance of a measurement Scale object.

Types

Link copied to clipboard
enum UnitFrom
Units available for the source scale value.
Link copied to clipboard
enum UnitTo
Units available for the target scale value.

Properties

Link copied to clipboard
@NonNull
val unitFrom: Scale.UnitFrom
Unit for the source scale value.
Link copied to clipboard
@NonNull
val unitTo: Scale.UnitTo
Unit for the target scale value (distance in the real world).
Link copied to clipboard
val valueFrom: Float
Value in specified units for the source scale.
Link copied to clipboard
val valueTo: Float
Value in specified units for the target scale.

Functions

Link copied to clipboard
open fun equals(other: Any): Boolean
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
@NonNull
open fun toString(): String