com.openinventor.inventor.vrmlnodes

Class SoVRMLMovieTexture

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.vrmlnodes.SoVRMLNode

com.openinventor.inventor.vrmlnodes.SoVRMLTexture

com.openinventor.inventor.vrmlnodes.SoVRMLMovieTexture

All Implemented Interfaces:

SafeDisposable

Deprecated.

As of Open Inventor 9500 See documentation for more details

public class SoVRMLMovieTexture
extends SoVRMLTexture

Texture and sound node. The SoVRMLMovieTexture node defines a time-dependent texture map (contained in a movie file) and parameters for controlling the movie and the texture mapping.

<font color="#0000FF">NOTE:</font> This class does not exist in Open Inventor 10.0 and later.

VRML97 SPECIFICATION

This section describes the expected behavior of the node in a conforming VRML97 browser application. In some cases, the application is responsible for implementing portions of the expected behavior. Open Inventor viewer classes and IVF classes implement some of the application behaviors.

This section may reference portions of the VRML97 specification that are not present in this help file. The complete VRML97 spec is available at http://www.web3d.org.

The SoVRMLMovieTexture node defines a time dependent texture map (contained in a movie file) and parameters for controlling the movie and the texture mapping. An SoVRMLMovieTexture can also be used as the source of sound data for an SoVRMLSound node, but in this special case is not used for rendering.

Texture maps are defined in a 2D coordinate system, (s,t), that ranges from 0.0 to 1.0 in both directions. The bottom edge of the image corresponds to the S-axis of the texture map, and left edge of the image corresponds to the T-axis of the texture map. The lower-left pixel of the image corresponds to s=0, t=0, and the top-right pixel of the image corresponds to s=1, t=1.

The url field that defines the movie data must support MPEG1-Systems (audio and video) or MPEG1-Video (video-only) movie file formats. See "Concepts - URLS and URNs" for details on the url field. It is recommended that implementations support grayscale or alpha transparency rendering if the specific movie format being used supports these features.

See "Concepts - Lighting Model" for details on lighting equations and the interaction between textures, materials, and geometries.

As soon as the movie is loaded, a duration_changed eventOut is sent. This indicates the duration of the movie, in seconds. This eventOut value can be read (for instance, by a Script) to determine the duration of a movie. A value of -1 implies the movie has not yet loaded or the value is unavailable for some reason.

The loop, startTime, and stopTime exposedFields and the isActive eventOut, and their affects on the SoVRMLMovieTexture node, are discussed in detail in the "Concepts - Time Dependent Nodes" section. The "cycle" of an SoVRMLMovieTexture is the length of time in seconds for one playing of the movie at the specified speed.

