vrpn_Imager.h File Reference

#include <stdio.h>
#include <string.h>
#include "vrpn_BaseClass.h"
#include "vrpn_Configure.h"
#include "vrpn_Connection.h"
#include "vrpn_Shared.h"
#include "vrpn_Types.h"

Include dependency graph for vrpn_Imager.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	vrpn_Imager_Channel
	Holds the description needed to convert from raw data to values for a channel. More...
class	vrpn_Imager
	Base class for Imager class. More...
class	vrpn_Imager_Server
class	vrpn_ImagerPose
class	vrpn_ImagerPose_Server
struct	vrpn_IMAGERREGIONCB
struct	vrpn_IMAGERBEGINFRAMECB
struct	vrpn_IMAGERENDFRAMECB
struct	vrpn_IMAGERDISCARDEDFRAMESCB
class	vrpn_Imager_Region
	Helper function to convert data for a sub-region of one channel of. More...
class	vrpn_Imager_Remote
	This is the class users deal with: it tells the format and the region data when it arrives. More...
class	vrpn_ImagerPose_Remote

Typedefs
typedef void(VRPN_CALLBACK *	vrpn_IMAGERREGIONHANDLER) (void *userdata, const vrpn_IMAGERREGIONCB info)
typedef void(VRPN_CALLBACK *	vrpn_IMAGERDESCRIPTIONHANDLER) (void *userdata, const struct timeval msg_time)
typedef void(VRPN_CALLBACK *	vrpn_IMAGERBEGINFRAMEHANDLER) (void *userdata, const vrpn_IMAGERBEGINFRAMECB info)
typedef void(VRPN_CALLBACK *	vrpn_IMAGERENDFRAMEHANDLER) (void *userdata, const vrpn_IMAGERENDFRAMECB info)
typedef void(VRPN_CALLBACK *	vrpn_IMAGERDISCARDEDFRAMESHANDLER) (void *userdata, const vrpn_IMAGERDISCARDEDFRAMESCB info)
typedef void(VRPN_CALLBACK *	vrpn_IMAGERPOSEDESCRIPTIONHANDLER) (void *userdata, const struct timeval msg_time)

Variables
const unsigned	vrpn_IMAGER_MAX_CHANNELS = 100
const unsigned	vrpn_IMAGER_MAX_REGIONu8
	Set of constants to tell how many points you can put into a region depending on the type you are putting in there. Useful for senders to know how large of a chunk they can send at once.
const unsigned	vrpn_IMAGER_MAX_REGIONu16
const unsigned	vrpn_IMAGER_MAX_REGIONu12in16 = vrpn_IMAGER_MAX_REGIONu16
const unsigned	vrpn_IMAGER_MAX_REGIONf32
const vrpn_uint16	vrpn_IMAGER_VALTYPE_UNKNOWN = 0
const vrpn_uint16	vrpn_IMAGER_VALTYPE_UINT8 = 1
const vrpn_uint16	vrpn_IMAGER_VALTYPE_UINT16 = 4
const vrpn_uint16	vrpn_IMAGER_VALTYPE_UINT12IN16 = 5
const vrpn_uint16	vrpn_IMAGER_VALTYPE_FLOAT32 = 6
class VRPN_API	vrpn_Imager_Region

Typedef Documentation

vrpn_IMAGERBEGINFRAMEHANDLER

typedef void(VRPN_CALLBACK * vrpn_IMAGERBEGINFRAMEHANDLER) (void *userdata, const vrpn_IMAGERBEGINFRAMECB info)

Definition at line 430 of file vrpn_Imager.h.

vrpn_IMAGERDESCRIPTIONHANDLER

typedef void(VRPN_CALLBACK * vrpn_IMAGERDESCRIPTIONHANDLER) (void *userdata, const struct timeval msg_time)

Definition at line 402 of file vrpn_Imager.h.

vrpn_IMAGERDISCARDEDFRAMESHANDLER

typedef void(VRPN_CALLBACK * vrpn_IMAGERDISCARDEDFRAMESHANDLER) (void *userdata, const vrpn_IMAGERDISCARDEDFRAMESCB info)

Definition at line 434 of file vrpn_Imager.h.

vrpn_IMAGERENDFRAMEHANDLER

