ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/radiance/ray/doc/man/man1/obj2mesh.1
Revision: 1.1
Committed: Tue Mar 11 22:48:20 2003 UTC (21 years, 2 months ago) by greg
Branch: MAIN
Log Message:
Created man page for obj2mesh and added -o option to gensurf

File Contents

# User Rev Content
1 greg 1.1 .\" RCSid "$Id"
2     .TH OBJ2MESH 1 03/11/03 RADIANCE
3     .SH NAME
4     obj2mesh - create a compiled RADIANCE mesh file from Wavefront .OBJ input
5     .SH SYNOPSIS
6     .B obj2mesh
7     [
8     .B "\-n objlim"
9     ][
10     .B "\-r maxres"
11     ][
12     .B \-w
13     ]
14     [
15     .B "input.obj"
16     [
17     .B "output.rtm"
18     ]
19     ]
20     .SH DESCRIPTION
21     .I Obj2mesh
22     reads a Wavefront .OBJ file from
23     .I input.obj
24     (or the standard input) and compiles it into a RADIANCE triangle mesh,
25     which is sent to
26     .I output.rtm
27     (or standard output).
28     This mesh may be included in a RADIANCE scene description via the
29     .I mesh
30     primitive, thus:
31     .IP "" .2i
32     mod mesh id
33     .br
34     1+ output.rtm [xform args]
35     .br
36     0
37     .br
38     0
39     .PP
40     The syntax and semantics are nearly identical to the RADIANCE
41     .I instance
42     primitive, except that the mesh modifier may not be "void", since
43     materials are not included in a compiled mesh file.
44     .PP
45     The
46     .I \-n
47     option specifies the maximum surface set size for
48     each voxel.
49     Larger numbers result in quicker mesh generation needing
50     less memory, but potentially slower rendering.
51     Smaller values may produce faster renderings,
52     since the default number (15) is on the high side to reduce
53     the compiled mesh octree size.
54     Values below 6 are not recommended, since the median
55     valence (number of adjacent faces) for a mesh vertex is 6,
56     and smaller limits will result in pointless octree subdivision.
57     .PP
58     The
59     .I \-r
60     option specifies the maximum octree resolution.
61     This should be greater than or equal to the ratio of the mesh bounding
62     box to the smallest triangle.
63     The default is 16384.
64     .PP
65     The
66     .I \-w
67     option suppresses warnings.
68     .PP
69     Although the mesh file format is binary, it is meant to be portable
70     between machines.
71     The only limitation is that machines with radically different integer
72     sizes will not work together.
73     .SH DIAGNOSTICS
74     There are four basic error types reported by obj2mesh:
75     .IP
76     warning - a non-fatal input-related error
77     .IP
78     fatal - an unrecoverable input-related error
79     .IP
80     system - a system-related error
81     .IP
82     internal - a fatal error related to program limitations
83     .IP
84     consistency - a program-caused error
85     .PP
86     Most errors are self-explanatory.
87     However, the following internal errors should be mentioned:
88     .IP "Set overflow in addobject (id)"
89     This error occurs when too many surfaces are close together in a
90     scene.
91     Sometimes a dense mesh can be accomodated by increasing
92     the maximum resolution (by powers of two) using the
93     .I \-r
94     option, but usually this error indicates something is wrong.
95     Either too many surfaces are lying right on top of each other,
96     or the bounding cube is inflated from disparate geometry
97     in the input.
98     Chances are, the face number "id" is near
99     those causing the problem.
100     .IP "Hash table overflow in fullnode"
101     This error is caused by too many surfaces, and there is
102     little hope of compiling this mesh.
103     .SH EXAMPLE
104     To create a compiled triangle mesh from the scene file mesh.obj:
105     .IP "" .2i
106     oconv mesh.obj mesh.rtm
107     .SH AUTHOR
108     Greg Ward
109     .SH "SEE ALSO"
110     gensurf(1), getinfo(1), make(1),
111     oconv(1), rpict(1), rview(1), rtrace(1), xform(1)