ColorData

java.lang.Object
- org.povclipse2.code.data.ColorData

public class ColorData
extends java.lang.Object

Field Summary

Fields
Modifier and Type Field and Description

static int TYPE_RGB

static int TYPE_RGBF

static int TYPE_RGBFT

static int TYPE_RGBT

Fields
Modifier and Type	Field and Description
`static int`	`TYPE_RGB`
`static int`	`TYPE_RGBF`
`static int`	`TYPE_RGBFT`
`static int`	`TYPE_RGBT`

Constructor Summary

Constructors
Constructor and Description

ColorData()
Constructor

Constructors
Constructor and Description
`ColorData()` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`static ColorData`	`fromSerializedString(java.lang.String str)` Creates a new `ColorData` from the spezified serialized String.
`double`	`getFilter()`
`double`	`getFloatBlue()`
`double`	`getFloatGreen()`
`double`	`getFloatRed()`
`int`	`getIntBlue()`
`int`	`getIntGreen()`
`int`	`getIntRed()`
`double`	`getPosition()`
`PovClipseToken`	`getPovClipseToken()`
`java.lang.String`	`getStringType()`
`double`	`getTransmit()`
`int`	`getType()`
`boolean`	`hasFilter()`
`boolean`	`hasTransmit()`
`boolean`	`isSameValue()`
`void`	`setBlue(double blue)` Sets the initial blue color component.
`void`	`setBlue(int blue)` Sets the initial blue color component.
`void`	`setFilter(double filter)`
`void`	`setGreen(double green)`
`void`	`setGreen(int green)` Sets the initial green color component.
`void`	`setPosition(double d)`
`void`	`setPovClipseToken(PovClipseToken povToken)` If this ColorData was created from a token, this was it.
`void`	`setRed(double red)`
`void`	`setRed(int red)` Sets the initial red color component.
`void`	`setSameValue(double value)` Sets all parts to the given value: `red` `green` `blue` `filter` if the `type` indicates a `filter` value `transmit` if the `type` indicates a `transmit` value
`void`	`setTransmit(double trans)`
`void`	`setType(int type)` Sets the color type to `TYPE_RGBFT`
`void`	`setTypeRgb()` Sets the color type to `TYPE_RGB`
`void`	`setTypeRgbf()` Sets the color type to `TYPE_RGBF`
`void`	`setTypeRgbft()` Sets the color type to `TYPE_RGBFT`
`void`	`setTypeRgbt()` Sets the color type to `TYPE_RGBT`
`void`	`setVector(RValue rvalue)`
`Color`	`toColor(Device device)` Gets a `Color` object representing the red, green and blue values but ignoring the filter and transmit values.
`java.lang.String`	`toSerializationString()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_RGB
```
public static final int TYPE_RGB
```
    See Also:
    
    Constant Field Values
  - TYPE_RGBF
```
public static final int TYPE_RGBF
```
    See Also:
    
    Constant Field Values
  - TYPE_RGBT
```
public static final int TYPE_RGBT
```
    See Also:
    
    Constant Field Values
  - TYPE_RGBFT
```
public static final int TYPE_RGBFT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ColorData
```
public ColorData()
```
    Constructor
- Method Detail
  - toColor
```
public Color toColor(Device device)
```
    Gets a Color object representing the red, green and blue values but ignoring the filter and transmit values.
    
    Parameters:
    
    device - The Device to be used.
    
    Returns:
    
    A new Color object.
  - getFloatBlue
```
public double getFloatBlue()
```
    Returns:
    
    The blue color component in the range of 0.0 to 1.0
  - getIntBlue
```
public int getIntBlue()
```
    Returns:
    
    The blue color component in the range of 0 to 255
  - setBlue
```
public void setBlue(double blue)
```
    Sets the initial blue color component.
    
    Parameters:
    
    blue - The blue color component in the range of 0.0 to 1.0
  - setBlue
```
public void setBlue(int blue)
```
    Sets the initial blue color component.
    
    Parameters:
    
    blue - The blue color component in the range of 0 to 255
  - getFilter
```
public double getFilter()
```
    Returns:
    
    The filter value
  - setFilter
```
public void setFilter(double filter)
```
    Parameters:
    
    filter - The filter value
  - getFloatGreen
```
public double getFloatGreen()
```
    Returns:
    
    The blue color component in the range of 0.0 to 1.0
  - getIntGreen
