EffectName (DistortedAndroid Javadoc 2021-03-07)

java.lang.Object
- java.lang.Enum<EffectName>
- - org.distorted.library.effect.EffectName

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EffectName>
```
public enum EffectName
extends java.lang.Enum<EffectName>
```
Names of Effects one can add to the DistortedEffects queues.
Effect's 'Type' is one of the constants defined in EffectType.

Effect's 'Uniforms' are a vector of 7 (matrix effects) 12 (vertex) or 8 (fragment) floats, which together form full information how to compute a given effect. Typically, some of those values will be Interpolated in CPU (by one of the 'EffectQueueX.compute()' methods) and the effect of such Interpolation sent to the Shaders.

Effect's 'Unity' is such a particular vector of its 'interpolated values' which makes the effect NULL. For example, if the effect is 'MOVE' by a 3-dimensional vector, then a 'NULL MOVE' is a MOVE by vector (0,0,0), thus (0,0,0) is the unity of the MOVE effect. This is used by the EffectQueue classes to decide if the final form of the Effect is NULL - and thus if it can safely be removed from Effect Queues without affecting the visual in any way.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALPHA`
`BLUR`
`BRIGHTNESS`
`CHROMA`
`CONTRAST`
`DEFORM`
`DISAPPEAR`
`DISTORT`
`GLOW`
`MOVE`
`PINCH`
`QUATERNION`
`ROTATE`
`SATURATION`
`SCALE`
`SHEAR`
`SINK`
`SMOOTH_ALPHA`
`SMOOTH_BRIGHTNESS`
`SMOOTH_CHROMA`
`SMOOTH_CONTRAST`
`SMOOTH_SATURATION`
`SWIRL`
`VERTEX_MOVE`
`VERTEX_QUATERNION`
`VERTEX_ROTATE`
`VERTEX_SCALE`
`VERTEX_SHEAR`
`WAVE`

Field Summary

Fields
Modifier and Type Field and Description

static int LENGTH

Fields
Modifier and Type	Field and Description
`static int`	`LENGTH`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getCenterDimension()` What is the dimension of the Center supported by this effect?
`java.lang.Class<? extends Effect>`	`getEffectClass()` Returns the Class of an individual Effect.
`int`	`getEffectDimension()` Returns the dimension of an Effect (in other words, the number of interpolated values).
`static EffectName`	`getName(int ordinal)` Returns the i-th EffectName.
`int`	`getRegionDimension()` What is the dimension of the Region supported by this effect?
`EffectType`	`getType()` Returns the Type of an individual Effect.
`static EffectName`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static EffectName[]`	`values()` Returns an array containing the constants of this enum type, in the order they are 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

- Enum Constant Detail
  - ROTATE
```
public static final EffectName ROTATE
```
  - QUATERNION
```
public static final EffectName QUATERNION
```
  - MOVE
```
public static final EffectName MOVE
```
  - SCALE
```
public static final EffectName SCALE
```
  - SHEAR
```
public static final EffectName SHEAR
```
  - DISTORT
```
public static final EffectName DISTORT
```
  - DEFORM
```
public static final EffectName DEFORM
```
  - SINK
```
public static final EffectName SINK
```
  - PINCH
```
public static final EffectName PINCH
```
  - SWIRL
```
public static final EffectName SWIRL
```
  - WAVE
```
public static final EffectName WAVE
```
  - DISAPPEAR
```
public static final EffectName DISAPPEAR
```
  - VERTEX_MOVE
```
public static final EffectName VERTEX_MOVE
```
  - VERTEX_QUATERNION
```
public static final EffectName VERTEX_QUATERNION
```
  - VERTEX_ROTATE
```
public static final EffectName VERTEX_ROTATE
```
  - VERTEX_SCALE
```
public static final EffectName VERTEX_SCALE
```
  - VERTEX_SHEAR
```
public static final EffectName VERTEX_SHEAR
```
  - ALPHA
```
public static final EffectName ALPHA
```
  - SMOOTH_ALPHA
```
public static final EffectName SMOOTH_ALPHA
```
  - CHROMA
```
public static final EffectName CHROMA
```
  - SMOOTH_CHROMA
```
public static final EffectName SMOOTH_CHROMA
```
  - BRIGHTNESS
```
public static final EffectName BRIGHTNESS
```
  - SMOOTH_BRIGHTNESS
```
public static final EffectName SMOOTH_BRIGHTNESS
```
  - SATURATION
```
public static final EffectName SATURATION
```
  - SMOOTH_SATURATION
```
public static final EffectName SMOOTH_SATURATION
```
  - CONTRAST
```
public static final EffectName CONTRAST
```
  - SMOOTH_CONTRAST
```
public static final EffectName SMOOTH_CONTRAST
```
  - BLUR
```
public static final EffectName BLUR
```
  - GLOW
```
public static final EffectName GLOW
```
- Field Detail
  - LENGTH
```
public static final int LENGTH
```
- Method Detail
  - values
```
public static EffectName[] 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 (EffectName c : EffectName.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EffectName 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
  - getType
```
public EffectType getType()
```
    Returns the Type of an individual Effect. For example, EffectName.ROTATE.getType() will return EffectType.MATRIX.
    
    Returns:
    type of the effect.
  - getEffectClass
```
public java.lang.Class<? extends Effect> getEffectClass()
```
    Returns the Class of an individual Effect. For example, EffectName.ROTATE.getEffectClass() returns MatrixEffectRotate.class.
    
    Returns:
    effect class.
  - getName
```
public static EffectName getName(int ordinal)
```
    Returns the i-th EffectName.
    If you want to loop over all possible Effects, you need this.
  - getEffectDimension
```
public int getEffectDimension()
```
    Returns the dimension of an Effect (in other words, the number of interpolated values).
    
    Returns:
    dimension of the Effect.
  - getRegionDimension
```
public int getRegionDimension()
```
    What is the dimension of the Region supported by this effect?
    
    Returns:
    Dimension of the Region supported (0-region not supported at all).
  - getCenterDimension
```
public int getCenterDimension()
```
    What is the dimension of the Center supported by this effect?
    
    Returns:
    Dimension of the Center supported (0-center not supported at all).

Enum EffectName

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ROTATE

QUATERNION

MOVE

SCALE

SHEAR

DISTORT

DEFORM

SINK

PINCH

SWIRL

WAVE

DISAPPEAR

VERTEX_MOVE

VERTEX_QUATERNION

VERTEX_ROTATE

VERTEX_SCALE

VERTEX_SHEAR

ALPHA

SMOOTH_ALPHA

CHROMA

SMOOTH_CHROMA

BRIGHTNESS

SMOOTH_BRIGHTNESS

SATURATION

SMOOTH_SATURATION

CONTRAST

SMOOTH_CONTRAST

BLUR

GLOW

Field Detail

LENGTH

Method Detail

values

valueOf

getType

getEffectClass

getName

getEffectDimension

getRegionDimension

getCenterDimension