Media Authoring
with Java API

tv.amwa.maj.enumeration
Enum ScanningDirectionType

java.lang.Object
  extended by java.lang.Enum<ScanningDirectionType>
      extended by tv.amwa.maj.enumeration.ScanningDirectionType
All Implemented Interfaces:
Serializable, Comparable<ScanningDirectionType>, AAFEnumerationValue

public enum ScanningDirectionType
extends Enum<ScanningDirectionType>
implements AAFEnumerationValue

Describes the scanning direction of an image.

Informative note: The values of scanning direction type match the equivalent type in SMPTE 268M.

Original C name: aafScanningDirection_e

Author:
Richard Cartwright
See Also:
TypeDefinitionEnumeration.ScanningDirectionType, RGBADescriptor

Enum Constant Summary
BottomToTopLeftToRight
          Scan from bottom to top, left to right.
BottomToTopRightToLeft
          Scan from bottom to top, right to left.
LeftToRightBottomToTop
          Scan from left to right, bottom to top.
LeftToRightTopToBottom
          Scan from left to right, top to bottom.
RightToLeftBottomToTop
          Scan from right to left, bottom to top.
RightToLeftTopToBottom
          Scan from right to left, top to bottom.
TopToBottomLeftToRight
          Scan from top to bottom, left to right.
TopToBottomRightToLeft
          Scan from top to bottom, right to left.
 
Method Summary
 long value()
          Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.
static ScanningDirectionType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ScanningDirectionType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface tv.amwa.maj.enumeration.AAFEnumerationValue
name
 

Enum Constant Detail

LeftToRightTopToBottom

public static final ScanningDirectionType LeftToRightTopToBottom

Scan from left to right, top to bottom.


RightToLeftTopToBottom

public static final ScanningDirectionType RightToLeftTopToBottom

Scan from right to left, top to bottom.


LeftToRightBottomToTop

public static final ScanningDirectionType LeftToRightBottomToTop

Scan from left to right, bottom to top.


RightToLeftBottomToTop

public static final ScanningDirectionType RightToLeftBottomToTop

Scan from right to left, bottom to top.


TopToBottomLeftToRight

public static final ScanningDirectionType TopToBottomLeftToRight

Scan from top to bottom, left to right.


TopToBottomRightToLeft

public static final ScanningDirectionType TopToBottomRightToLeft

Scan from top to bottom, right to left.


BottomToTopLeftToRight

public static final ScanningDirectionType BottomToTopLeftToRight

Scan from bottom to top, left to right.


BottomToTopRightToLeft

public static final ScanningDirectionType BottomToTopRightToLeft

Scan from bottom to top, right to left.

Method Detail

values

public static final ScanningDirectionType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ScanningDirectionType c : ScanningDirectionType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static ScanningDirectionType 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

value

@Int64
public long value()
Description copied from interface: AAFEnumerationValue

Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.

Specified by:
value in interface AAFEnumerationValue
Returns:
Unique integer value associated with an enumeration constant.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.