```
public int getIntGreen()
```
    Returns:
    
    The green color component in the range of 0 to 255
  - setGreen
```
public void setGreen(double green)
```
    Parameters:
    
    green - The green component in the range from 0.0 to 1.0
  - setGreen
```
public void setGreen(int green)
```
    Sets the initial green color component.
    
    Parameters:
    
    blue - The green color component in the range of 0 to 255
  - getFloatRed
```
public double getFloatRed()
```
    Returns:
    
    The red color component in the range of 0.0 to 1.0
  - getIntRed
```
public int getIntRed()
```
    Returns:
    
    The red color component in the range of 0 to 255
  - setRed
```
public void setRed(double red)
```
    Parameters:
    
    red - The red component in the range from 0.0 to 1.0
  - setRed
```
public void setRed(int red)
```
    Sets the initial red color component.
    
    Parameters:
    
    blue - The red color component in the range of 0 to 255
  - getTransmit
```
public double getTransmit()
```
    Returns:
    
    The transmit value
  - setTransmit
```
public void setTransmit(double trans)
```
    Parameters:
    
    transmit - The tranmit value without having a specific range. All values are possible.
  - getStringType
```
public java.lang.String getStringType()
```
    Returns:
    The String representation of the color type. One of:
    
    rgb
    
    rgbf
    
    rgbt
    
    rgbft
  - getType
```
public int getType()
```
    Returns:
    
    One of the TYPE_ constants representing the color type.
  - setTypeRgb
```
public void setTypeRgb()
```
    Sets the color type to TYPE_RGB
  - setTypeRgbt
```
public void setTypeRgbt()
```
    Sets the color type to TYPE_RGBT
  - setTypeRgbf
```
public void setTypeRgbf()
```
    Sets the color type to TYPE_RGBF
  - setTypeRgbft
```
public void setTypeRgbft()
```
    Sets the color type to TYPE_RGBFT
  - setType
```
public void setType(int type)
```
    Sets the color type to TYPE_RGBFT
  - getPovClipseToken
```
public PovClipseToken getPovClipseToken()
```
    Returns:
    
    the povToken
  - setPovClipseToken
```
public void setPovClipseToken(PovClipseToken povToken)
```
    If this ColorData was created from a token, this was it.
    
    Parameters:
    
    povToken - the povToken to set
  - setVector
```
public void setVector(RValue rvalue)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - getPosition
```
public double getPosition()
```
    Returns:
    
    If used within a color_map this is the map position between 0.0 and 1.0
  - setPosition
```
public void setPosition(double d)
```
    Parameters:
    
    d - The position within a color_map.
  - hasFilter
```
public boolean hasFilter()
```
    Returns:
    
    true if the color contains a filter value, false otherwise.
  - hasTransmit
```
public boolean hasTransmit()
```
    Returns:
    
    true if the color contains a transmit value, false otherwise.
  - setSameValue
```
public void setSameValue(double value)
```
    Sets all parts to the given value:
    - red
    - green
    - blue
    - filter if the type indicates a filter value
    - transmit if the type indicates a transmit value
    Parameters:
    
    value - The value to be set.
  - isSameValue
```
public boolean isSameValue()
```
    Returns:
    
    true if all color parts have the very same value, taking the filter and transmit values into account if indicated by the color type.
  - toSerializationString
```
public java.lang.String toSerializationString()
```
    Returns:
    
    The serialized data for this color.
  - fromSerializedString
```
public static ColorData fromSerializedString(java.lang.String str)
```
    Creates a new ColorData from the spezified serialized String.
    
    Parameters:
    
    str - The serializuation String to be processed.
    
    Returns:
    
    The ColorData represented by the given String.
    
    Throws:
    
    java.lang.IllegalArgumentException - If the String can not be parsed.

Class ColorData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_RGB

TYPE_RGBF

TYPE_RGBT

TYPE_RGBFT

Constructor Detail

ColorData

Method Detail

toColor

getFloatBlue

getIntBlue

setBlue

setBlue

getFilter

setFilter

getFloatGreen

getIntGreen

setGreen

setGreen

getFloatRed

getIntRed

setRed

setRed

getTransmit

setTransmit

getStringType

getType

setTypeRgb

setTypeRgbt

setTypeRgbf

setTypeRgbft

setType

getPovClipseToken

setPovClipseToken

setVector

toString

equals

getPosition

setPosition

hasFilter

hasTransmit

setSameValue

isSameValue

toSerializationString

fromSerializedString