SoColorMap

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.misc.SoBase
  - - com.openinventor.inventor.fields.SoFieldContainer
    - - com.openinventor.inventor.nodes.SoNode
      - com.openinventor.inventor.nodes.SoColorMap

All Implemented Interfaces:

SafeDisposable
```
public class SoColorMap
extends SoNode
```
Class for indexed texture color map. This class describes the association between values of the SoIndexedTexture2 node and colors.
The data value coming from the SoIndexedTexture2 node is used as an index into the color map defined by the colorMap field or the predefinedColorMap field.
The predefinedColorMap field allows you to specify a predefined color map or using value NONE, that the color map is contained in the colorMap field.
The min and max fields define the range of the data values that will actually be used. The color map is modified such that only data values ranging from min to max will be mapped to the color map. The figure below illustrates the effects of these fields:
The SoColorMap node acts like an SoShaderProgram with an SoFragmentShader. Standard Open Inventor operations on textures will be disabled on all subsequent nodes, thus using an SoTexture2 node or multitexturing after this node will not give the expected result.
NOTE: The SoColorMap node must be inserted before the SoIndexedTexture2. This node puts the color map in the next available texture unit, so this unit must not be used for any other purpose in your application. On hardware which doesn't support ARB_fragment_program but supports EXT_paletted_texture , the next available texture unit is not used and thus remains available for use by the application. If your graphics hardware does not support the ARB_fragment_program or the EXT_paletted_texture OpenGL extension, this node has no effect. SoColorMap is only used to color SoIndexedTexture2 nodes. To specify a color map for volume rendering, see SoTransferFunction.
EXAMPLE
The following example shows how to apply an indexed texture on a geometry node:
```
 SoColorMap colorMap = new SoColorMap();
   colorMap.predefinedColorMap.setValue( SoColorMap.PredefinedColorMaps.TEMPERATURE );
   colorMap.min.setValue( -1000 );
   colorMap.max.setValue( 20000 );
 SoIndexedTexture2 indexedTexture = new SoIndexedTexture2();
   indexedTexture.imageIndex.setValue(size, SoSFArray.DataTypes.SIGNED_SHORT, data); 
 root.addChild( colorMap );
 root.addChild( indexedTexture );
 root.addChild( geometry ); 
```
File format/default:
ColorMap {
}
Action behavior:
SoGLRenderAction, SoCallbackAction
Sets: SoColorMapElement
See also:
SoIndexedTexture2

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SoColorMap.ColorMapFormats` Color map format.
`static class`	`SoColorMap.Interpolations` The colormap interpolation type.
`static class`	`SoColorMap.PredefinedColorMaps` Predefined color map.

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AIRWAY` Deprecated. Use `SoColorMap.PredefinedColorMaps.AIRWAY` instead.
`static int`	`AIRWAY_SURFACES` Deprecated. Use `SoColorMap.PredefinedColorMaps.AIRWAY_SURFACES` instead.
`static int`	`ALPHA` Deprecated. Use `SoColorMap.ColorMapFormats.ALPHA` instead.
`static int`	`BLUE_RED` Deprecated. Use `SoColorMap.PredefinedColorMaps.BLUE_RED` instead.
`static int`	`BLUE_WHITE_RED` Deprecated. Use `SoColorMap.PredefinedColorMaps.BLUE_WHITE_RED` instead.
`SoMFFloat`	`colorMap` Array of floats in range [0,1].
`SoSFEnum<SoColorMap.ColorMapFormats>`	`colorMapFormat` Indicates the format of the color map (number of color components).
`static int`	`GLOW` Deprecated. Use `SoColorMap.PredefinedColorMaps.GLOW` instead.
`static int`	`GRAY` Deprecated. Use `SoColorMap.PredefinedColorMaps.GRAY` instead.
`static int`	`INTENSITY` Deprecated. Use `SoColorMap.PredefinedColorMaps.INTENSITY` instead.
`static int`	`INTENSITY_REVERSED` Deprecated. Use `SoColorMap.PredefinedColorMaps.INTENSITY_REVERSED` instead.
`SoSFEnum<SoColorMap.Interpolations>`	`interpolation` The colormap interpolation type.
`static int`	`LABEL_256` Deprecated. Use `SoColorMap.PredefinedColorMaps.LABEL_256` instead.
`static int`	`LINEAR` Deprecated. Use `SoColorMap.Interpolations.LINEAR` instead.
`static int`	`LUMINANCE` Deprecated. Use `SoColorMap.ColorMapFormats.LUMINANCE` instead.
`static int`	`LUMINANCE_ALPHA` Deprecated. Use `SoColorMap.ColorMapFormats.LUMINANCE_ALPHA` instead.
`SoSFFloat`	`max` See `min`.
`SoSFFloat`	`min` This field allow to remap the color map such that only data values ranging from min to max will be mapped to the color map.
`static int`	`NEAREST` Deprecated. Use `SoColorMap.Interpolations.NEAREST` instead.
`static int`	`NONE` Deprecated. Use `SoColorMap.PredefinedColorMaps.NONE` instead.
`static int`	`PHYSICS` Deprecated. Use `SoColorMap.PredefinedColorMaps.PHYSICS` instead.
`SoSFEnum<SoColorMap.PredefinedColorMaps>`	`predefinedColorMap` Use this field to load predefined color maps.
`static int`	`RGB` Deprecated. Use `SoColorMap.ColorMapFormats.RGB` instead.
`static int`	`RGB_ALPHA` Deprecated. Use `SoColorMap.ColorMapFormats.RGB_ALPHA` instead.
`static int`	`SEISMIC` Deprecated. Use `SoColorMap.PredefinedColorMaps.SEISMIC` instead.
`static int`	`STANDARD` Deprecated. Use `SoColorMap.PredefinedColorMaps.STANDARD` instead.
`static int`	`TEMPERATURE` Deprecated. Use `SoColorMap.PredefinedColorMaps.TEMPERATURE` instead.
`static int`	`VOLREN_GREEN` Deprecated. Use `SoColorMap.PredefinedColorMaps.VOLREN_GREEN` instead.
`static int`	`VOLREN_RED` Deprecated. Use `SoColorMap.PredefinedColorMaps.VOLREN_RED` instead.

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description

