read_movie_apply_offset

Synopsis

Reads in an offset file and applies the offset vectors to the coordinates of the input field data.

Input Ports

Name Type Description

in Mesh+Node_Data field data representing the input BYU model.
scale float scale factor for the offset vectors.

Parameters

The following lists all of the parameters found in the parameter block ReadMovieOffsetParams, which are accessed by the module ReadMovieOffsetFile and the UI Macro ReadMovieOffsetUI.

Name Type Description UI Control

filename string Offset file to be read 'Read MOVIE-BYU Offset File Name'

Output Ports

Name Type Description

out Mesh+Node_Data field data representing the offset BYU model.
obj DataObject directly renderable offset output object.

Description

read_movie_apply_offset reads in an offset file and generates both field data and renderable Data Objects offset by the specified amount. The offset file is an ASCII file which should consist of a series of 3D vectors that represent the offset to be applied to the respective coordinate in the field data input to the module. The file format can be seen in the supplied example files, cube001 to cube008. The offset file to be read can be specified through a simple user interface.

Input Ports

in

The field data that the offset is to be applied to. The type of this field is Mesh+Node_Data

scale

The factor by which the offsets from the offset file are scaled by. The type of this field is float. It should be noted that only the offset vectors are scaled, the original data is not scaled by this parameter.

Parameters

filename

A member of the ReadMovieOffsetParams parameter block group, this string value is used to specify the name of the offset file that should be applied to the input field data.

Output Ports

out

The most primitive output field of the read_movie_apply_offset macro. This contains the model read from the BYU file represented as field data, offset by the amount specified in the offset file.

obj

The directly renderable output field of the read_movie_byu macro. This contains a DataObject object that can be rendered by the standard data viewers. The Data Object is generated from the input field data, after being offset by the amount specified in the offset file.

Utility Macros

This user macro uses the general user macro, read_movie_offset and adds the functionality required for the macro to act as a section in the visualization pipeline. The read_movie_offset macro in turn makes use of the functional macro ReadMovieOffset, which uses the low level modules ReadMovieOffsetFile and ReadMovieBYUApplyOffset.

Example

An example application ReadMovieBYUEg is provided, which uses the read_movie_byu macro to load a BYU file that is then animated by the read_movie_animate macro.

Files

iac_proj/rdmovbyu/rdmbmacs.v contains the read_movie_apply_offset User Macro, the ReadMovieOffset Functional Macro, the ReadMovieOffsetUI UI Macro, and the example application ReadMovieBYUEg V definitions. The file also contains several other macro definitions.

Other Notes

The ReadMovieBYUMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level ReadMovieOffsetFile module, executes under the process specified in its library, not the process defined in the high-level library.

Authors

Ian Curington
Paul G. Lever
Andrew Dodd

Contact

International AVS Centre
Manchester Visualization Centre
Manchester Computing
University of Manchester
Oxford Road
Manchester
United Kingdom
M13 9PL

See Also

ReadMovieOffsetParams, ReadMovieOffsetUI, ReadMovieOffset, ReadMovieBYUApplyOffset and ReadMovieOffsetFile.