org.proteinshader.structure.enums
Enum BondEnum

java.lang.Object
  java.lang.Enum<BondEnum>
      org.proteinshader.structure.enums.BondEnum

All Implemented Interfaces:

Serializable, Comparable<BondEnum>

public enum BondEnum
extends Enum<BondEnum>

Provides an enumeration for molecular bonds. Each BondEnum has a CPK color and a radius for use as convenient defaults when representing a Bond as a cyliner.

Enum Constant Summary

DISULFIDE
CPKColorEnum.SULPHUR_YELLOW, alpha = 1.0, and radius = 0.2.

DOUBLE
CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2.

HYDROGEN
CPKColorEnum.RED, alpha = 1.0, and radius = 0.2.

PEPTIDE
CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2.

SINGLE
CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2.

TRIPLE
CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2.

Method Summary

float	getAlpha() Returns the alpha component of the RGBA color on a scale from 0.0 to 1.0, inclusive.
float	getBlue() Returns the blue component of the RGBA color on a scale from 0.0 to 1.0, inclusive.
float	getGreen() Returns the green component of the RGBA color on a scale from 0.0 to 1.0, inclusive.
double	getRadius() Returns a radius that can be used for representing the Bond as a cylinder.
float	getRed() Returns the red component of the RGBA color on a scale from 0.0 to 1.0, inclusive.
static BondEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static BondEnum[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SINGLE

public static final BondEnum SINGLE

CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2. Single covalent bond between two atoms.

DOUBLE

public static final BondEnum DOUBLE

CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2. Double covalent bond between two atoms.

TRIPLE

public static final BondEnum TRIPLE

CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2. Triple covalent bond between two atoms.

PEPTIDE

public static final BondEnum PEPTIDE

CPKColorEnum.LIGHT_GRAY, alpha = 1.0, and radius = 0.2. The bond formed when the carboxyl group of one amino acid reacts with the amino group of another amino acid.

DISULFIDE

public static final BondEnum DISULFIDE

CPKColorEnum.SULPHUR_YELLOW, alpha = 1.0, and radius = 0.2. A strong covalent bond between two sulfhydryl groups (for example, the bond between two cysteine residues in a protein).

HYDROGEN

public static final BondEnum HYDROGEN

CPKColorEnum.RED, alpha = 1.0, and radius = 0.2. A weak bond between two partial electric charges, where the partial positive charge is on a hydrogen atom.

Method Detail

values

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

Returns:

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

valueOf

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

getRed

public float getRed()

Returns the red component of the RGBA color on a scale from 0.0 to 1.0, inclusive.

Returns:

The red value as a float.

getGreen

public float getGreen()

Returns the green component of the RGBA color on a scale from 0.0 to 1.0, inclusive.

Returns:

The green value as a float.

getBlue

public float getBlue()

Returns the blue component of the RGBA color on a scale from 0.0 to 1.0, inclusive.

Returns:

The blue value as a float.

getAlpha

public float getAlpha()

Returns the alpha component of the RGBA color on a scale from 0.0 to 1.0, inclusive.

Returns:

The alpha value as a float.

getRadius

public double getRadius()

Returns a radius that can be used for representing the Bond as a cylinder.

Returns:

The radius value as a double.