PdColor (JavaView Reference Manual)

Overview

Package

Class

Tree

Deprecated

Index

Help

JavaView^© v3.95.000

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jv.number
Class PdColor

java.lang.Object
  jv.object.PsObject
      jv.number.PdColor

All Implemented Interfaces:: java.lang.Cloneable, PsUpdateIf, java.io.Serializable

public final class PdColor
extends PsObject

RGBA color class with info panel and update functionality.

The class is derived from PsObject rather than java.awt.Color since the focus of this class is the update functionality and handling of an info panel for interactive modifications. This class allows interactive modification of a color similar to the class PuDouble and PuInteger allow for double and integer numbers. Also, java.awt.Color cannot be modified after construction.

See Also:: PdColor_IP, PdColor_Dialog, Serialized Form

Field Summary

Fields inherited from class jv.object.PsObject

HAS_CONFIG_PANEL, HAS_INFO_PANEL, HAS_LABEL_PANEL, HAS_MATERIAL_PANEL, HAS_TEXTURE_PANEL, HAS_VECTOR_PANEL, INSPECTOR_INFO, INSPECTOR_INFO_EXT, IS_DELETED, IS_FIXED, IS_FOCUSSED, IS_PICKED, IS_SELECTED, IS_USED, NUM_TAGS

Constructor Summary
`PdColor()` Constructor of color in RGB mode with alpha disabled.
`PdColor(int size, boolean bAlpha)` Constructor of color in RGB mode with number of color components and possible alpha channel.
`PdColor(java.lang.String name, PsUpdateIf parent)` Constructor of color in RGB mode with alpha disabled.