SoColorMap()
Constructor.

Constructors
Constructor and Description
`SoColorMap()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getNumColor()` This convenience method returns the number of colors in the color map (ie: colorMap.getNum()/Number of components or 256 if a predefined color map is used)
`boolean`	`hasTransparency()` Returns true if the current color map contains alpha values less than 1.

Methods inherited from class com.openinventor.inventor.nodes.SoNode
affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderUnitID, GLRender, GLRenderBelowPath, GLRenderInPath, GLRenderOffPath, grabEventsCleanup, grabEventsSetup, handleEvent, isBoundingBoxIgnoring, isOverride, pick, rayPick, search, setOverride, touch, write

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer
copyFieldValues, copyFieldValues, enableNotify, fieldsAreEqual, get, getAllFields, getEventIn, getEventOut, getField, getFieldName, hasDefaultValues, isNotifyEnabled, set, setToDefaults

Methods inherited from class com.openinventor.inventor.misc.SoBase
dispose, getEXTERNPROTO, getName, getPROTO, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor
getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LUMINANCE
```
@Deprecated
public static final int LUMINANCE
```
    Deprecated. Use SoColorMap.ColorMapFormats.LUMINANCE instead.
  - ALPHA
```
@Deprecated
public static final int ALPHA
```
    Deprecated. Use SoColorMap.ColorMapFormats.ALPHA instead.
  - LUMINANCE_ALPHA
```
@Deprecated
public static final int LUMINANCE_ALPHA
```
    Deprecated. Use SoColorMap.ColorMapFormats.LUMINANCE_ALPHA instead.
  - RGB
```
@Deprecated
public static final int RGB
```
    Deprecated. Use SoColorMap.ColorMapFormats.RGB instead.
  - RGB_ALPHA
```
@Deprecated
public static final int RGB_ALPHA
```
    Deprecated. Use SoColorMap.ColorMapFormats.RGB_ALPHA instead.
  - NONE
```
@Deprecated
public static final int NONE
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.NONE instead.
  - GRAY
```
@Deprecated
public static final int GRAY
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.GRAY instead.
  - TEMPERATURE
```
@Deprecated
public static final int TEMPERATURE
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.TEMPERATURE instead.
  - PHYSICS
```
@Deprecated
public static final int PHYSICS
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.PHYSICS instead.
  - STANDARD
```
@Deprecated
public static final int STANDARD
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.STANDARD instead.
  - GLOW
```
@Deprecated
public static final int GLOW
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.GLOW instead.
  - BLUE_RED
```
@Deprecated
public static final int BLUE_RED
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.BLUE_RED instead.
  - SEISMIC
```
@Deprecated
public static final int SEISMIC
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.SEISMIC instead.
  - BLUE_WHITE_RED
```
@Deprecated
public static final int BLUE_WHITE_RED
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.BLUE_WHITE_RED instead.
  - INTENSITY
```
@Deprecated
public static final int INTENSITY
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.INTENSITY instead.
  - LABEL_256
```
@Deprecated
public static final int LABEL_256
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.LABEL_256 instead.
  - VOLREN_RED
```
@Deprecated
public static final int VOLREN_RED
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.VOLREN_RED instead.
  - VOLREN_GREEN
```
@Deprecated
public static final int VOLREN_GREEN
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.VOLREN_GREEN instead.
  - AIRWAY
```
@Deprecated
public static final int AIRWAY
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.AIRWAY instead.
  - AIRWAY_SURFACES
