src/hd/rhdobj.h

/* RCSid: $Id: rhdobj.h,v 3.6 2003/02/22 02:07:24 greg Exp $ */
/*
 * Header file for object display routines for rholo drivers.
 */
#ifndef _RAD_RHDOBJ_H_
#define _RAD_RHDOBJ_H_

#ifdef __cplusplus
extern "C" {
#endif

                                /* additional user commands */
#define DO_LOAD         0               /* load octree object */
#define DO_UNLOAD       1               /* unload (free) octree object */
#define DO_XFORM        2               /* set/print object transform */
#define DO_MOVE         3               /* add to object transform */
#define DO_UNMOVE       4               /* undo last transform change */
#define DO_DUP          5               /* duplicate object */
#define DO_SHOW         6               /* show object (low quality) */
#define DO_LIGHT        7               /* illuminate object (high quality) */
#define DO_HIDE         8               /* hide object */
#define DO_OBJECT       9               /* print object statistics */

#define DO_NCMDS        10              /* number of object display commands */

                                        /* commands entered on stdin only */
#define DO_INIT         {"load","clear","xform","move","unmove","dup",\
                                "show","light","hide","object"}

/*******************************************************************
 * The following routines are available for calling from the driver:

int
(*dobj_lightsamp)(c, p, v)      : apply next sample for local light sources
COLR    c;                      : pixel color (RGBE)
FVECT   p;                      : world intersection point
FVECT   v;                      : ray direction vector

If the pointer to the function dobj_lightsamp is non-NULL, then the
dev_value() driver routine should call this rather than use a
given sample in its own data structures.  This pointer is set
in the dobj_lighting() function described below, which may be
called indirectly by the dobj_command() function.


int
dobj_command(cmd, args)         : check/run object display command
char    *cmd, *args;            : command name and argument string

Check to see if this is an object display command, and return -1 if
it isn't.  If it is a valid command that results in some visible
change, return non-zero, otherwise return 0.  Error messages should
be printed with error(COMMAND,err).


double
dobj_trace(nm, rorg, rdir)      : check for ray intersection with objects
char    nm[];                   : object name (modified)
FVECT   rorg, rdir;             : ray origin and direction

Check to see if the given ray intersects the given object,
returning the distance the ray traveled if it did, or FHUGE if it didn't.
If nm contains "*", then all visible objects are checked and the name
of the intersected object is returned, or "" if none.  If nm is NULL,
then all visible objects are checked, but the name is not returned.


int
dobj_render()                   : render visible objects to OpenGL

Renders all display objects using OpenGL, assuming desired view has
been set.  This routine also assumes that the tone-mapping library
is being used to set exposure, and it queries this information to
adjust light sources as necessary for illuminated objects.  Returns
the number of objects rendered.


void
dobj_cleanup()                  : clean up data structures

Frees all allocated data structures and objects.


++++ The following routines are usually called through dobj_command() ++++


int
dobj_load(oct, nam)             : create/load an octree object
char    *oct, *nam;             : octree and object name

Load an octree for rendering as a local object, giving it the indicated name.
Returns 1 on success, 0 on failure (with COMMAND error message).


int
dobj_unload(nam)                : free the named object
char    *nam;                   : object name

Free all memory associated with the named object.
Returns 1 on success, 0 on failure (with COMMAND error message).


int
dobj_xform(nam, add, ac, av)    : set/add transform for nam
char    *nam;                   : object name
int     add;                    : add to transform or create new one?
int     ac;                     : transform argument count
char    *av[];                  : transform arguments

Set or add to the transform for the named object.
Returns 1 on success, 0 on failure (with COMMAND error message).


int
dobj_unmove()                   : undo last transform change

Undo the last transform change.
Returns 1 on success, 0 on failure (with COMMAND error message).


int
dobj_dup(oldnm, nam)            : duplicate object oldnm as nam
char    *oldnm, *nam;

Duplicate the named object and give the copy a new name.
Returns 1 on success, 0 on failure (with COMMAND error message).


int
dobj_lighting(nam, cn)          : set up lighting for display object
char    *nam;                   : object name
int     cn;                     : new drawing code

Set the lighting of the named object to DO_SHOW, DO_HIDE or DO_LIGHT.
Change lighting of all objects if nam is "*".
Returns 1 on success, 0 on failure (with COMMAND error message).


int
dobj_putstats(nam, fp)          : print object statistics
char    *nam;                   : object name
FILE    *fp;                    : output file

Print current position, size and transform for the named object,
or all objects if nam is "*".
Returns 1 on success, 0 on failure (with COMMAND error message).


 ******************************************************************/


extern double   dobj_trace();

extern char     rhdcmd[DO_NCMDS][8];

extern int      (*dobj_lightsamp)();    /* pointer to function to get lights */

#ifdef __cplusplus
}
#endif
#endif /* _RAD_RHDOBJ_H_ */

