Click or drag to resize
SoColorMap Class

Class for indexed texture color map.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2023.1.3.0 (2023.1.3)
Syntax
Copy
public class SoColorMap : SoNode

The SoColorMap type exposes the following members.

Constructors
  NameDescription
Public methodSoColorMap

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

Returns true if a node has an effect on the state during traversal.

(Inherited from SoNode.)
Public methodCallback
(Overrides SoNodeCallback(SoCallbackAction).)
Public methodCopy
Calls Copy(false).
(Inherited from SoNode.)
Public methodCopy(Boolean)

Creates and returns an exact copy of the node.

(Inherited from SoNode.)
Public methodCopyFieldValues(SoFieldContainer)
Calls CopyFieldValues(fc, false).
(Inherited from SoFieldContainer.)
Public methodCopyFieldValues(SoFieldContainer, Boolean)

Copies the contents of fc's fields into this object's fields.

(Inherited from SoFieldContainer.)
Public methodDispose
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.)
Public methodDistribute
(Inherited from SoNode.)
Public methodDoAction
(Overrides SoNodeDoAction(SoAction).)
Public methodEnableNotify

Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false).

(Inherited from SoFieldContainer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFieldsAreEqual

Returns true if this object's fields are exactly equal to fc's fields.

(Inherited from SoFieldContainer.)
Public methodGet

Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string.

(Inherited from SoFieldContainer.)
Public methodGetAllFields

Returns a list of fields, including the eventIn's and eventOut's.

(Inherited from SoFieldContainer.)
Public methodGetAlternateRep

This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type).

(Inherited from SoNode.)
Public methodGetBoundingBox
(Inherited from SoNode.)
Public methodGetEventIn

Returns a the eventIn with the given name.

(Inherited from SoFieldContainer.)
Public methodGetEventOut

Returns the eventOut with the given name.

(Inherited from SoFieldContainer.)
Public methodGetField

Returns a the field of this object whose name is fieldName.

(Inherited from SoFieldContainer.)
Public methodGetFieldName

Returns the name of the given field in the fieldName argument.

(Inherited from SoFieldContainer.)
Public methodGetFields

Appends references to all of this object's fields to resultList, and returns the number of fields appended.

(Inherited from SoFieldContainer.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetMatrix
(Inherited from SoNode.)
Public methodGetName

Returns the name of an instance.

(Inherited from SoBase.)
Public methodGetNumColor

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)

Public methodGetPrimitiveCount
(Inherited from SoNode.)
Public methodGetRenderEngineMode

Returns the supported Render engine mode.

(Inherited from SoNode.)
Public methodGetRenderUnitID
(Inherited from SoNode.)
Public methodGetStringName (Inherited from SoBase.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGLRender
(Overrides SoNodeGLRender(SoGLRenderAction).)
Public methodGLRenderBelowPath
(Inherited from SoNode.)
Public methodGLRenderInPath
(Inherited from SoNode.)
Public methodGLRenderOffPath
(Inherited from SoNode.)
Public methodGrabEventsCleanup
(Inherited from SoNode.)
Public methodGrabEventsSetup
(Inherited from SoNode.)
Public methodHandleEvent
(Inherited from SoNode.)
Public methodHasDefaultValues

Returns true if all of the object's fields have their default values.

(Inherited from SoFieldContainer.)
Public methodHasTransparency

Returns true if the current color map contains alpha values less than 1.

Public methodIsBoundingBoxIgnoring

This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored.

(Inherited from SoNode.)
Public methodIsNotifyEnabled

Notification is the process of telling interested objects that this object has changed.

(Inherited from SoFieldContainer.)
Public methodIsOverride

Returns the state of the override flag.

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodPick
(Inherited from SoNode.)
Public methodRayPick
(Inherited from SoNode.)
Public methodSearch
(Inherited from SoNode.)
Public methodSet

Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format.

(Inherited from SoFieldContainer.)
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
Public methodSetSynchronizable

Sets this to be a ScaleViz synchronizable object.

(Inherited from SoBase.)
Public methodSetToDefaults

Sets all fields in this object to their default values.

(Inherited from SoFieldContainer.)
Public methodToString
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.)
Public methodTouch

Marks an instance as modified, simulating a change to it.

(Inherited from SoNode.)
Public methodWrite
(Inherited from SoNode.)
Top
Properties
  NameDescription
Public propertycolorMap

Array of floats in range [0,1].

Public propertycolorMapFormat

Indicates the format of the color map (number of color components).

Public propertyinterpolation

The colormap interpolation type.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertymax

See OIV.Inventor.Nodes.SoColorMap.min.

Public propertymin

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.

Public propertypredefinedColorMap

Use this field to load predefined color maps.

Public propertyUserData
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.)
Top
Remarks

This class describes the association between values of the OIV.Inventor.Nodes.SoIndexedTexture2 node and colors.

The data value coming from the OIV.Inventor.Nodes.SoIndexedTexture2 node is used as an index into the color map defined by the OIV.Inventor.Nodes.SoColorMap.colorMap field or the OIV.Inventor.Nodes.SoColorMap.predefinedColorMap field.

The OIV.Inventor.Nodes.SoColorMap.predefinedColorMap field allows you to specify a predefined color map or using value NONE, that the color map is contained in the OIV.Inventor.Nodes.SoColorMap.colorMap field.

The OIV.Inventor.Nodes.SoColorMap.min and OIV.Inventor.Nodes.SoColorMap.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 OIV.Inventor.Nodes.SoColorMap.min to OIV.Inventor.Nodes.SoColorMap.max will be mapped to the color map. The figure below illustrates the effects of these fields:

The OIV.Inventor.Nodes.SoColorMap node acts like an OIV.Inventor.Nodes.SoShaderProgram with an OIV.Inventor.Nodes.SoFragmentShader. Standard Open Inventor operations on textures will be disabled on all subsequent nodes, thus using an OIV.Inventor.Nodes.SoTexture2 node or multitexturing after this node will not give the expected result.

NOTE:

  • The OIV.Inventor.Nodes.SoColorMap node must be inserted before the OIV.Inventor.Nodes.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.

  • OIV.Inventor.Nodes.SoColorMap is intended to be used with a OIV.Inventor.Nodes.SoIndexedTexture2 node. However, without an OIV.Inventor.Nodes.SoIndexedTexture2 node, the color map will still be applied on the geometry, but without indexation. To specify a color map for volume rendering, see OIV.LDM.Nodes.SoTransferFunction.

EXAMPLE

The following example shows how to apply an indexed texture on a geometry node:

Copy
SoColorMap colorMap = new SoColorMap();
 colorMap.predefinedColorMap.Value = SoColorMap.PredefinedColorMaps.TEMPERATURE;
 colorMap.min.Value = -1000;
 colorMap.max.Value = 20000;
SoIndexedTexture2 indexedTexture = new SoIndexedTexture2();
 indexedTexture.imageIndex.SetValue(size, (int)SoSFArray.DataTypes.SIGNED_SHORT, data); 
root.AddChild( colorMap );
root.AddChild( indexedTexture );
root.AddChild( geometry );

FILE FORMAT/DEFAULT

ColorMap {
min 0
max 0
predefinedColorMap TEMPERATURE
colorMapFormat RGB_ALPHA
colorMap 0
}

ACTION BEHAVIOR

OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction Sets: OIV.Inventor.Elements.SoColorMapElement

See Also