Content-type: text/html Manpage of meteor

meteor

Section: Meteor Manual Page (1)
Updated: 25 Feb 2007
Index Return to Main Contents

NAME

meteor - Meteor mesh generation tool

SYNOPSIS

meteor [options] [input file]

DESCRIPTION

meteor is a utility to generate, simplify, and display triangle meshes. meteor generates meshes by evaluating functions of the form f(x, y, z) = 0.

INFORMATION OPTIONS

-h, --help: display usage message
--keys: display information about keys at runtime
-v, --verbose: print additional information to the console at runtime
--version: print version information and exit

FILE OPTIONS

-c, --create [FILE]: Generate an output file of mesh data that can later be read in with the --file option. The file will include vertex data, and optionally normal, color, and texture data. For a detailed description of formats see meshSave (3)
-f, --file [FILE]: Read mesh data from a file created by --create instead of generating it. With this option an input source file or equation parameter is not used.
--input-format [FORMAT]: specify a format of 'help' to list supported formats
--output-format [FORMAT]: specify a format of 'help' to list supported formats

GENERATION OPTIONS

-a, --animate: Run meteor in animation mode, the input source file should define a function named update which is invoked after each frame is built.
-e, --equation: Specify an equation instead of using an input source file. This is useful for simple tests, if no = is used, it assumed = 0. eg: -ex*x+y*y+z*z=.5
-s, --step step size: Specify the step size to use, default .05 A smaller step size produces more triangles at the expense of longer run time.
-[xyz]: Specify the bounds for x, y, or z axis, the default is -1,1. eg: "-x -5,5"
--max-frames [NUM]: When --animate is specified, abort after NUM frames have been generated.
--max-triangles [NUM]: Specify the maximum number of triangles in the mesh while building, this value can be used to allow processing of much larger meshes than would fit in ram as the mesh is contracted while being built. For the best results, NUM should be set higher than the desired final count, and --triangles performs merge operations at the end to bring the count down.

SIMPLIFICATION OPTIONS

-t, --triangles [NUM]

contract edges to get as close as possible to NUM triangles

-j, --aggregation [NUM]

Run the aggregation algorithm on the mesh, merging the closest points together until there are not more than NUM points remaining.

--clip [EQUATION]

Remove any data that is under the specified equation

--correct-texcoords

generate multiple points in the same location attempting to correct texture mapping errors, for an example, from the src dir:

meteor models/earth.c --texture models/earth.png --correct-texcoords

-r, --propagate [ITERS]

After the mesh is simplified by merging points, the resulting vertexes will be slightly away from the surface, this step will propagate those vertexes toward the surface along their normal. Larger iterations produce better results with diminishing returns.

TRANSFORMATION OPTIONS

--rotate [angle,x,y,z]: Rotate all points and normals by angle in degrees around the vector <x,y,z>
--translate [x,y,z]: Translate all points by the vector <x,y,z>
--scale [x,y,z]: Scale the position of each point by the vector <x,y,z>

DISPLAY OPTIONS

-k, --keypress [KEY]: Pass a keyboard input to the program at startup, this is the same as not using this option, then pressing key when in glut display mode, but can be the only way to modify display parameters in osmesa mode. For example -kl will start up in wireframe mode. See KEYS.
-o, --no-normals: Do not generate or calculate normals or use lighting when displaying.
-n, --no-display: Do not display, it is still possible to generate mesh data and output to a file, or benchmark in this mode, it does not require opengl.
--texture [FILE]: Use image file for displaying the texture. Right now the only supported format is png.
--3D-texture [FILE]: Same as --texture, but instead creates a spherical 3d texture.
--osmesa [FILE]: This option only works if compiled with OSMesa support. Instead of displaying the mesh, a file is generated intead. If --animate is not specified, then the output file will be png, otherwise it is a video based on the extension (.mp4 and .avi are known to work). See --geometry to specify the size.
-g, --geometry WxH: Specify default size hint, if this option is not used, 640x480 will be used.
--loop: When displaying animations from a file, this option will cause the animation to loop repeatedly rather than stop on the last mesh

INPUT FILE

The input file is a c source file specifying various functions with c-linkage:
        init -- Called once at startup
        func -- Mesh generation function
        normal -- Normal function
        color -- Color function
        texcoord -- Texcoord function
        update -- called after each frame is built in animation mode
        clip -- clipping equation

KEYS

        arrow keys - rotate x,y axis
        insert/delete - rotate z axis
        w,a,s,d - translate on x,y axis
        pageup/pagedown - translate on z axis
        1,2 - adjust the far clipping plane
        3,4 - adjust the near clipping plane
        5,6 - adjust the field of view
        o - toggle on/two sided lighting
        v - begin video capture
        b - end video capture
        n - take screenshot
        l - toggle wireframe mode
        c - toggle backface culling
        f - toggle flat shading
        m - perform one edge reduction
        ESC or q - exit

EXAMPLES

Sphere: meteor --equation "x*x + y*y + z*z - .5" Torus: meteor --triangles 2000 --equation "pow(.4 - sqrt(x*x + y*y), 2) + z*z - .1" From a file: meteor models/sphere.c Piping: meteor --equation "x*x + y*y + z*z - .5" --no-display --create - | ./meteor --file - Animated: meteor models/growingsphere.c -as.05

generate 50 frames of a simplified mesh animation of a growing sphere, then use the sphere mesh data and generate a movie of it meteor sphere.c -c sphere -avnm 1000 --max-frames 50 meteor -af sphere --osmesa sphere.mp4

This document was created by man2html, using the manual pages.
Time: 03:02:37 GMT, March 14, 2007