Click or drag to resize
SoTexture2 Class

2D texture mapping node.

Inheritance Hierarchy

Namespace: OIV.Inventor.Nodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 2024.2.0.0 (2024.2.0)
Syntax
public class SoTexture2 : SoTexture

The SoTexture2 type exposes the following members.

Constructors
  NameDescription
Public methodSoTexture2

Creates a texture node with default settings.

Top
Methods
  NameDescription
Public methodAffectsState

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

(Inherited from SoNode.)
Public methodAllowPrequalifyFile
Public methodCallback
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
Public methodDoActionOnRTT
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 methodGetBitmapFileType

Gets the texture file format.

(Inherited from SoTexture.)
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 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
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 methodIsAllowPrequalifyFile
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 field.

(Inherited from SoTexture.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
Public methodLoadTexture

Loads the texture if the OIV.Inventor.Nodes.SoTexture2.loadingMode field is set to MANUAL.

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 methodSetBitmapFileType

Sets the texture file format.

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

Set the state of the override field.

(Inherited from SoTexture.)
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 propertyblendColor

Color used for BLEND model.

(Inherited from SoTexture.)
Public propertyborderColor

Defines border color used for border texture filtering.

(Inherited from SoTexture.)
Public propertyenableBorder

Enables borders for textures.

(Inherited from SoTexture.)
Public propertyenableCompressedTexture

Enables storage of textures on the graphics board in compressed form.

(Inherited from SoTexture.)
Public propertyfilename

Name of the file from which to read texture image.

Public propertyFinishLoadingCallback

Callback invoked when the texture is loaded and ready to use.

Public propertyimage

Contains an in-memory representation of the texture map.

Public propertyinternalFormat

Internal format for texture storage.

(Inherited from SoTexture.)
Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyloadingMode

Specifies the loading mode.

Public propertymagFilter

Specifies the OpenGL magFilter.

(Inherited from SoTexture.)
Public propertymaxAnisotropy

Specifies on a per-texture object basis, the maximum degree of anisotropy to account for in texture filtering.

(Inherited from SoTexture.)
Public propertyminFilter

Specifies the OpenGL minFilter.

(Inherited from SoTexture.)
Public propertymodel

Specifies how to map texture onto surface.

(Inherited from SoTexture.)
Public propertyStatic memberPrequalifyFileCallback
Public propertyrenderToTextureProperty

Specifies an OIV.Inventor.Nodes.SoRenderToTextureProperty node containing a scene graph that will be rendered to create the texture image.

Public propertyStartLoadingCallback

Callback invoked when starting to load the texture.

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

Indicates what to do when texture coordinates in the S (horizontal) direction lie outside the range 0-1.

(Inherited from SoTexture.)
Public propertywrapT

Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1.

Top
Remarks

This property node defines a texture map and parameters for that map. This map applies to the current texture unit (see OIV.Inventor.Nodes.SoTextureUnit) and is used to apply texture to subsequent shapes as they are rendered. The image may be loaded from a file, loaded from an image in memory or created by rendering a scene graph.

Loading an image

The texture can be read from a file specified in the OIV.Inventor.Nodes.SoTexture2.filename field. Open Inventor supports most common file formats including: BMP, DDS, GIF, JPEG, PNG and TIFF. See OIV.Inventor.Image.SoRasterImageRW for a complete list. If Open Inventor recognizes the extension part of the file name, for example "png" for a PNG format image, it will automatically use the corresponding image reader (OIV.Inventor.Image.SoPNGImageRW). If the file extension is not recognized, Open Inventor will attempt to determine the actual image file format by opening the file with each of the built-in image file reader classes.

Note that the image file is read immediately when the filename field is set. If you want to postpone the texture loading, set the OIV.Inventor.Nodes.SoTexture2.loadingMode field to OIV.Inventor.Nodes.SoTexture2.Loadings.MANUAL before setting the OIV.Inventor.Nodes.SoTexture2.filename field. In this case, you must call OIV.Inventor.Nodes.SoTexture2.LoadTexture() to load and display the texture. Alternatively, consider using OIV.Inventor.Nodes.SoExtTexture2, which defers loading the image until the texture node is actually traversed.

Once the texture has been read, the OIV.Inventor.Nodes.SoTexture2.image 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 OIV.Inventor.Nodes.SoTexture2.filename field to an empty string ("").

DDS format files load faster because the compressed image can be sent directly to the graphics hardware. This format can also embed mipmaps (levels of resolution). Note that the OIV.Inventor.Nodes.SoTexture2.image field is not filled with the image data when using DDS files. DDS format is not supported on all hardware. The GL_EXT_texture_compression_s3tc extension is required. If it is not available, the DDS texture is not loaded.

Textures can also be specified in memory by setting the OIV.Inventor.Nodes.SoTexture2.image field to contain the texture data. Doing so resets the OIV.Inventor.Nodes.SoTexture2.filename to the empty string.

Textures can also be rendered from a scene graph using the OIV.Inventor.Nodes.SoTexture2.renderToTextureProperty field. If a value is specified for this field, the OIV.Inventor.Nodes.SoTexture2.image and OIV.Inventor.Nodes.SoTexture2.filename fields are ignored.

Modifying a texture image

You can modify a subset of the image without causing the OpenGL texture to be recreated. Open Inventor will automatically use glTexSubImage2D if the image is modified using the () method. This is much more efficient than using the startEditing and finishEditing methods because when these methods are used Open Inventor must assume that the entire image has been modified.

Texture quality

The OIV.Inventor.Nodes.SoTexture.minFilter and OIV.Inventor.Nodes.SoTexture.magFilter fields can be used to specifically control the texture minification and magnification "filter" algorithms used by the GPU. The minification filter is used when the rendered size of the geometry is smaller than the texture image (for example: far away objects). Conversely the magnification filter is used when the rendered size of the geometry is larger than the texture image (near objects). Effectively these settings control whether the GPU will select the "nearest" texel value or do linear interpolation (smoothing) or (in the case of minification) interpolate between mipmap levels. Using NEAREST may allow better performance, but the LINEAR options produce much higher quality rendering. If mipmap filtering is required, mipmaps are automatically created.

NOTE: The default value for these OIV.Inventor.Nodes.SoTexture fields is AUTO, meaning that the minification and magnification algorithms are actually controlled by the OIV.Inventor.Nodes.SoComplexity.textureQuality field. To maximize performance, the default value for textureQuality is 0.5, which selects NEAREST filtering. For best image quality we recommend setting this field to (at least) 0.75.

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).

