Gazebo logo

ptz
[libgazebo]


Classes

struct  gz_ptz_data
 Ptz interface. More...
struct  gz_ptz
 The ptz interface. More...

Typedefs

typedef gz_ptz_data gz_ptz_data_t
 Ptz interface.
typedef gz_ptz gz_ptz_t
 The ptz interface.

Functions

gz_ptz_tgz_ptz_alloc ()
 Create an interface.
void gz_ptz_free (gz_ptz_t *self)
 Destroy an interface.
int gz_ptz_create (gz_ptz_t *self, gz_server_t *server, const char *id, const char *model_type, int model_id, int parent_model_id)
int gz_ptz_destroy (gz_ptz_t *self)
int gz_ptz_open (gz_ptz_t *self, gz_client_t *client, const char *id)
 Open an existing interface (used by Gazebo clients).
int gz_ptz_close (gz_ptz_t *self)
 Close the interface (client).
int gz_ptz_lock (gz_ptz_t *self, int blocking)
void gz_ptz_unlock (gz_ptz_t *self)
 Unlock the interface.
int gz_ptz_post (gz_ptz_t *self)
 Tell clients that new data is available.

Detailed Description

The ptz interface allows clients to control the pan, tilt and zoom angles on a camera head such as the Sony VID30.

Typedef Documentation

typedef struct gz_ptz_data gz_ptz_data_t
 

Ptz interface.

typedef struct gz_ptz gz_ptz_t
 

The ptz interface.


Function Documentation

gz_ptz_t* gz_ptz_alloc  ) 
 

Create an interface.

void gz_ptz_free gz_ptz_t self  ) 
 

Destroy an interface.

int gz_ptz_create gz_ptz_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_ptz_destroy gz_ptz_t self  ) 
 

For internal use only.

Destroy the interface (server)

int gz_ptz_open gz_ptz_t self,
gz_client_t client,
const char *  id
 

Open an existing interface (used by Gazebo clients).

int gz_ptz_close gz_ptz_t self  ) 
 

Close the interface (client).

int gz_ptz_lock gz_ptz_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_ptz_unlock gz_ptz_t self  ) 
 

Unlock the interface.

int gz_ptz_post gz_ptz_t self  ) 
 

Tell clients that new data is available.


Last updated 12 September 2005 21:38:45