Package com.openinventor.inventor.nodes

Enum Class SoImageBackground.Styles

java.lang.Object
java.lang.Enum<SoImageBackground.Styles>
com.openinventor.inventor.nodes.SoImageBackground.Styles
All Implemented Interfaces:
IntegerValuedEnum, Serializable, Comparable<SoImageBackground.Styles>, Constable
Enclosing class:
SoImageBackground
public static enum SoImageBackground.Styles extends Enum<SoImageBackground.Styles> implements IntegerValuedEnum
Image background style.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CENTER
    Image is rendered actual size, centered in the window
    (image aspect ratio is preserved but image may be cropped and background may be visible).
    CROP
    Image is centered and stretched to exactly fill the longer dimension of the viewport (width or height)
    (image aspect ratio is preserved but portions of image will be cropped if the aspect ratio of the image and viewport are different).
    FIT
    Image is centered and stretched to exactly fill the shorter dimension of the viewport (width or height)
    (image aspect ratio is preserved but background color will be visible on sides or top and bottom of the image if the aspect ratio of the image and viewport are different).
    LOWER_LEFT
    Image is rendered actual size in lower left corner
    (image aspect ratio is preserved but image may be cropped and background may be visible).
    LOWER_RIGHT
    Image is rendered actual size in lower right corner
    (image aspect ratio is preserved but image may be cropped and background may be visible).
    NONE
    No image is rendered.
    STRETCH
    Image is stretched to exactly fill the viewport in both directions
    (image aspect ratio is not preserved).
    TILE
    Image is tiled to fill window starting from lower left corner
    (image aspect ratio is preserved).
    UPPER_LEFT
    Image is rendered actual size in upper left corner
    (image aspect ratio is preserved but image may be cropped and background may be visible).
    UPPER_RIGHT
    Image is rendered actual size in upper right corner
    (image aspect ratio is preserved but image may be cropped and background may be visible).

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getValue()
    Returns the integer value of the enum constant.
    static SoImageBackground.Styles
    valueOf(int val)
    Returns the enum constant of this type with the specified integer value
    static SoImageBackground.Styles
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SoImageBackground.Styles[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final SoImageBackground.Styles NONE
      No image is rendered.

    • CENTER

      public static final SoImageBackground.Styles CENTER
      Image is rendered actual size, centered in the window
      (image aspect ratio is preserved but image may be cropped and background may be visible).

    • LOWER_LEFT

      public static final SoImageBackground.Styles LOWER_LEFT
      Image is rendered actual size in lower left corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).

    • UPPER_LEFT

      public static final SoImageBackground.Styles UPPER_LEFT
      Image is rendered actual size in upper left corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).

    • UPPER_RIGHT

      public static final SoImageBackground.Styles UPPER_RIGHT
      Image is rendered actual size in upper right corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).

    • LOWER_RIGHT

      public static final SoImageBackground.Styles LOWER_RIGHT
      Image is rendered actual size in lower right corner
      (image aspect ratio is preserved but image may be cropped and background may be visible).

    • STRETCH

      public static final SoImageBackground.Styles STRETCH
      Image is stretched to exactly fill the viewport in both directions
      (image aspect ratio is not preserved).

    • TILE

      public static final SoImageBackground.Styles TILE
      Image is tiled to fill window starting from lower left corner
      (image aspect ratio is preserved).

    • CROP

      public static final SoImageBackground.Styles CROP
      Image is centered and stretched to exactly fill the longer dimension of the viewport (width or height)
      (image aspect ratio is preserved but portions of image will be cropped if the aspect ratio of the image and viewport are different).

    • FIT

      public static final SoImageBackground.Styles FIT
      Image is centered and stretched to exactly fill the shorter dimension of the viewport (width or height)
      (image aspect ratio is preserved but background color will be visible on sides or top and bottom of the image if the aspect ratio of the image and viewport are different).

  • Method Details

    • values

      public static SoImageBackground.Styles[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SoImageBackground.Styles valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • valueOf

      public static SoImageBackground.Styles valueOf(int val)
      Returns the enum constant of this type with the specified integer value
      Returns:
      the enum constant of this type with the specified integer value.

    • getValue

      public int getValue()
      Description copied from interface: IntegerValuedEnum
      Returns the integer value of the enum constant.
      Specified by:
      getValue in interface IntegerValuedEnum
      Returns:
      the integer value of the enum constant.