Method Summary
`static java.awt.Color`	`blend(double a, java.awt.Color v, double b, java.awt.Color w)` Interpolate between two colors with given weights.
`void`	`blend(double a, PdColor v, double b, PdColor w)` Interpolate between two colors with given weights.
`void`	`blendBase(PdColor v, double b, PdColor w)` Interpolate between two colors with given weights.
`static java.awt.Color`	`brighter(java.awt.Color color)` Modified against official Java implementation to ensure that the brighter color is visually different.
`java.lang.Object`	`clone()` Duplicate color and data array.
`static java.awt.Color`	`cmyk2rgb(int c, int m, int y, int k)` Convert a set of (cyan, magenta, yellow, black) to RGB color.
`static boolean`	`copy(java.awt.Color[] dataDest, int destInd, java.awt.Color[] dataSrc, int srcInd, int size)` Assign some colors of a given array of colors to an existing destination array.
`void`	`copy(double[] anArray, int aSize)` Copy color components excluding alpha.
`void`	`copy(int[] anArray, int aSize)` Copy color components excluding alpha.
`void`	`copy(PdColor v)` Copy color components including alpha.
`static boolean`	`copy(PdColor[] dataDest, int destInd, PdColor[] dataSrc, int srcInd, int size)` Copies some colors of a given array of colors into an existing destination array.
`static java.awt.Color[]`	`copyNew(java.awt.Color[] data)` Create an new array with copies of all colors of a given array of colors.
`static java.awt.Color[]`	`copyNew(java.awt.Color[] data, int size)` Create an new array with copies of the first 'size' colors of a given array of colors.
`static PdColor`	`copyNew(PdColor v)` Create a new color as clone of argument color.
`static PdColor[]`	`copyNew(PdColor[] data)` Create an new array with copies of all colors of a given array of colors.
`static PdColor[]`	`copyNew(PdColor[] data, int size)` Create an new array with copies of the first 'size' colors of a given array of colors.
`void`	`enableAlpha(boolean flag)` Enable or disable alpha channel.
`boolean`	`equals(java.awt.Color col)` Determines whether another color is equal to this color.
`boolean`	`equals(PdColor col)` Determines whether another color is equal to this color.
`int`	`getAlpha()` Get alpha component if alpha is enabled, otherwise result is 0.
`int`	`getBlue()` Get blue color component if `size==3`, otherwise result is 0.
`java.awt.Color`	`getColor()` Convert color components in a java.awt.Color instance.
`static java.awt.Color`	`getColorFromName(java.lang.String color)` Convert a verbal color descriptor into a color instance.
`static java.awt.Color`	`getDimmedColor(java.awt.Color col, double dim)` Get a color whose components are dimmed by a factor.
`static java.awt.Color`	`getDimmedColor(java.awt.Color col, double dim, double offset)` Get a color whose components are dimmed by a factor and shifted by an offset.
`static java.awt.Color`	`getDimmedColor(java.awt.Color col, int dim)` Get a color whose components are dimmed by a factor.
`static int`	`getDimmedColor(int[] rgb, int dim)` Get a color whose components are dimmed by a factor.
`static int`	`getDimmedColor(int rgb, double dim)` Get a color whose components are dimmed by a factor.
`static int`	`getDimmedColor(int rgb, double dim, double offset)` Get a color whose components are dimmed by a factor and shifted by an offset.
`static int`	`getDimmedColor(int rgb, int dim)` Get a color whose components are dimmed by a factor.
`int`	`getEntry(int ind)` Get a color component with given index.
`int`	`getGreen()` Get green color component if `size==3`, otherwise result is 0.
`int`	`getGrey()` Get grey color if `size==1`, otherwise result is 0.
`static int`	`getMax(int rgb)` Get maximal value of all components.
`static int`	`getMin(int rgb)` Get minimal value of all components.
`int`	`getRed()` Get red color component if `size==3`, otherwise result is 0.
`int`	`getSize()` Return number of components excluding alpha.
`static java.awt.Color`	`getXORColor(java.awt.Color colCurr, java.awt.Color colPref, java.awt.Color colAlt, int eps)` Choose a new color depending on the distance to an existing color.
`boolean`	`hasAlpha()` Check whether alpha channel is used.
`static java.awt.Color`	`hsl2rgb(int hi, int li, int si)`
`static java.awt.Color`	`hsv2rgb(java.awt.Color hsv)` Conversion of color spaces.
`static java.awt.Color`	`hsv2rgb(int h, int s, int v)` Conversion of color spaces.
`static void`	`hsv2rgb(PdColor rgb, PdColor hsv)` Conversion of color spaces.
`static int`	`hsv2rgbAsInt(int h, int s, int v)` Conversion of color spaces.
`int`	`indexOfMax()` Find component in color with maximal value.
`int`	`indexOfMin()` Find component in color with minimal value.
`void`	`init()` Initialize and reset components to 0.
`boolean`	`isEnabled()` Check whether color dialog is enabled or disabled.
`int`	`max()` Find maximal value of component in color.
`int`	`min()` Find minimal value of component in color.
`static java.awt.Color`	`parseColor(java.lang.String colorString)` Parse rgb color from a given string where each component is integer in the range 0..255 or a float in the range [0.,1.].
`static java.awt.Color[]`	`realloc(java.awt.Color[] data, int arraySize)` Allocate an array of Java colors and assign default color black.
`static PdColor[]`	`realloc(PdColor[] data, int arraySize, int colorSize)` Allocate an array of colors, where all colors have the same dimension.
`static PdColor[]`	`realloc(PdColor[] data, int arraySize, int colorSize, boolean bAlpha)` Allocate an array of colors, where all colors have the same dimension.
`static int[]`	`rgb2cmyk(int r, int g, int b)` Convert a set of (cyan, magenta, yellow, black) to RGB color.
`static java.awt.Color`	`rgb2hsl(int ri, int gi, int bi)`
`static void`	`rgb2hsv(PdColor hsv, PdColor rgb)` Conversion of color spaces.
`static java.awt.Color`	`rgb2yiq(int ri, int gi, int bi)`
`void`	`set(double grey)` Set grey component of this color using double arguments in [0., 1.].
`void`	`set(double red, double green, double blue)` Set components of this color using double arguments in [0., 1.].
`void`	`set(double red, double green, double blue, double alpha)` Set components of this color using double arguments in [0., 1.].
`void`	`set(int grey)` Set grey component of this color using integer argument in [0, 255].
`void`	`set(int red, int green, int blue)` Set components of this color using integer argument in [0, 255].
`void`	`set(int red, int green, int blue, int alpha)` Set components of this color using double arguments in [0, 255].
`void`	`setAlpha(double alpha)` Set alpha component of this color using double argument in [0., 1.].
`void`	`setAlpha(int alpha)` Set alpha component of this color using integer argument in [0, 255].
`void`	`setColor(java.awt.Color aColor)` Set color components to components of argument color.
`void`	`setConstant(int value)` Set all color components excluding alpha to the same value.
`void`	`setEnabled(boolean flag)` Enable or disable the color dialog for interactive use.
`void`	`setEntry(int ind, double value)` Set a color component with given index to value.
`void`	`setEntry(int ind, int value)` Set a color component with given index to value.
`void`	`setSize(int aSize)` Set number of components of color excluding alpha.
`static java.awt.Color`	`yiq2rgb(int yi, int ii, int qi)`

