Gazebo logo

guicam
[libgazebo]


Classes

struct  gz_guicam_data
 Guicam interface data. More...
struct  gz_guicam
 The guicam interface. More...

Defines

#define GAZEBO_GUICAM_MAX_IMAGE_SIZE   1024 * 768 * 3
 Constants.

Typedefs

typedef gz_guicam_data gz_guicam_data_t
 Guicam interface data.
typedef gz_guicam gz_guicam_t
 The guicam interface.

Functions

gz_guicam_tgz_guicam_alloc ()
 Create an interface.
void gz_guicam_free (gz_guicam_t *self)
 Destroy an interface.
int gz_guicam_create (gz_guicam_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_guicam_destroy (gz_guicam_t *self)
int gz_guicam_open (gz_guicam_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_guicam_close (gz_guicam_t *self)
 Close the interface (client).
int gz_guicam_lock (gz_guicam_t *self, int blocking)
void gz_guicam_unlock (gz_guicam_t *self)
 Unlock the interface.
int gz_guicam_post (gz_guicam_t *self)
 Tell clients that new data is available.

Detailed Description

The GuiCam interface provides access to user-controllable cameras (i.e., a gods-eye view for monitoring a running simulation). This interface is used by monitoring GUIs such as wxgazebo.

Define Documentation

#define GAZEBO_GUICAM_MAX_IMAGE_SIZE   1024 * 768 * 3
 

Constants.


Typedef Documentation

typedef struct gz_guicam_data gz_guicam_data_t
 

Guicam interface data.

typedef struct gz_guicam gz_guicam_t
 

The guicam interface.


Function Documentation

gz_guicam_t* gz_guicam_alloc  ) 
 

Create an interface.

void gz_guicam_free gz_guicam_t self  ) 
 

Destroy an interface.

int gz_guicam_create gz_guicam_t self,
gz_server_t server,
const char *  id,
const char *  model_type,
int  model_id,
int  parent_model_id
 

For internal use only.

Create the interface (used by Gazebo server)

int gz_guicam_destroy gz_guicam_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_guicam_open gz_guicam_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_guicam_close gz_guicam_t self  ) 
 

Close the interface (client).

int gz_guicam_lock gz_guicam_t self,
int  blocking
 

Lock the interface. Set blocking to 1 if the caller should block until the lock is acquired. Returns 0 if the lock is acquired.

void gz_guicam_unlock gz_guicam_t self  ) 
 

Unlock the interface.

int gz_guicam_post gz_guicam_t self  ) 
 

Tell clients that new data is available.


Last updated 12 September 2005 21:38:45