Package boofcv.generate

Class PaperSize

java.lang.Object

boofcv.generate.PaperSize

public class PaperSize
extends Object

Used to specify the size of different standard pieces of paper

Field Summary

Fields

Modifier and Type	Field	Description
static PaperSize	A0
static PaperSize	A1
static PaperSize	A2
static PaperSize	A3
static PaperSize	A4
static PaperSize	FIT_CONTENT
double	height	Length of the document along y-axis
static PaperSize	LEGAL
static PaperSize	LETTER
String	name	What the name of this document is
Unit	unit	Units the size is specified in
double	width	Length of the document along x-axis

Constructor Summary

Constructors

Constructor	Description
PaperSize(double width, double height, Unit unit)
PaperSize(String name, double width, double height, Unit unit)

Method Summary

Modifier and Type	Method	Description
double	convertHeight(Unit outputUnit)	Returns the document's height in the specified units
double	convertWidth(Unit outputUnit)	Returns the document's width in the specified units
static @Nullable PaperSize	lookup(String word)	Sees if the specified string matches any of the document's name.
String	toString()
static List<PaperSize>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

FIT_CONTENT

public static PaperSize FIT_CONTENT

A0

public static PaperSize A0

A1

public static PaperSize A1

A2

public static PaperSize A2

A3

public static PaperSize A3

A4

public static PaperSize A4

LEGAL

public static PaperSize LEGAL

LETTER

public static PaperSize LETTER

name

public String name

What the name of this document is

unit

public Unit unit

Units the size is specified in

width

public double width

Length of the document along x-axis

height

public double height

Length of the document along y-axis

Constructor Details

PaperSize

public PaperSize(String name,
 double width,
 double height,
 Unit unit)

PaperSize

public PaperSize(double width,
 double height,
 Unit unit)

Method Details

values

public static List<PaperSize> values()

lookup

@Nullable
public static @Nullable PaperSize lookup(String word)

Sees if the specified string matches any of the document's name.

convertWidth

public double convertWidth(Unit outputUnit)

Returns the document's width in the specified units

convertHeight

public double convertHeight(Unit outputUnit)

Returns the document's height in the specified units

toString

public String toString()

Overrides:

toString in class Object