Revision:	3.7
Committed:	Mon Jul 14 22:24:00 2003 UTC (22 years, 3 months ago) by schorsch
Content type:	text/plain
Branch:	MAIN
Changes since 3.6:	+13 -1 lines
Log Message:	Instrumented headers against multiple inclusion and for use from C++. Moved includes in headers out of "C" scope.
#	Content
1	/* RCSid: $Id: rhdobj.h,v 3.6 2003/02/22 02:07:24 greg Exp $ */
2	/*
3	* Header file for object display routines for rholo drivers.
4	*/
5	#ifndef _RAD_RHDOBJ_H_
6	#define _RAD_RHDOBJ_H_
7
8	#ifdef __cplusplus
9	extern "C" {
10	#endif
11
12	/* additional user commands */
13	#define DO_LOAD 0 /* load octree object */
14	#define DO_UNLOAD 1 /* unload (free) octree object */
15	#define DO_XFORM 2 /* set/print object transform */
16	#define DO_MOVE 3 /* add to object transform */
17	#define DO_UNMOVE 4 /* undo last transform change */
18	#define DO_DUP 5 /* duplicate object */
19	#define DO_SHOW 6 /* show object (low quality) */
20	#define DO_LIGHT 7 /* illuminate object (high quality) */
21	#define DO_HIDE 8 /* hide object */
22	#define DO_OBJECT 9 /* print object statistics */
23
24	#define DO_NCMDS 10 /* number of object display commands */
25
26	/* commands entered on stdin only */
27	#define DO_INIT {"load","clear","xform","move","unmove","dup",\
28	"show","light","hide","object"}
29
30	/*******************************************************************
31	* The following routines are available for calling from the driver:
32
33	int
34	(*dobj_lightsamp)(c, p, v) : apply next sample for local light sources
35	COLR c; : pixel color (RGBE)
36	FVECT p; : world intersection point
37	FVECT v; : ray direction vector
38
39	If the pointer to the function dobj_lightsamp is non-NULL, then the
40	dev_value() driver routine should call this rather than use a
41	given sample in its own data structures. This pointer is set
42	in the dobj_lighting() function described below, which may be
43	called indirectly by the dobj_command() function.
44
45
46	int
47	dobj_command(cmd, args) : check/run object display command
48	char cmd, args; : command name and argument string
49
50	Check to see if this is an object display command, and return -1 if
51	it isn't. If it is a valid command that results in some visible
52	change, return non-zero, otherwise return 0. Error messages should
53	be printed with error(COMMAND,err).
54
55
56	double
57	dobj_trace(nm, rorg, rdir) : check for ray intersection with objects
58	char nm[]; : object name (modified)
59	FVECT rorg, rdir; : ray origin and direction
60
61	Check to see if the given ray intersects the given object,
62	returning the distance the ray traveled if it did, or FHUGE if it didn't.
63	If nm contains "*", then all visible objects are checked and the name
64	of the intersected object is returned, or "" if none. If nm is NULL,
65	then all visible objects are checked, but the name is not returned.
66
67
68	int
69	dobj_render() : render visible objects to OpenGL
70
71	Renders all display objects using OpenGL, assuming desired view has
72	been set. This routine also assumes that the tone-mapping library
73	is being used to set exposure, and it queries this information to
74	adjust light sources as necessary for illuminated objects. Returns
75	the number of objects rendered.
76
77
78	void
79	dobj_cleanup() : clean up data structures
80
81	Frees all allocated data structures and objects.
82
83
84	++++ The following routines are usually called through dobj_command() ++++
85
86
87	int
88	dobj_load(oct, nam) : create/load an octree object
89	char oct, nam; : octree and object name
90
91	Load an octree for rendering as a local object, giving it the indicated name.
92	Returns 1 on success, 0 on failure (with COMMAND error message).
93
94
95	int
96	dobj_unload(nam) : free the named object
97	char *nam; : object name
98
99	Free all memory associated with the named object.
100	Returns 1 on success, 0 on failure (with COMMAND error message).
101
102
103	int
104	dobj_xform(nam, add, ac, av) : set/add transform for nam
105	char *nam; : object name
106	int add; : add to transform or create new one?
107	int ac; : transform argument count
108	char *av[]; : transform arguments
109
110	Set or add to the transform for the named object.
111	Returns 1 on success, 0 on failure (with COMMAND error message).
112
113
114	int
115	dobj_unmove() : undo last transform change
116
117	Undo the last transform change.
118	Returns 1 on success, 0 on failure (with COMMAND error message).
119
120
121	int
122	dobj_dup(oldnm, nam) : duplicate object oldnm as nam
123	char oldnm, nam;
124
125	Duplicate the named object and give the copy a new name.
126	Returns 1 on success, 0 on failure (with COMMAND error message).
127
128
129	int
130	dobj_lighting(nam, cn) : set up lighting for display object
131	char *nam; : object name
132	int cn; : new drawing code
133
134	Set the lighting of the named object to DO_SHOW, DO_HIDE or DO_LIGHT.
135	Change lighting of all objects if nam is "*".
136	Returns 1 on success, 0 on failure (with COMMAND error message).
137
138
139	int
140	dobj_putstats(nam, fp) : print object statistics
141	char *nam; : object name
142	FILE *fp; : output file
143
144	Print current position, size and transform for the named object,
145	or all objects if nam is "*".
146	Returns 1 on success, 0 on failure (with COMMAND error message).
147
148
149	******************************************************************/
150
151
152	extern double dobj_trace();
153
154	extern char rhdcmd[DO_NCMDS][8];
155
156	extern int (dobj_lightsamp)(); / pointer to function to get lights */
157
158	#ifdef __cplusplus
159	}
160	#endif
161	#endif /* _RAD_RHDOBJ_H_ */
162