com.openinventor.inventor.nodes

Class SoExtTexture2

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

com.openinventor.inventor.nodes.SoExtTexture2

All Implemented Interfaces:

SafeDisposable

public class SoExtTexture2
extends SoTexture

Extended texture mapping node. This property node defines a texture map and parameters for that map. This map is used to apply texture to subsequent shapes as they are rendered.

The node is similar to SoTexture2, but differs in the following significant ways:

1. It has no image field.
2. It doesn't load the texture image into system memory until the node is traversed. Depending on the scene graph, this may significantly reduce the use of system memory, e.g., if the scene has lots of LODs containing textures. On the other hand, when the scene graph is first traversed there may be a small delay while the textures are being loaded.
3. It has additional features (e.g., support for OpenGL paletted textures) for reducing the use of texture memory.

The texture is read from the file specified by the filename field. There is no image field created. Data is sent directly to OpenGL.

The maximum system memory allowed for all SoExtTexture2 nodes (in total) can be set using setMemorySpace().

If the memory allowed for texture images (setMemorySpace()) would be exceeded by loading a new image, one or more existing images will be deleted from system memory. In most cases OpenGL texture objects will already have been created for the deleted images (i.e. OpenGL has a copy of the images), so this does not affect rendering.

If it is necessary to recreate an OpenGL texture object and the required texture image has been deleted from system memory, the node will automatically re-read the image file. For this reason, applications should be careful not to remove image files that might be needed during program execution.

To reduce the use of texture memory (by approximately a factor of 4), use the useTexturePalette() method to request the image be converted to a 256-color paletted image. This feature is available only if the driver supports the GL_EXT_paletted_texture or GL_EXT_texture_color_table extension.

If the texture image's width or height is not a power of 2, 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. However, 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.

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 platform dependent, and varies based on the texturing performance. If mipmap filtering is required, mipmaps are automatically created using a simple box filter.

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

File format/default:

ExtTexture2 {

filename	""
enableCompressedTexture	false
wrapS	REPEAT
wrapT	REPEAT
model	MODULATE
blendColor	0 0 0
loadingStatus	false
syncMode	SYNCHRONOUS
loadingMode	AUTO
loadingThreadPriorty	1
enableBorder	false
borderColor	0 0 0 0
maxAnisotropy	1.0
minFilter	AUTO
magFilter	AUTO
useAutoMipmap	false
internalFormat	AUTO_INTERNAL_FORMAT

}

Action behavior:

SoGLRenderAction, SoCallbackAction
Sets current texture in state. Sets: SoTextureImageElement

See also:

SoTexture2, SoComplexity, SoMaterial, SoTexture2Transform, SoTextureCoordinate2, SoTextureCoordinateBinding, SoTextureCoordinateFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoExtTexture2.ImageSize
static class	SoExtTexture2.Loadings Loading mode.
static class	SoExtTexture2.Syncs Synchrone/asynchrone loading mode.

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoTexture

SoTexture.FileTypes, SoTexture.Filters, SoTexture.HW_Features, SoTexture.InternalFormats, SoTexture.Models, SoTexture.WrapType

Nested classes/interfaces inherited from class com.openinventor.inventor.nodes.SoNode

SoNode.RenderModes

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFilePathString	filename Names file from which to read texture image.
SoSFEnum<SoExtTexture2.Loadings>	loadingMode Specifies the loading mode.
SoSFBool	loadingStatus Tells if the texture is loaded or not (not necessarily displayed)
SoSFInt32	loadingThreadPriority Specifies the priority of the texture loading thread when activated (syncMode = ASYNCHRONOUS).
SoSFEnum<SoExtTexture2.Syncs>	syncMode Specifies the synchronous/asynchronous mode.
SoSFEnum<SoTexture.WrapType>	wrapT Indicates what to do when texture coordinates in the T (vertical) direction lie outside the range 0-1.

Fields inherited from class com.openinventor.inventor.nodes.SoTexture

blendColor, borderColor, enableBorder, enableCompressedTexture, internalFormat, magFilter, maxAnisotropy, minFilter, model, wrapS

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoExtTexture2() Creates a texture node with default settings.

Method Summary

Modifier and Type	Method and Description
void	allowPrequalifyFile(boolean name_11583) If true, allows the PrequalifyFile callback to be called.
static double	getGlobalMemoryUsed() Return the current system memory used by all texture images.
SoExtTexture2.ImageSize	getImageSize() Returns the size and the number of components in the image.
static double	getMemorySpace() Gets the system memory space allowed for the texture images.
void	loadTexture() Loads the texture if the loading mode is set to MANUAL.
static void	setMemorySpace(double megaBytes) Sets the system memory space allowed for the texture images.
static void	useTexturePalette(boolean value) If true, uses a 256-color-indexed palette.

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

getBitmapFileType, isSupported, readTexture, readTexture, setBitmapFileType

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

affectsState, callback, copy, copy, distribute, doAction, getAlternateRep, getBoundingBox, getByName, getMatrix, getPrimitiveCount, getRenderEngineMode, 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, getName, isDisposable, isSynchronizable, setName, setSynchronizable

Methods inherited from class com.openinventor.inventor.Inventor

getNativeResourceHandle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

filename

public final SoSFFilePathString filename

Names file from which to read texture image. 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 SoTexture2 node was read. For example, if an SoTexture2 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).

wrapT

public final SoSFEnum<SoTexture.WrapType> wrapT

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

loadingStatus

public final SoSFBool loadingStatus

Tells if the texture is loaded or not (not necessarily displayed)

syncMode

public final SoSFEnum<SoExtTexture2.Syncs> syncMode

Specifies the synchronous/asynchronous mode. . Default is SYNCHRONOUS.

loadingMode

public final SoSFEnum<SoExtTexture2.Loadings> loadingMode

Specifies the loading mode. . Default is AUTO.

loadingThreadPriority

public final SoSFInt32 loadingThreadPriority

Specifies the priority of the texture loading thread when activated (syncMode = ASYNCHRONOUS). This part uses the SbThread class.

Constructor Detail

SoExtTexture2

public SoExtTexture2()

Creates a texture node with default settings.

Method Detail

getImageSize

public SoExtTexture2.ImageSize getImageSize()

Returns the size and the number of components in the image.

setMemorySpace

public static void setMemorySpace(double megaBytes)

Sets the system memory space allowed for the texture images. This value is specified in megabytes (MB). The default is 16 MB.

getMemorySpace

public static double getMemorySpace()

Gets the system memory space allowed for the texture images. This value is specified in megabytes (MB).

allowPrequalifyFile

public void allowPrequalifyFile(boolean name_11583)

If true, allows the PrequalifyFile callback to be called.

loadTexture

public void loadTexture()

Loads the texture if the loading mode is set to MANUAL.

getGlobalMemoryUsed

public static double getGlobalMemoryUsed()

Return the current system memory used by all texture images.

useTexturePalette

public static void useTexturePalette(boolean value)

If true, uses a 256-color-indexed palette. You must call this method before the textures are loaded. Default is false.
NOTE: If the field enableCompressedTexture is set true, its value takes precedence over this request to use a paletted texture. Compressed textures will be used.