/*
!=======================================================================
!
!  PROGRAM  PHASE-Viewer  (PHASE-Viewer 2014.01 ver.3.3.0)
!
!  Created on 2006/06/29, 14:49
!  AUTHOR(S): KOGA, Junichiro
!  File : ColorMap.java
!  
!  Contact address :  Phase System Consortium
!                     E-mail: phase_system@nims.go.jp URL https://azuma.nims.go.jp
!
!
!   Since 2002, this program set had been intensively developed as a part of the following 
!  national projects supported by the Ministry of Education, Culture, Sports, Science and
!  Technology (MEXT) of Japan; "Frontier Simulation Software for Industrial Science
!  (FSIS)" from 2002 to 2005, "Revolutionary Simulation Software (RSS21)" from 2006 to
!  2008. "Research and Development of Innovative Simulation Software (RISS)" from 2008
!  to 2013. These projects is lead by the Center for Research on Innovative Simulation 
!  Software (CISS), the Institute of Industrial Science (IIS), the University of Tokyo.
!   Since 2013, this program set has been further developed centering on PHASE System
!  Consortium. 
!   The activity of development of this program set has been supervised by Takahisa Ohno.
!
!=======================================================================
 */

package ciss.phase_viewer.acviewer.colormap;

import java.awt.Color;

import javax.media.j3d.BranchGroup;
import javax.vecmath.Color3f;

/**
 * カラーマップのインターフェース
 * 
 * @author
 */
public interface ColorMap {

    /**
     * 対象カラーマップの名前.
     * 
     * @return カラーマップの名前.
     */
    public String getName();

    /**
     * 引数の値に併せてColor3fのインスタンスを返す.
     * 
     * @param value
     *            値(通常, 0から1)
     * @return valueに対応するColor3fのオブジェクト
     */
    public Color3f getColor3f(float value);

    /**
     * 引数の値に併せてColor3fのインスタンスを返す. カラーを"逆"にするか否か選べる.
     * 
     * @param value
     *            値(通常, 0から1)
     * @param invert
     *            真の場合, 通常と逆のカラーマップになる.
     * @return valueに対応するColor3fのオブジェクト
     */
    public Color3f getColor3f(float value, boolean invert);

    /**
     * 引数の値に併せてColorのインスタンスを返す.
     * 
     * @param value
     *            値(通常, 0から1)
     * @return valueに対応するColorのオブジェクト
     */
    public Color getColor(float value);

    /**
     * 引数の値に併せてColorのインスタンスを返す. カラーを"逆"にするか否か選べる.
     * 
     * @param value
     *            値(通常, 0から1)
     * @return valueに対応するColorのオブジェクト
     */
    public Color getColor(float value, boolean invert);

    /**
     * カラーマップの"解像度"を返す.
     * 
     * @return カラーマップの解像度
     */
    public int getResolution();

    /**
     * 「カラーバー」を作成; Java3DのBranchGroupのインスタンスであることを仮定してしまう.
     * 
     * @return カラーバー
     */
    public BranchGroup getColorBar();

}
