com.openinventor.fxviz.nodes

Enum SoParticleAnimation.EmitShapeTypes

java.lang.Object

java.lang.Enum<SoParticleAnimation.EmitShapeTypes>

com.openinventor.fxviz.nodes.SoParticleAnimation.EmitShapeTypes

All Implemented Interfaces:

IntegerValuedEnum, java.io.Serializable, java.lang.Comparable<SoParticleAnimation.EmitShapeTypes>

Enclosing class:

SoParticleAnimation

public static enum SoParticleAnimation.EmitShapeTypes
extends java.lang.Enum<SoParticleAnimation.EmitShapeTypes>
implements IntegerValuedEnum

Predefined shapes from which particles are emitted.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CIRCLE Emission from a circle.
CYLINDER Emission from a cylinder.
DISK Emission from a disk.
GEOMETRY Emission from a specified geometric shape.
LINE Emission from a line.
POINT Emission from a point.
SPHERE Emission from a sphere.
SQUARE Emission from a square.

Method Summary

Modifier and Type	Method and Description
static SoParticleAnimation.EmitShapeTypes	fromValue(int val) Deprecated. Use valueOf(int) instead.
int	getValue() Returns the integer value of the enum constant.
static SoParticleAnimation.EmitShapeTypes	valueOf(int val) Returns the enum constant of this type with the specified integer value
static SoParticleAnimation.EmitShapeTypes	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SoParticleAnimation.EmitShapeTypes[]	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

POINT

public static final SoParticleAnimation.EmitShapeTypes POINT

Emission from a point.

CYLINDER

public static final SoParticleAnimation.EmitShapeTypes CYLINDER

Emission from a cylinder.

LINE

public static final SoParticleAnimation.EmitShapeTypes LINE

Emission from a line.

SQUARE

public static final SoParticleAnimation.EmitShapeTypes SQUARE

Emission from a square.

SPHERE

public static final SoParticleAnimation.EmitShapeTypes SPHERE

Emission from a sphere.

CIRCLE

public static final SoParticleAnimation.EmitShapeTypes CIRCLE

Emission from a circle.

DISK

public static final SoParticleAnimation.EmitShapeTypes DISK

Emission from a disk.

GEOMETRY

public static final SoParticleAnimation.EmitShapeTypes GEOMETRY

Emission from a specified geometric shape. Not implemented.

Method Detail

values

public static SoParticleAnimation.EmitShapeTypes[] 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 (SoParticleAnimation.EmitShapeTypes c : SoParticleAnimation.EmitShapeTypes.values())
    System.out.println(c);

Returns:

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

valueOf

public static SoParticleAnimation.EmitShapeTypes 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

fromValue

@Deprecated
public static SoParticleAnimation.EmitShapeTypes fromValue(int val)

Deprecated. Use valueOf(int) instead.

Returns the enum constant of this type with the specified integer value

Returns:

the enum constant of this type with the specified integer value.

valueOf

public static SoParticleAnimation.EmitShapeTypes 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.