|
Open Inventor Release 2024.2.0
|
|
| |
|
Open Inventor Release 2024.2.0
|
|
|
| |
3D texture mapping node.
More...
#include <Inventor/nodes/SoTexture3.h>
Inheritance diagram for SoTexture3:Public Member Functions | |
| virtual SoType | getTypeId () const |
| Returns the type identifier for this specific instance. | |
| SoTexture3 () | |
| Creates a texture node with default settings. | |
| 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 | |
| SoMFFilePathString | filenames |
| Names of file(s) from which to read texture image(s). | |
| SoSFImage3 | images |
| Contains an in-memory representation of the texture map. | |
| SoSFEnum | wrapT |
| Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1. | |
| SoSFEnum | wrapR |
| Indicates what to do when texture coordinates in the R (depth) direction lie outside the range 0-1. | |
| SoSFEnum | layout |
| Indicates whether the data layout is a volumetric texture VOLUME or an array of bi-dimensional textures ARRAY. | |
| 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. | |
Friends | |
| class | SoGLTextureImage3Element |
3D texture mapping node.
This property node defines a 3D texture map and parameters for that map. This map is used to apply a 3D texture to subsequent shapes as they are rendered.
The texture can be read from the file(s) specified by the filenames field. Once the texture has been read, the images field contains the texture data. However, this field is marked so the image is not written out when the texture node is written to a file. To turn off texturing, set the first value of the filenames field to an empty string ("").
Textures can also be specified in memory by setting the images field to contain the texture data. Doing so resets the filenames field to the empty string.
Simply put, a 3D texture is a set of well-arranged 2D textures. Typically, 3D textures represent a set of image-slices of a given volume of data, and are used for mapping onto pieces of geometry. Note that this is different from direct volume rendering in that 3D textures need to be mapped onto a piece of geometry.
OpenGL requires all images in a 3D texture to have the same dimensions, and each dimension (X, Y, and Z) needs to be a power of 2. Also, images must have the same number of components (grayscale, grayscale with transparency, RGB, or RGB with transparency).
You should take this into account when setting texture coordinates. If your 3D image is not correctly dimensioned, you may want to consider either applying a ratio to your coordinates or adding an SoTexture3Transform node with the field scaleFactor set to compensate.
The quality of the texturing is affected by the textureQuality field of the SoComplexity node. The textureQuality field affects what kind of filtering is done to the texture when it must be minified or magnified. The mapping of a particular texture quality value to a particular OpenGL filtering technique is implementation dependent, and varies based on the texturing performance. If mipmap filtering is required, mipmaps are automatically created using the simple box filter.
Transparency Texture images can contain transparency (alpha values less than 1) and modify the transparency of geometry in the scene. Also note that some image file formats, for example JPEG, do not support transparency information (alpha channel).
LIMITATIONS
3D textures are only supported by the following shapes:
Only SoIndexedFaceSet shapes automatically compute texture coordinates if they are not specified either by a texture coordinate function (see SoTextureCoordinateFunction) or by explicit texture coordinates (see SoTextureCoordinate3).
| filenames | "" |
| enableCompressedTexture | FALSE |
| images | 0 0 0 0 |
| wrapS | REPEAT |
| wrapT | REPEAT |
| wrapR | REPEAT |
| model | MODULATE |
| blendColor | 0 0 0 |
| enableBorder | FALSE |
| borderColor | 0 0 0 1 |
| maxAnisotropy | 1.0 |
| minFilter | AUTO |
| magFilter | AUTO |
| useAutoMipmap | FALSE |
| internalFormat | AUTO_INTERNAL_FORMAT |
| layout | VOLUME |
SoComplexity, SoMaterial, SoTextureCoordinate3, SoTextureCoordinateBinding, SoTextureCoordinateFunction
Definition at line 173 of file SoTexture3.h.
| enum SoTexture3::Layout |
Texture layout.
| Enumerator | |
|---|---|
| VOLUME | The texture layout is a volumetric texture. |
| ARRAY | The texture layout is an array of bi-dimensional textures. |
Definition at line 182 of file SoTexture3.h.
| SoTexture3::SoTexture3 | ( | ) |
Creates a texture node with default settings.
|
static |
Returns the type identifier for this class.
|
virtual |
Returns the type identifier for this specific instance.
Reimplemented from SoTexture.
|
friend |
Definition at line 276 of file SoTexture3.h.
| SoMFFilePathString SoTexture3::filenames |
Names of file(s) from which to read texture image(s).
The standard image file formats are supported. See SoRasterImageRW for the list. If the filename is not an absolute path name, the list of directories maintained by SoInput is searched. If the texture is not found in any of those directories, then the file is searched for relative to the directory from which the SoTexture3 node was read. For example, if an SoTexture3 node with a filename of "../tofu.rgb" is read from /usr/people/bob/models/food.iv, then /usr/people/bob/tofu.rgb will be read (assuming tofu.rgb isn't found in the directories maintained by SoInput).
All images must have the same dimensions and number of components. Depth (number of slices) is determined by the number of file names.
Note that only 2D image file formats are currently supported. A 3D texture image can be read as a series of 2D image files.
Definition at line 213 of file SoTexture3.h.
| SoSFImage3 SoTexture3::images |
Contains an in-memory representation of the texture map.
It is either the contents of the file(s) read from filenames, an image read directly from an Open Inventor file, or an image set programmatically using the methods provided by SoSFImage3.
Definition at line 222 of file SoTexture3.h.
| SoSFEnum SoTexture3::layout |
Indicates whether the data layout is a volumetric texture VOLUME or an array of bi-dimensional textures ARRAY.
Use enum SoTexture3::Layout. Default is VOLUME.
Note that if you use a SoTexture3 with a SoShaderProgram, the layout value affects the type of sampler in GLSL: if the layout value is VOLUME, the sampler type is sampler3D; if the layout value is ARRAY, the sampler type is sampler2DArray.
NOTE: field available since Open Inventor 9.6
Definition at line 250 of file SoTexture3.h.
| SoSFEnum SoTexture3::wrapR |
Indicates what to do when texture coordinates in the R (depth) direction lie outside the range 0-1.
Use enum SoTexture::Wrap. Default is REPEAT.
Definition at line 236 of file SoTexture3.h.
| SoSFEnum SoTexture3::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 229 of file SoTexture3.h.
1.9.8 