SoVRMLMovieTexture Class |
Note: This API is now obsolete.
Texture and sound node.
Namespace: OIV.Inventor.VRMLnodes
The SoVRMLMovieTexture type exposes the following members.
Name | Description | |
---|---|---|
![]() | SoVRMLMovieTexture | Constructor. |
Name | Description | |
---|---|---|
![]() | AffectsState | Returns true if a node has an effect on the state during traversal. |
![]() | AllowPrequalifyFile | Sets the prequalify file flag. |
![]() | Callback | (Inherited from SoNode.) |
![]() | Copy | Calls Copy(false). (Inherited from SoNode.) |
![]() | Copy(Boolean) | Creates and returns an exact copy of the node. |
![]() | CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
![]() | CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
![]() | Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
![]() | Distribute | (Inherited from SoNode.) |
![]() | DoAction | (Inherited from SoNode.) |
![]() | EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
![]() | Equals | (Inherited from Object.) |
![]() | FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
![]() | Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
![]() | GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
![]() | GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
![]() | GetBoundingBox | (Inherited from SoNode.) |
![]() | GetEventIn | Returns a the eventIn with the given name. |
![]() | GetEventOut | Returns the eventOut with the given name. |
![]() | GetField | Returns a the field of this object whose name is fieldName. |
![]() | GetFieldName | Returns the name of the given field in the fieldName argument. |
![]() | GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
![]() | GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
![]() | GetMatrix | (Inherited from SoNode.) |
![]() | GetName | Returns the name of an instance. |
![]() | GetPrimitiveCount | (Inherited from SoNode.) |
![]() | GetRenderUnitID | (Inherited from SoNode.) |
![]() | GetStringName | (Inherited from SoBase.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GLRender | (Overrides SoVRMLTextureGLRender(SoGLRenderAction).) |
![]() | GLRenderBelowPath | (Inherited from SoNode.) |
![]() | GLRenderInPath | (Inherited from SoNode.) |
![]() | GLRenderOffPath | (Inherited from SoNode.) |
![]() | GrabEventsCleanup | (Inherited from SoNode.) |
![]() | GrabEventsSetup | (Inherited from SoNode.) |
![]() | HandleEvent | (Inherited from SoNode.) |
![]() | HasDefaultValues | Returns true if all of the object's fields have their default values. |
![]() | IsBoundingBoxIgnoring | 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. |
![]() | IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
![]() | IsOverride | Returns the state of the override flag. |
![]() | IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
![]() | Pick | (Inherited from SoNode.) |
![]() | RayPick | (Inherited from SoNode.) |
![]() | Search | (Inherited from SoNode.) |
![]() | Set | 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. |
![]() ![]() | SetMoviePrequalifyFileCallback(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).
|
![]() ![]() | SetMoviePrequalifyFileCallback(SoVRMLMovieTextureMoviePrequalifyFileUserDataCallback, Object) | Obsolete.
Use PrequalifyFileCallBack property instead.
|
![]() | SetName | (Inherited from SoBase.) |
![]() | SetOverride | Turns the override flag on or off. |
![]() | SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
![]() | SetToDefaults | Sets all fields in this object to their default values. |
![]() | SetVideoCaptureFormat | <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). |
![]() | ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
![]() | Touch | Marks an instance as modified, simulating a change to it. |
![]() | Write | (Inherited from SoNode.) |
Name | Description | |
---|---|---|
![]() | alpha | Alpha value used with the video. |
![]() | blendColor | Color used for BLEND model. |
![]() | duration_changed | Output event. |
![]() | elapsedTime | Output event. |
![]() | isActive | Output event. |
![]() | IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
![]() | isPaused | Output event. |
![]() | loop | Controls whether the movie continues when it reaches the end as defined in the movie texture file. |
![]() | metadata | Specifies the metadata node. |
![]() | model | Specifies how to map the texture onto the surface. |
![]() | pauseTime | (Note: Not implemented) The pause time for the sound. |
![]() ![]() | PrequalifyFileCallBack | 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). |
![]() | repeatS | (Inherited from SoVRMLTexture.) |
![]() | repeatT | The repeatS and repeatT fields specify how the texture wraps in the S and T directions. |
![]() | resumeTime | (Note: Not implemented) The resume time for the sound. |
![]() | scaleTexCoord | Boolean value which controls the way the image is mapped in case of non power-of-two video size. |
![]() | speed | Indicates how fast the movie should be played. |
![]() | startTime | The starting time for the movie. |
![]() | stopTime | The stopping time for the movie. |
![]() | url | Specifies the movie data. |
![]() | UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
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.
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.
- 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).
This node is not thread safe, so it does not work with the MultiPipe extension.
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 |
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 |
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 |