com.eteks.sweethome3d.model

Enum AspectRatio

java.lang.Object

java.lang.Enum<AspectRatio>

com.eteks.sweethome3d.model.AspectRatio

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AspectRatio>

public enum AspectRatio
extends java.lang.Enum<AspectRatio>

The aspect ratio of pictures.

Since:

2.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
FREE_RATIO
RATIO_16_9
RATIO_2_1
RATIO_24_10
RATIO_3_2
RATIO_4_3
SQUARE_RATIO
VIEW_3D_RATIO

Method Summary

Modifier and Type	Method and Description
java.lang.Float	getValue() Returns the value of this aspect ratio (width / height) or null if it's not known.
static AspectRatio	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AspectRatio[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FREE_RATIO

public static final AspectRatio FREE_RATIO

VIEW_3D_RATIO

public static final AspectRatio VIEW_3D_RATIO

RATIO_4_3

public static final AspectRatio RATIO_4_3

RATIO_3_2

public static final AspectRatio RATIO_3_2

RATIO_16_9

public static final AspectRatio RATIO_16_9

RATIO_2_1

public static final AspectRatio RATIO_2_1

RATIO_24_10

public static final AspectRatio RATIO_24_10

SQUARE_RATIO

public static final AspectRatio SQUARE_RATIO

Method Detail

values

public static AspectRatio[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AspectRatio c : AspectRatio.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AspectRatio valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.Float getValue()

Returns the value of this aspect ratio (width / height) or null if it's not known.