src/hd/rhdobj.h

/* Copyright (c) 1998 Silicon Graphics, Inc. */

/* SCCSid "$SunId$ SGI" */

/*
 * Header file for object display routines for rholo drivers.
 */

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