Methods inherited from class jv.object.PsObject

addInspector, addUpdateListener, assureInspector, clearTag, clone, clone, copy, getFather, getInfoPanel, getInspector, getName, getNumObjects, getSymbol, hasInspector, hasTag, hasUpdateListener, instanceOf, instanceOf, newInspector, newInspector, removeInspector, removeInspector, removeUpdateListener, setName, setParent, setSymbol, setTag, toString, update, updatePanels

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PdColor

public PdColor()

Constructor of color in RGB mode with alpha disabled. Calls PdColor(m_numDefColors, false).

PdColor

public PdColor(int size,
               boolean bAlpha)

Constructor of color in RGB mode with number of color components and possible alpha channel.
Parameters:: size - number of color components excluding alpha; bAlpha - true to enable alpha channel

PdColor

public PdColor(java.lang.String name,
               PsUpdateIf parent)

Constructor of color in RGB mode with alpha disabled.
Parameters:: name - name of color, e.g. used as header in info panel; parent - parent receives update events, e.g. when color changes through info panel

Method Detail

init

public void init()

Initialize and reset components to 0.

Overrides:: init in class PsObject

isEnabled

public boolean isEnabled()

Check whether color dialog is enabled or disabled.

setEnabled

public void setEnabled(boolean flag)

Enable or disable the color dialog for interactive use. If disabled, the color variable can still be modified by calls setValue(double), and the color dialog is always updated.

getColorFromName

public static java.awt.Color getColorFromName(java.lang.String color)

Convert a verbal color descriptor into a color instance. Currently all static names in java.awt.Color supported.

Parameters:: color - Name of color, e.g. white, gray, orange
Returns:: instance of java.awt.Color representing the color

getSize

public int getSize()

Return number of components excluding alpha.

setSize

public void setSize(int aSize)

Set number of components of color excluding alpha. Note, alpha must be enabled separately. Note, alpha should be enabled before this method is called to allow this method to allocate alpha channel simultaneously with of other channels. All memory allocations are done in this method.

Parameters:: aSize - number of color components, e.g. 3 in rgb mode.

equals

public boolean equals(java.awt.Color col)

Determines whether another color is equal to this color. The result is true if both colors have same color components excluding alpha. Result is also true if argument color is null and this color has no entries.

Alpha is not compared since Java1.1 does not support alpha in java.awt.Color.

Parameters:: col - the color to compare with
Returns:: true if the color component are the same; false otherwise.

equals

public boolean equals(PdColor col)

Determines whether another color is equal to this color. The result is true if both colors have same size and equal components including alpha. Result is also true if argument color is null and this color has no entries.

Parameters:: col - the color to compare with
Returns:: true if the objects are the same; false otherwise.

getGrey

public int getGrey()

Get grey color if size==1, otherwise result is 0.

getRed

public int getRed()

Get red color component if size==3, otherwise result is 0.

getGreen

public int getGreen()

Get green color component if size==3, otherwise result is 0.

getBlue

public int getBlue()

Get blue color component if size==3, otherwise result is 0.

getAlpha

public int getAlpha()

Get alpha component if alpha is enabled, otherwise result is 0.

getMax

public static int getMax(int rgb)

Get maximal value of all components.

Since:: JavaView 3.54.001

getMin

public static int getMin(int rgb)

Get minimal value of all components.

Since:: JavaView 3.54.001

brighter

public static java.awt.Color brighter(java.awt.Color color)

Modified against official Java implementation to ensure that the brighter color is visually different. Each color component x is mapped to 127+x/2. As a consequence we have: 1. black.brighter() returns grey=(128,128,128) 2. applying brighter to blue returns lighter blue = (128,128,255) 3. non pure color (non zero rgb) will eventually return white

This method is intended as a replacement of java.awt.Color#brighter. The original method simply multiplies each component with something like 1.4 which has no visual consequences for dark colors.

Since:: JavaView 2.86.000