Click or drag to resize
SoVRMLMovieTexture Class

Note: This API is now obsolete.

Texture and sound node.

Inheritance Hierarchy

Namespace: OIV.Inventor.VRMLnodes
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)
Syntax
[EditorBrowsableAttribute(EditorBrowsableState.Never)]
[ObsoleteAttribute("See documentation for more details")]
public class SoVRMLMovieTexture : SoVRMLTexture

The SoVRMLMovieTexture type exposes the following members.

Constructors
  NameDescription
Public methodSoVRMLMovieTexture

Constructor.

Top
Methods
  NameDescription
Public methodAffectsState

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

(Inherited from SoNode.)
Public methodAllowPrequalifyFile

Sets the prequalify file flag.

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

(Inherited from SoNode.)
Public methodIsSynchronizable

Gets the ScaleViz synchronizable state of this object.

(Inherited from SoBase.)
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 methodStatic memberSetMoviePrequalifyFileCallback(SoVRMLMovieTextureMoviePrequalifyFileCallback) Obsolete.
Use PrequalifyFileCallBack property instead. Specifies the delegate that will be invoked when the MovieTexture node is about to read an image file (if the prequalify flag is true).
Public methodStatic memberSetMoviePrequalifyFileCallback(SoVRMLMovieTextureMoviePrequalifyFileUserDataCallback, Object) Obsolete.
Use PrequalifyFileCallBack property instead.
Public methodSetName (Inherited from SoBase.)
Public methodSetOverride

Turns the override flag on or off.

(Inherited from SoNode.)
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 methodSetVideoCaptureFormat

<font color="#0000FF">[Windows only]</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).

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 propertyalpha

Alpha value used with the video.

Public propertyblendColor

Color used for BLEND model.

Public propertyduration_changed

Output event.

Public propertyelapsedTime

Output event.

Public propertyisActive

Output event.

Public propertyIsDisposable
ISafeDisposable interface implementation.
(Inherited from SoDisposable.)
Public propertyisPaused

Output event.

Public propertyloop

Controls whether the movie continues when it reaches the end as defined in the movie texture file.

Public propertymetadata

Specifies the metadata node.

(Inherited from SoVRMLNode.)
Public propertymodel

Specifies how to map the texture onto the surface.

Public propertypauseTime

(Note: Not implemented) The pause time for the sound.

Public propertyStatic memberPrequalifyFileCallBack

Specifies the application callback that will be invoked when the MovieTexture node is about to read an image file (if the prequalify flag is true).

Public propertyrepeatS
(Inherited from SoVRMLTexture.)
Public propertyrepeatT

The repeatS and repeatT fields specify how the texture wraps in the S and T directions.

(Inherited from SoVRMLTexture.)
Public propertyresumeTime

(Note: Not implemented) The resume time for the sound.

Public propertyscaleTexCoord

Boolean value which controls the way the image is mapped in case of non power-of-two video size.

Public propertyspeed

Indicates how fast the movie should be played.

Public propertystartTime

The starting time for the movie.

Public propertystopTime

The stopping time for the movie.

Public propertyurl

Specifies the movie data.

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

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   <b><font color=#0000FF>[Windows only]</font></b>.

- 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

SoSFBoolset_loop
SoSFFloatset_speed
SoSFTimeset_startTime
SoSFTimeset_stopTime
SoSFTimeset_pauseTime (Note: Not implemented)
SoSFTimeset_resumeTime (Note: Not implemented)
SoMFFilePathStringset_url
SoSFNodeset_metadata

eventOut

SoSFTimeduration_changed
SoSFTimeelapsedTime (Note: Not implemented)
SoSFBoolisPaused (Note: Not implemented)
SoSFBoolisActive
SoSFBoolloop_changed
SoSFFloatspeed_changed
SoSFTimestartTime_changed
SoSFTimestopTime_changed
SoSFTimepauseTime_changed (Note: Not implemented)
SoSFTimeresumeTime_changed (Note: Not implemented)
SoMFFilePathStringurl_changed
SoSFNodemetadata_changed
Obsoletesince 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.

See Also