amino
Lightweight Robot Utility Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
scene_win.h
Go to the documentation of this file.
1 /* -*- mode: C; c-basic-offset: 4; -*- */
2 /* ex: set shiftwidth=4 tabstop=4 expandtab: */
3 /*
4  * Copyright (c) 2015, Rice University
5  * All rights reserved.
6  *
7  * Author(s): Neil T. Dantam <ntd@rice.edu>
8  *
9  * Redistribution and use in source and binary forms, with or
10  * without modification, are permitted provided that the following
11  * conditions are met:
12  * * Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * * Redistributions in binary form must reproduce the above
15  * copyright notice, this list of conditions and the following
16  * disclaimer in the documentation and/or other materials provided
17  * with the distribution.
18  * * Neither the name of copyright holder the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
23  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
24  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
26  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
27  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
30  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
31  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  * POSSIBILITY OF SUCH DAMAGE.
35  *
36  */
37 
38 #ifndef AMINO_RX_SCENE_WIN_H
39 #define AMINO_RX_SCENE_WIN_H
40 
48 AA_API struct aa_rx_win *
50  const char* title,
51  int x_pos,
52  int y_pos,
53  int width,
54  int height,
55  Uint32 flags );
56 
60 AA_API struct aa_rx_win *
62  const char* title, int width, int height );
63 
64 
68 AA_API void
69 aa_rx_win_destroy( struct aa_rx_win * win);
70 
81 AA_API struct aa_gl_globals *
82 aa_rx_win_gl_globals( struct aa_rx_win * win);
83 
84 
92 AA_API void
93 aa_rx_win_set_sg( struct aa_rx_win * win,
94  const struct aa_rx_sg *sg );
95 
96 AA_API const struct aa_rx_sg *
97 aa_rx_win_get_sg( struct aa_rx_win * win );
98 
102 AA_API void
103 aa_rx_win_display_sg_config( struct aa_rx_win *win, struct aa_sdl_display_params *params,
104  const struct aa_rx_sg *scenegraph,
105  size_t n_q, const double *q );
106 
107 
108 AA_API void
109 aa_rx_win_display_sg_tf( struct aa_rx_win *win, struct aa_sdl_display_params *params,
110  const struct aa_rx_sg *scenegraph,
111  size_t n_tf, const double *tf_abs, size_t ld_tf );
112 
119 AA_API void
120 aa_rx_win_set_config( struct aa_rx_win * win,
121  size_t n,
122  const double *q );
123 
124 
138 AA_API void
139 aa_rx_win_set_display( struct aa_rx_win * win,
140  aa_sdl_win_display_fun display,
141  void *context,
142  void (*destructor)(void*) );
143 
144 
145 AA_API void
146 aa_rx_win_set_display_plan( struct aa_rx_win * win,
147  struct aa_rx_sg *sg,
148  size_t n_plan_elements,
149  const double *plan );
150 
151 struct aa_rx_mp_seq;
152 
153 AA_API void
154 aa_rx_win_set_display_seq( struct aa_rx_win * win, struct aa_rx_mp_seq *mp_seq);
155 
163 AA_API void aa_rx_win_display_loop( struct aa_rx_win * window );
164 
165 
166 
170 AA_API void
171 aa_rx_win_start( struct aa_rx_win * win );
172 
173 
174 /*
175  * Asynchronous display using new thread and default rendering
176  * function.
177  *
178  * This function renders the previously set scenegraph and and
179  * configuration vector. The configuration vector may be updated
180  * while the asynchronous thread is running.
181  *
182  * @see aa_rx_win_set_sg()
183  * @see aa_rx_win_set_config()
184  */
185 //AA_API void
186 //aa_rx_win_default_start( struct aa_rx_win * win );
187 
194 AA_API void
195 aa_rx_win_stop( struct aa_rx_win * win );
196 
200 AA_API void
201 aa_rx_win_stop_on_quit( struct aa_rx_win * win, int value );
202 
206 AA_API void
207 aa_rx_win_join( struct aa_rx_win * win );
208 
212 AA_API void
213 aa_rx_win_pause( struct aa_rx_win * win, int paused );
214 
221 AA_API void
222 aa_rx_win_lock( struct aa_rx_win * win );
223 
227 AA_API void
228 aa_rx_win_unlock( struct aa_rx_win * win );
229 
235 AA_API void
236 aa_rx_win_sg_gl_init( struct aa_rx_win * win,
237  struct aa_rx_sg *sg );
238 
239 
243 AA_API void
244 aa_rx_win_get_tf_cam( struct aa_rx_win * win, double *E );
245 
249 AA_API void
250 aa_rx_win_set_tf_cam( struct aa_rx_win * win, const double *E );
251 
252 
253 #endif /*AMINO_RX_SCENE_WIN_H*/
AA_API void aa_rx_win_pause(struct aa_rx_win *win, int paused)
Pause rendering.
AA_API void aa_rx_win_start(struct aa_rx_win *win)
Start a thread to asynchronously render the window.
AA_API struct aa_gl_globals * aa_rx_win_gl_globals(struct aa_rx_win *win)
Return a pointer to the window's GL globals struct.
AA_API void aa_rx_win_display_loop(struct aa_rx_win *window)
Synchronous display using current thread.
Opaque type for a scene_graph.
AA_API void aa_rx_win_set_sg(struct aa_rx_win *win, const struct aa_rx_sg *sg)
Set a scenegraph for the window.
AA_API void aa_rx_win_join(struct aa_rx_win *win)
Join the asynchronous display thread.
AA_API void aa_rx_win_stop(struct aa_rx_win *win)
Instruct the rendering thread to stop.
AA_API void aa_rx_win_lock(struct aa_rx_win *win)
Lock the window.
#define AA_API
calling and name mangling convention for functions
Definition: amino.h:86
AA_API void aa_rx_win_set_display(struct aa_rx_win *win, aa_sdl_win_display_fun display, void *context, void(*destructor)(void *))
Set the window's display function.
AA_API void aa_rx_win_set_config(struct aa_rx_win *win, size_t n, const double *q)
Set the configuration vector for the window.
Opaque type for a window.
Definition: rxtype.h:66
AA_API void aa_rx_win_unlock(struct aa_rx_win *win)
Unlock the window.
AA_API void aa_rx_win_set_tf_cam(struct aa_rx_win *win, const double *E)
Set the camera pose.
AA_API struct aa_rx_win * aa_rx_win_create(const char *title, int x_pos, int y_pos, int width, int height, Uint32 flags)
Create a new SDL / OpenGL window.
Parameters for SDL display function.
Definition: rxtype.h:73
AA_API void aa_rx_win_destroy(struct aa_rx_win *win)
Destroy SDL / OpenGL window.
AA_API void aa_rx_win_get_tf_cam(struct aa_rx_win *win, double *E)
Return the current camera pose.
AA_API void aa_rx_win_display_sg_config(struct aa_rx_win *win, struct aa_sdl_display_params *params, const struct aa_rx_sg *scenegraph, size_t n_q, const double *q)
Render a scenegraph at the given configuration in the window.
AA_API void aa_rx_win_sg_gl_init(struct aa_rx_win *win, struct aa_rx_sg *sg)
Initialize scenegraph GL values for the given window.
AA_API struct aa_rx_win * aa_rx_win_default_create(const char *title, int width, int height)
Create a new SDL / OpenGL window with default parameters.
AA_API void aa_rx_win_stop_on_quit(struct aa_rx_win *win, int value)
Instruct the rendering thread to stop when the user closes the window.