Class for 2D indexed texture. More...
#include <Inventor/nodes/SoIndexedTexture2.h>
Public Member Functions | |
virtual SoType | getTypeId () const |
Returns the type identifier for this specific instance. | |
void | computeDataRange () |
Compute the min and max value of the indexed image and put the result in minValue and maxValue. | |
SoIndexedTexture2 () | |
Constructor. | |
Public Member Functions inherited from SoTexture | |
void | setBitmapFileType (FileType in_type) |
Sets the texture file format. | |
FileType | getBitmapFileType (void) |
Gets the texture file format. | |
virtual void | setOverride (const SbBool state) |
Set the state of the override field. | |
virtual SbBool | isOverride () const |
Returns the state of the override field. | |
Public Member Functions inherited from SoNode | |
virtual SoNode * | copy (SbBool copyConnections=FALSE) const |
Creates and returns an exact copy of the node. | |
virtual SbBool | affectsState () const |
Returns TRUE if a node has an effect on the state during traversal. | |
virtual void | touch () |
Marks an instance as modified, simulating a change to it. | |
Public Member Functions inherited from SoFieldContainer | |
void | setToDefaults () |
Sets all fields in this object to their default values. | |
SbBool | hasDefaultValues () const |
Returns TRUE if all of the object's fields have their default values. | |
SbBool | fieldsAreEqual (const SoFieldContainer *fc) const |
Returns TRUE if this object's fields are exactly equal to fc's fields. | |
void | copyFieldValues (const SoFieldContainer *fc, SbBool copyConnections=FALSE) |
Copies the contents of fc's fields into this object's fields. | |
SoNONUNICODE SbBool | set (const char *fieldDataString) |
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. | |
SbBool | set (const SbString &fieldDataString) |
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. | |
void | get (SbString &fieldDataString) |
Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. | |
virtual int | getFields (SoFieldList &list) const |
Appends references to all of this object's fields to resultList, and returns the number of fields appended. | |
virtual int | getAllFields (SoFieldList &list) const |
Returns a list of fields, including the eventIn's and eventOut's. | |
virtual SoField * | getField (const SbName &fieldName) const |
Returns a the field of this object whose name is fieldName. | |
virtual SoField * | getEventIn (const SbName &fieldName) const |
Returns a the eventIn with the given name. | |
virtual SoField * | getEventOut (const SbName &fieldName) const |
Returns the eventOut with the given name. | |
SbBool | getFieldName (const SoField *field, SbName &fieldName) const |
Returns the name of the given field in the fieldName argument. | |
SbBool | enableNotify (SbBool flag) |
Notification at this Field Container is enabled (if flag == TRUE) or disabled (if flag == FALSE). | |
SbBool | isNotifyEnabled () const |
Notification is the process of telling interested objects that this object has changed. | |
virtual void | setUserData (void *data) |
Sets application data. | |
void * | getUserData (void) const |
Gets user application data. | |
Public Member Functions inherited from SoBase | |
virtual SbName | getName () const |
Returns the name of an instance. | |
virtual void | setName (const SbName &name) |
Sets the name of an instance. | |
void | setSynchronizable (const bool b) |
Sets this to be a ScaleViz synchronizable object. | |
bool | isSynchronizable () const |
Gets the ScaleViz synchronizable state of this object. | |
Public Member Functions inherited from SoRefCounter | |
void | ref () const |
Adds a reference to an instance. | |
void | unref () const |
Removes a reference from an instance. | |
void | unrefNoDelete () const |
unrefNoDelete() should be called when it is desired to decrement the reference count, but not delete the instance if this brings the reference count to zero. | |
int | getRefCount () const |
Returns current reference count. | |
void | lock () const |
lock this instance. | |
void | unlock () const |
unlock this instance. | |
Public Member Functions inherited from SoTypedObject | |
SbBool | isOfType (const SoType &type) const |
Returns TRUE if this object is of the type specified in type or is derived from that type. | |
template<typename TypedObjectClass > | |
SbBool | isOfType () const |
Returns TRUE if this object is of the type of class TypedObjectClass or is derived from that class. | |
Static Public Member Functions | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Static Public Member Functions inherited from SoTexture | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static SbBool | isSupported (HW_Feature feature) |
Returns information about hardware support for various texture features. | |
static SbRasterImage * | readTexture (const SbString &filename, FileType filetype=UNKNOWN) |
Convenience function that loads the image data from any texture file supported by Open Inventor and returns an SbRasterImage object. | |
Static Public Member Functions inherited from SoNode | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
static SoNode * | getByName (const SbName &name) |
A node's name can be set using SoBase::setName(). | |
static int | getByName (const SbName &name, SoNodeList &list) |
A node's name can be set using SoBase::setName(). | |
Static Public Member Functions inherited from SoFieldContainer | |
static SoType | getClassTypeId () |
Returns the type of this class. | |
Static Public Member Functions inherited from SoBase | |
static SoType | getClassTypeId () |
Returns type identifier for this class. | |
Static Public Member Functions inherited from SoTypedObject | |
static SoType | getClassTypeId () |
Returns the type identifier for this class. | |
Public Attributes | |
SoSFFloat | minValue |
Specifies the range of values which is mapped onto the color map (see SoColorMap). | |
SoSFFloat | maxValue |
See minValue. | |
SoSFArray2D | imageIndex |
This field contains the in-memory representation of the indexed texture image. | |
SoSFBool | rescaleTexCoord |
This field controls the way an image with non-power-of-two dimension is handled: | |
SoSFEnum | wrapT |
Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1. | |
Public Attributes inherited from SoTexture | |
SoSFEnum | internalFormat |
Internal format for texture storage. | |
SoSFBool | enableCompressedTexture |
Enables storage of textures on the graphics board in compressed form. | |
SoSFEnum | wrapS |
Indicates what to do when texture coordinates in the S (horizontal) direction lie outside the range 0-1. | |
SoSFEnum | model |
Specifies how to map texture onto surface. | |
SoSFColor | blendColor |
Color used for BLEND model. | |
SoSFBool | enableBorder |
Enables borders for textures. | |
SoSFVec4f | borderColor |
Defines border color used for border texture filtering. | |
SoSFFloat | maxAnisotropy |
Specifies on a per-texture object basis, the maximum degree of anisotropy to account for in texture filtering. | |
SoSFEnum | minFilter |
Specifies the OpenGL minFilter. | |
SoSFEnum | magFilter |
Specifies the OpenGL magFilter. | |
This property node defines an "indexed" texture image. In a standard texture image, e.g. SoTexture2, each texel contains a color value that is directly applied to the geometry. In this node each texel contains a data value that is mapped to a color value using the color map defined by the current SoColorMap node.
This image is stored in the current texture unit (see SoTextureUnit) and the texture is applied to subsequent shapes as they are rendered.
The image data is stored in an SoSFArray2D. This array can contain different types of data (UNSIGNED_BYTE, UNSIGNED_SHORT, UNSIGNED_INT32, SIGNED_BYTE, SIGNED_SHORT, SIGNED_INT32, FLOAT).
When Open Inventor creates the OpenGL texture image from the data array, the data values must be scaled into the range of values of the texture (0-255 for an 8-bit indexed texture). The minValue and maxValue fields specify the range of data values that will be scaled into the range of texture values. For example, if minValue is set to 10000 and maxValue to 38000, all values less than or equal to 10000 will be mapped to the entry 0 of the color map and all values greater than or equal to 38000 to the last entry. The image below illustrates the process of mapping and shows how it can be used to map only the used data range to the color map:
br
If minValue or maxValue change, then the OpenGL texture must be recreated. If the texture is large, this may be time consuming. Generally it's more efficient to modify the SoColorMap node because the OpenGL texture corresponding to the data does not need to be recreated – only the texture containing the colormap, which is normally quite small.
NOTE: Texture data values are stored with 12 bits of precision instead of the usual 8 bits, when:
The scene graph would be initialized like this:
minValue | 0 |
maxValue | 0 |
imageIndex | 0 0 |
rescaleTexCoord | FALSE |
wrapS | REPEAT |
wrapT | REPEAT |
model | MODULATE |
blendColor | 0 0 0 |
enableBorder | FALSE |
borderColor | 0 0 0 0 |
maxAnisotropy | 1.0 |
minFilter | AUTO |
magFilter | AUTO |
useAutoMipmap | FALSE |
internalFormat | AUTO_INTERNAL_FORMAT |
SoTexture2Transform, SoTextureCoordinate2,
SoTextureCoordinateFunction, SoColorMap, SoSFArray2D.
Definition at line 317 of file SoIndexedTexture2.h.
SoIndexedTexture2::SoIndexedTexture2 | ( | ) |
Constructor.
void SoIndexedTexture2::computeDataRange | ( | ) |
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoTexture.
SoSFArray2D SoIndexedTexture2::imageIndex |
This field contains the in-memory representation of the indexed texture image.
Each value of this array is a color index. In the case of float values, data must be between 0 and 1.
Definition at line 350 of file SoIndexedTexture2.h.
SoSFFloat SoIndexedTexture2::maxValue |
See minValue.
Definition at line 343 of file SoIndexedTexture2.h.
SoSFFloat SoIndexedTexture2::minValue |
Specifies the range of values which is mapped onto the color map (see SoColorMap).
When minValue and maxValue are equal to 0 (the default), the entire range of the data type is mapped onto the color map, except in the case of float data. For example, for a color map of size N:
All values less than or equal to minValue will be mapped to the first entry of the color map. Likewise, all values greater than or equal to maxValue will be mapped to the last entry of the color map.
Definition at line 338 of file SoIndexedTexture2.h.
SoSFBool SoIndexedTexture2::rescaleTexCoord |
This field controls the way an image with non-power-of-two dimension is handled:
Default is FALSE.
When this field is enabled, if other texture transforms are applied to the texture coordinates (especially if the texture is repeated), the unused part of the larger texture could be displayed. Furthermore, in this mode, if non-power-of-two textures occur one after another in the scene graph, an incorrect image may result because texture transforms are cumulative. For example, the following code would give incorrect results:
The correct way is to use a separator above each texture, as shown:
Definition at line 439 of file SoIndexedTexture2.h.
SoSFEnum SoIndexedTexture2::wrapT |
Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1.
Use enum SoTexture::Wrap. Default is REPEAT.
Definition at line 446 of file SoIndexedTexture2.h.