Non-power-of-two images

If the texture image's width or height is not a power of 2, e.g. 128 or 256, and the Non Power Of Two (NPOT) extension is available on your graphics board, by default Open Inventor will send the image to OpenGL without modification. Almost all modern graphics hardware support this extension (check using SoTexture.isSupported(HW_NPOT)). However if your application must run on graphics hardware that does not support NPOT, please read the following.

If the texture image's width or height is not a power of 2 (and the Non Power Of Two (NPOT) extension is not available on your graphics board), or the image's width or height is greater than the maximum supported by OpenGL, then the image will be automatically scaled up or down to the nearest power of 2 or the maximum texture size. For maximum speed, point-sampling is used to do the scaling. If you want higher quality scaling, pre-filter your images to a power of 2 smaller than the maximum texture size. Use the OpenGL glGetIntegerv(GL_MAX_TEXTURE_SIZE...) call to determine the maximum texture dimension for a specific OpenGL implementation. Setting the environment variable OIV_USE_NPOT to 0 will force the image to be rescaled (when necessary) even if the NPOT extension is available.

Performance Note: Automatic scaling of texture images to a power of 2 is a very convenient feature for prototyping, but it does take additional time the first time the texture node is traversed for rendering. For large images, or a large number of images, this can make the application seem slow while starting up or loading a new data file. Avoid this effect by either pre-scaling the image or by storing it as a sub-image in a "power of 2" image (then provide explicit texture coordinates such that only the sub-image is used). (Not applicable if GPU supports non-power-of-2 images. Most do.)

Performance Note: The performance advantage of modifying a sub-image is significantly less when the texture image needs to be automatically scaled to a power of 2. This is because each sub-image must be scaled before sending it to OpenGL. (Not applicable if GPU supports non-power-of-2 images. Most do.)

FILE FORMAT/DEFAULT

Texture2 {
filename ""
image 0 0 0
wrapS REPEAT
wrapT REPEAT
model MODULATE
enableCompressedTexture false
blendColor 0 0 0
enableBorder false
borderColor 0 0 0 1
maxAnisotropy 1.0
minFilter AUTO
magFilter AUTO
loadingMode AUTO
useAutoMipmap false
internalFormat AUTO_INTERNAL_FORMAT
renderToTextureProperty NULL
}

ACTION BEHAVIOR

OIV.Inventor.Actions.SoGLRenderAction, OIV.Inventor.Actions.SoCallbackAction Sets current texture in state. Sets: OIV.Inventor.Elements.SoTextureImageElement, OIV.Inventor.Elements.SoTextureEnabledElement

See Also