```
@Deprecated
public static final int AIRWAY_SURFACES
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.AIRWAY_SURFACES instead.
  - INTENSITY_REVERSED
```
@Deprecated
public static final int INTENSITY_REVERSED
```
    Deprecated. Use SoColorMap.PredefinedColorMaps.INTENSITY_REVERSED instead.
  - NEAREST
```
@Deprecated
public static final int NEAREST
```
    Deprecated. Use SoColorMap.Interpolations.NEAREST instead.
  - LINEAR
```
@Deprecated
public static final int LINEAR
```
    Deprecated. Use SoColorMap.Interpolations.LINEAR instead.
  - min
```
public final SoSFFloat min
```
    This field allow to remap the color map such that only data values ranging from min to max will be mapped to the color map. min and max must be between minValue and maxValue of the corresponding SoIndexedTexture2 node.
    Values less than min and greater than max will be set to colorMap[0] and colorMap[colorMap.getNum()-1] respectively. If min is less than the minimum of the indexed texture minValue , it will be clamped to this minimum. If max is greater than the maximum of the indexed texture maxValue , it will be clamped to this maximum. When min and max are equal to 0 (the default), the entire range of data values is used.
    Setting (min,max) to (64,192) while the predefined STANDARD color map is selected and in the case of a UNSIGNED_BYTE indexed texture will make the color map as shown:
  - max
```
public final SoSFFloat max
```
    See min.
  - predefinedColorMap
```
public final SoSFEnum<SoColorMap.PredefinedColorMaps> predefinedColorMap
```
    Use this field to load predefined color maps. . Default is TEMPERATURE. All predefined color maps have 256 entries.
    NOTE: In the images above the checkerboard pattern shows through where the color map alpha (opacity) value is less than 1.0.
    If it is set to NONE, the fields below must be set.
  - colorMapFormat
```
public final SoSFEnum<SoColorMap.ColorMapFormats> colorMapFormat
```
    Indicates the format of the color map (number of color components). . Default is RGB_ALPHA.
    LUMINANCE means one component per color for a grayscale color map.
    ALPHA means one alpha component per color.
    LUMINANCE_ALPHA means two components per color, luminance and alpha. In such a case the colorMap float array contains a list of two floats. Index 0 is luminance, index 1 is alpha, index 2 is luminance, index 3 is alpha and so on.
    RGB means three components per color, ordered red first, then green and blue.
    RGB_ALPHA means four components per color, ordered red first, then green, blue, and alpha.
    An alpha value equal to zero means "fully transparent", an alpha value equal to one means "opaque".
  - colorMap
```
public final SoMFFloat colorMap
```
    Array of floats in range [0,1]. The number of floats depends on colorMapFormat. It is equal to the number of colors defined multiplied by the number of components per color. For example, for an RGBA color map of length n, there should be 4*n float values in the field. If a predefined color map is specified, the values of this field are not used.
  - interpolation
```
public final SoSFEnum<SoColorMap.Interpolations> interpolation
```
    The colormap interpolation type. These types determine the method used for color map texture filtering. . Default is NEAREST.
    
    Since:
    
    Open Inventor 9.4.2
- Constructor Detail
  - SoColorMap
```
public SoColorMap()
```
    Constructor.
- Method Detail
  - hasTransparency
```
public boolean hasTransparency()
```
    Returns true if the current color map contains alpha values less than 1. false means the color map is completely opaque.
  - getNumColor
```
public int getNumColor()
```
    This convenience method returns the number of colors in the color map (ie: colorMap.getNum()/Number of components or 256 if a predefined color map is used)

min	0
max	0
predefinedColorMap	TEMPERATURE
colorMapFormat	RGB_ALPHA
colorMap	0

GRAY
TEMPERATURE
PHYSICS
STANDARD
GLOW
BLUE_RED
SEISMIC
BLUE_WHITE_RED
INTENSITY
LABEL_256
VOLREN_RED
VOLREN_GREEN
AIRWAY
AIRWAY_SURFACES

Class SoColorMap

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.inventor.nodes.SoNode

Methods inherited from class com.openinventor.inventor.fields.SoFieldContainer

Methods inherited from class com.openinventor.inventor.misc.SoBase

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

LUMINANCE

ALPHA

LUMINANCE_ALPHA

RGB

RGB_ALPHA

NONE

GRAY

TEMPERATURE

PHYSICS

STANDARD

GLOW

BLUE_RED

SEISMIC

BLUE_WHITE_RED

INTENSITY

LABEL_256

VOLREN_RED

VOLREN_GREEN

AIRWAY

AIRWAY_SURFACES

INTENSITY_REVERSED

NEAREST

LINEAR

min

max

predefinedColorMap

colorMapFormat

colorMap

interpolation

Constructor Detail

SoColorMap

Method Detail

hasTransparency

getNumColor