If an SoVRMLMovieTexture is inactive when the movie is first loaded, then frame 0 is shown in the texture if speed is nonnegative, or the last frame of the movie if speed is negative. A SoVRMLMovieTexture will always display frame 0 if speed = 0. For positive values of speed, the frame an active SoVRMLMovieTexture will display at time now corresponds to the frame at movie time (i.e., in the movie's local time system with frame 0 at time 0, at speed = 1):

    fmod (now - startTime, duration/speed)

If speed is negative, then the frame to display is the frame at movie time:

    duration + fmod(now - startTime, duration/speed)

When an SoVRMLMovieTexture becomes inactive, the frame corresponding to the time at which the SoVRMLMovieTexture became inactive will remain as the texture.

The speed exposedField indicates how fast the movie should be played. A speed of 2 indicates the movie plays twice as fast. Note that the duration_changed output is not affected by the speed exposedField. set_speed events are ignored while the movie is playing. A negative speed implies that the movie will play backwards. However, content creators should note that this may not work for streaming movies or very large movie files.

SoVRMLMovieTexture can be referenced by an SoVRMLAppearance node's texture field (as a movie texture) and by an SoVRMLSound node's source field (as an audio source only). A legal implementation of the SoVRMLMovieTexture node is not required to play audio if speed is not equal to 1.

Differences between the VSG implementation and the VRML97 specification

• If the texture coordinates are less than 0, correct mapping is not guaranteed.
• If the texture coordinates are greater than 1, the mapping is not guaranteed if the scaleTexCoord field is true.
• MPEG1-Video and MPEG2-Video (video-only, not audio) are supported.
• AVI-System (audio and video) is supported </font>.
• Video Capture system (camera...) is supported (see url field and setVideoCaptureFormat()).
• Negative speed values are not supported.
• Additional fields for controlling texture mapping (i.e., alpha, model and blendColor) and texture coordinates (scaleTexCoord) were added. Note: These new fields are not compatible with VRML97. If you set these fields to non-default values and then write a VRML file, the VRML file will not be readable by standard VRML97 readers. Older versions of Open Inventor will not be able to read the file either and will generate an Inventor read error (unknown field).

Limitations

• This node is not thread safe, so it does not work with the MultiPipe extension.

File format/default:

VRMLMovieTexture {

loop	false
speed	1
startTime	0
stopTime	0
pauseTime	0
resumeTime	0
url	[]
repeatS	true
repeatT	true
alpha	1.0
model	MODULATE
blendColor	0 0 0
scaleTexCoord	true
metadata	NULL

}

EVENTS

eventIn

SoSFBool	set_loop
SoSFFloat	set_speed
SoSFTime	set_startTime
SoSFTime	set_stopTime
SoSFTime	set_pauseTime (Note: Not implemented)
SoSFTime	set_resumeTime (Note: Not implemented)
SoMFFilePathString	set_url
SoSFNode	set_metadata

eventOut

SoSFTime	duration_changed
SoSFTime	elapsedTime (Note: Not implemented)
SoSFBool	isPaused (Note: Not implemented)
SoSFBool	isActive
SoSFBool	loop_changed
SoSFFloat	speed_changed
SoSFTime	startTime_changed
SoSFTime	stopTime_changed
SoSFTime	pauseTime_changed (Note: Not implemented)
SoSFTime	resumeTime_changed (Note: Not implemented)
SoMFFilePathString	url_changed
SoSFNode	metadata_changed

Deprecated since Open Inventor 9500
The VRML API is no longer supported. See section http://oivdoc95.vsg3d.com/content/compatibility-notes-4#Deprecation of the Reference Manual.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoVRMLMovieTexture.Models Deprecated. Model.

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

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
SoSFFloat	alpha Deprecated. Alpha value used with the video.
static int	BLEND Deprecated. Use SoVRMLMovieTexture.Models.BLEND instead.
SoSFColor	blendColor Deprecated. Color used for BLEND model.
static int	DECAL Deprecated. Use SoVRMLMovieTexture.Models.DECAL instead.
SoSFTime	duration_changed Deprecated. Output event.
SoSFTime	elapsedTime Deprecated. Output event.
SoSFBool	isActive Deprecated. Output event.
SoSFBool	isPaused Deprecated. Output event.
SoSFBool	loop Deprecated. Controls whether the movie continues when it reaches the end as defined in the movie texture file.
SoSFEnum<SoVRMLMovieTexture.Models>	model Deprecated. Specifies how to map the texture onto the surface.
static int	MODULATE Deprecated. Use SoVRMLMovieTexture.Models.MODULATE instead.
SoSFTime	pauseTime Deprecated. (Note: Not implemented) The pause time for the sound.
static int	REPLACE Deprecated. Use SoVRMLMovieTexture.Models.REPLACE instead.
SoSFTime	resumeTime Deprecated. (Note: Not implemented) The resume time for the sound.
SoSFBool	scaleTexCoord Deprecated. Boolean value which controls the way the image is mapped in case of non power-of-two video size.
SoSFFloat	speed Deprecated. Indicates how fast the movie should be played.
SoSFTime	startTime Deprecated. The starting time for the movie.
SoSFTime	stopTime Deprecated. The stopping time for the movie.
SoMFFilePathString	url Deprecated. Specifies the movie data.

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLTexture

repeatS, repeatT

Fields inherited from class com.openinventor.inventor.vrmlnodes.SoVRMLNode

metadata

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoVRMLMovieTexture() Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
void	allowPrequalifyFile(boolean name_31338) Deprecated. Sets the prequalify file flag.
void	setVideoCaptureFormat(int width, int height, int framePerSec) Deprecated. </font> In case of video capture from a video input device (see url), this method allows you to configure the video capture settings (the video size format and the video capture rate expressed in frames per second).

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

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

Methods inherited from class com.openinventor.inventor.Inventor

getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

MODULATE

@Deprecated
public static final int MODULATE

Deprecated. Use SoVRMLMovieTexture.Models.MODULATE instead.

DECAL

@Deprecated
public static final int DECAL

Deprecated. Use SoVRMLMovieTexture.Models.DECAL instead.

BLEND

@Deprecated
public static final int BLEND

Deprecated. Use SoVRMLMovieTexture.Models.BLEND instead.

REPLACE

@Deprecated
public static final int REPLACE

Deprecated. Use SoVRMLMovieTexture.Models.REPLACE instead.

loop

public final SoSFBool loop

Deprecated.

Controls whether the movie continues when it reaches the end as defined in the movie texture file. If loop is false , execution is terminated. If true, the movie restarts.

speed

public final SoSFFloat speed

Deprecated.

Indicates how fast the movie should be played.

startTime

public final SoSFTime startTime

Deprecated.

The starting time for the movie.

stopTime

public final SoSFTime stopTime

Deprecated.

The stopping time for the movie. An SoVRMLMovieTexture node with loop true at the end of every cycle continues forever if startTime>=stopTime or until stopTime if stopTime>startTime.

pauseTime

public final SoSFTime pauseTime

Deprecated.

(Note: Not implemented) The pause time for the sound. An SoVRMLAudioClip node with loop true at the end of every cycle pauses if current time >= pauseTime >resumeTime

Since:

Open Inventor 5.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

resumeTime

public final SoSFTime resumeTime

Deprecated.

(Note: Not implemented) The resume time for the sound. An SoVRMLAudioClip node with loop true at the end of every cycle pauses if current time >= resumeTime >pauseTime

Since:

Open Inventor 5.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

url

public final SoMFFilePathString url

Deprecated.

Specifies the movie data. AVI files (.avi extension) </font> allows you to capture video from a video input device such as a camera. In this case, the setVideoCaptureFormat() method allows you to specify the format you want to obtain from your video input device.

alpha

public final SoSFFloat alpha

Deprecated.

Alpha value used with the video. If the value is less than 1, the movie texture will be an RGBA image. This uses some additional memory and computation time.

Since:

Open Inventor 4.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

model

public final SoSFEnum<SoVRMLMovieTexture.Models> model

Deprecated.

Specifies how to map the texture onto the surface. Use enum Model. Default is MODULATE.

Since:

Open Inventor 4.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

blendColor

public final SoSFColor blendColor

Deprecated.

Color used for BLEND model.

Since:

Open Inventor 4.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

scaleTexCoord

public final SoSFBool scaleTexCoord

Deprecated.

Boolean value which controls the way the image is mapped in case of non power-of-two video size. OpenGL uses only power-of-two textures, so if the texture is not a power of two, it must be rescaled to the next higher power of two, which is time consuming.

• If scaleTexCoord is true (default), the video image is not rescaled but only copied the next higher power-of-two texture. Thus, this texture has some unused area. In order to map only the original part of the image, the texture coordinates are rescaled. If other texture transforms are applied to the texture coordinates (especially if the texture is repeated), the unused part (black) could be displayed.
• If scaleTexCoord is false, the video image is rescaled, which is time consuming.

Since:

Open Inventor 4.0 NOTE 2: This field is not compatible with VRML97. If you specify a non-default value for this field, when this node is written to a VRML file, the file will contain this incompatible field and standard VRML97 file readers will not be able to read it.

duration_changed

public final SoSFTime duration_changed

Deprecated.

Output event.

isActive

public final SoSFBool isActive

Deprecated.

Output event.

isPaused

public final SoSFBool isPaused

Deprecated.

Output event.

elapsedTime

public final SoSFTime elapsedTime

Deprecated.

Output event.

Constructor Detail

SoVRMLMovieTexture

public SoVRMLMovieTexture()

Deprecated.

Constructor.

Method Detail

allowPrequalifyFile

public void allowPrequalifyFile(boolean name_31338)

Deprecated.

Sets the prequalify file flag. If false, the prequalification callback will not be called. Default is true.

setVideoCaptureFormat

public void setVideoCaptureFormat(int width,
                                  int height,
                                  int framePerSec)

Deprecated.

</font> In case of video capture from a video input device (see url), this method allows you to configure the video capture settings (the video size format and the video capture rate expressed in frames per second). If no format is specified, the size and frame rate will be the last used by the capture device. Because video size formats are device specific, the requested size may not be available and a default size will be used instead.