typedef void(VRPN_CALLBACK * vrpn_IMAGERENDFRAMEHANDLER) (void *userdata, const vrpn_IMAGERENDFRAMECB info)

Definition at line 432 of file vrpn_Imager.h.

vrpn_IMAGERPOSEDESCRIPTIONHANDLER

typedef void(VRPN_CALLBACK * vrpn_IMAGERPOSEDESCRIPTIONHANDLER) (void *userdata, const struct timeval msg_time)

Definition at line 770 of file vrpn_Imager.h.

vrpn_IMAGERREGIONHANDLER

typedef void(VRPN_CALLBACK * vrpn_IMAGERREGIONHANDLER) (void *userdata, const vrpn_IMAGERREGIONCB info)

Definition at line 397 of file vrpn_Imager.h.

Variable Documentation

vrpn_IMAGER_MAX_CHANNELS

const unsigned vrpn_IMAGER_MAX_CHANNELS = 100

Definition at line 32 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Server::add_channel().

vrpn_IMAGER_MAX_REGIONf32

const unsigned vrpn_IMAGER_MAX_REGIONf32

Initial value:

=
    (vrpn_CONNECTION_TCP_BUFLEN
    - 8 * sizeof(vrpn_int16)        
    - 6 * sizeof(vrpn_int32)) /     
    sizeof(vrpn_float32)

Definition at line 48 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Server::send_region_using_base_pointer().

vrpn_IMAGER_MAX_REGIONu12in16

const unsigned vrpn_IMAGER_MAX_REGIONu12in16 = vrpn_IMAGER_MAX_REGIONu16

Definition at line 47 of file vrpn_Imager.h.

vrpn_IMAGER_MAX_REGIONu16

const unsigned vrpn_IMAGER_MAX_REGIONu16

Initial value:

=
    (vrpn_CONNECTION_TCP_BUFLEN
    - 8 * sizeof(vrpn_int16)        
    - 6 * sizeof(vrpn_int32)) /     
    sizeof(vrpn_uint16)

Definition at line 42 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Server::send_region_using_base_pointer().

vrpn_IMAGER_MAX_REGIONu8

const unsigned vrpn_IMAGER_MAX_REGIONu8

Initial value:

=
    (vrpn_CONNECTION_TCP_BUFLEN
    - 8 * sizeof(vrpn_int16)        
    - 6 * sizeof(vrpn_int32)) /     
    sizeof(vrpn_uint8)

Set of constants to tell how many points you can put into a region depending on the type you are putting in there. Useful for senders to know how large of a chunk they can send at once.

Definition at line 37 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Server::send_region_using_base_pointer().

vrpn_Imager_Region

class VRPN_API vrpn_Imager_Region

Definition at line 390 of file vrpn_Imager.h.

vrpn_IMAGER_VALTYPE_FLOAT32

const vrpn_uint16 vrpn_IMAGER_VALTYPE_FLOAT32 = 6

Definition at line 388 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), vrpn_Imager_Region::read_unscaled_pixel(), and vrpn_Imager_Server::send_region_using_base_pointer().

vrpn_IMAGER_VALTYPE_UINT12IN16

const vrpn_uint16 vrpn_IMAGER_VALTYPE_UINT12IN16 = 5

Definition at line 387 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), and vrpn_Imager_Region::read_unscaled_pixel().

vrpn_IMAGER_VALTYPE_UINT16

const vrpn_uint16 vrpn_IMAGER_VALTYPE_UINT16 = 4

Definition at line 386 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), vrpn_Imager_Region::read_unscaled_pixel(), and vrpn_Imager_Server::send_region_using_base_pointer().

vrpn_IMAGER_VALTYPE_UINT8

const vrpn_uint16 vrpn_IMAGER_VALTYPE_UINT8 = 1

Definition at line 381 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), vrpn_Imager_Region::decode_unscaled_region_using_base_pointer(), vrpn_Imager_Region::read_unscaled_pixel(), and vrpn_Imager_Server::send_region_using_base_pointer().

vrpn_IMAGER_VALTYPE_UNKNOWN

const vrpn_uint16 vrpn_IMAGER_VALTYPE_UNKNOWN = 0

Definition at line 380 of file vrpn_Imager.h.

Referenced by vrpn_Imager_Region::vrpn_Imager_Region().