Sweet Home 3D 4.0

com.eteks.sweethome3d.model
Enum AspectRatio

java.lang.Object
  extended by java.lang.Enum<AspectRatio>
      extended by com.eteks.sweethome3d.model.AspectRatio
All Implemented Interfaces:
Serializable, Comparable<AspectRatio>

public enum AspectRatio
extends Enum<AspectRatio>

The aspect ratio of pictures.

Since:
2.0

Enum Constant Summary
FREE_RATIO
           
RATIO_16_9
           
RATIO_2_1
           
RATIO_3_2
           
RATIO_4_3
           
SQUARE_RATIO
           
VIEW_3D_RATIO
           
 
Method Summary
 Float getValue()
          Returns the value of this aspect ratio (width / height) or null if it's not known.
static AspectRatio valueOf(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

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(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getValue

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


Sweet Home 3D 4.0

© Copyrights 2006-2013 eTeks - All rights reserved
Distributed under GNU General Public License