vrpn 07.35
Virtual Reality Peripheral Network
Loading...
Searching...
No Matches
vrpn_Sound_Client Class Reference

#include <vrpn_Sound.h>

Inheritance diagram for vrpn_Sound_Client:
Collaboration diagram for vrpn_Sound_Client:

Public Member Functions

 vrpn_Sound_Client (const char *name, vrpn_Connection *c)
 
 ~vrpn_Sound_Client ()
 
vrpn_int32 playSound (const vrpn_SoundID id, vrpn_int32 repeat)
 
vrpn_int32 stopSound (const vrpn_SoundID id)
 
vrpn_SoundID loadSound (const char *sound, const vrpn_SoundID id, const vrpn_SoundDef soundDef)
 
vrpn_int32 unloadSound (const vrpn_SoundID id)
 
vrpn_int32 setSoundVolume (const vrpn_SoundID id, const vrpn_float64 volume)
 
vrpn_int32 setSoundPose (const vrpn_SoundID id, vrpn_float64 position[3], vrpn_float64 orientation[4])
 
vrpn_int32 setSoundVelocity (const vrpn_SoundID id, const vrpn_float64 velocity[4])
 
vrpn_int32 setSoundDistances (const vrpn_SoundID id, const vrpn_float64 max_front_dist, const vrpn_float64 min_front_dist, const vrpn_float64 max_back_dist, const vrpn_float64 min_back_dist)
 
vrpn_int32 setSoundConeInfo (const vrpn_SoundID id, const vrpn_float64 inner_angle, const vrpn_float64 outer_angle, const vrpn_float64 gain)
 
vrpn_int32 setSoundDopScale (const vrpn_SoundID id, vrpn_float64 dopfactor)
 
vrpn_int32 setSoundEqValue (const vrpn_SoundID id, vrpn_float64 eq_value)
 
vrpn_int32 setSoundPitch (const vrpn_SoundID id, vrpn_float64 pitch)
 
vrpn_int32 setListenerPose (const vrpn_float64 position[3], const vrpn_float64 orientation[4])
 
vrpn_int32 setListenerVelocity (const vrpn_float64 velocity[4])
 
vrpn_int32 LoadModel_local (const char *filename)
 
vrpn_int32 LoadModel_remote (const char *data)
 
vrpn_int32 LoadPolyQuad (const vrpn_QuadDef quad)
 
vrpn_int32 LoadPolyTri (const vrpn_TriDef tri)
 
vrpn_int32 LoadMaterial (const vrpn_int32 id, const vrpn_MaterialDef material)
 
vrpn_int32 setMaterialName (const int id, const char *materialname)
 
vrpn_int32 setMaterialTransGain (const int id, const vrpn_float64 transmittance_gain)
 
vrpn_int32 setMaterialTransHF (const int id, const vrpn_float64 transmittance_hf)
 
vrpn_int32 setMaterialReflGain (const int id, const vrpn_float64 reflectance_gain)
 
vrpn_int32 setMaterialReflHF (const int id, const vrpn_float64 reflectance_hf)
 
vrpn_int32 setPolyOF (const int id, const vrpn_float64 OF)
 
vrpn_int32 setQuadVertices (const int id, const vrpn_float64 vertices[4][3])
 
vrpn_int32 setPolyMaterialName (const int id, const char *materialname)
 
vrpn_int32 setTriVertices (const int id, const vrpn_float64 vertices[3][3])
 
virtual void mainloop ()
 Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().
 
virtual void receiveTextMessage (const char *message, vrpn_uint32 type, vrpn_uint32 level, struct timeval msg_time)
 
- Public Member Functions inherited from vrpn_Sound
 vrpn_Sound (const char *name, vrpn_Connection *c)
 
 ~vrpn_Sound ()
 
- Public Member Functions inherited from vrpn_BaseClass
 vrpn_BaseClass (const char *name, vrpn_Connection *c=NULL)
 Names the device and assigns or opens connection, calls registration methods.
 
virtual ~vrpn_BaseClass ()
 
- Public Member Functions inherited from vrpn_BaseClassUnique
 vrpn_BaseClassUnique ()
 
virtual ~vrpn_BaseClassUnique ()
 Unregister all of the message handlers that were to be autodeleted.
 
vrpn_ConnectionconnectionPtr ()
 Returns a pointer to the connection this object is using.
 
- Public Member Functions inherited from vrpn_Text_Receiver
 vrpn_Text_Receiver (const char *name, vrpn_Connection *c=NULL)
 
virtual ~vrpn_Text_Receiver (void)
 
virtual int register_message_handler (void *userdata, vrpn_TEXTHANDLER handler)
 
virtual int unregister_message_handler (void *userdata, vrpn_TEXTHANDLER handler)
 

Additional Inherited Members

- Public Attributes inherited from vrpn_BaseClassUnique
bool shutup
 
- Protected Member Functions inherited from vrpn_Sound
int register_types (void)
 Register the types of messages this device sends/receives. Return 0 on success, -1 on fail.
 
vrpn_int32 encodeSound_local (const char *filename, const vrpn_SoundID id, const vrpn_SoundDef soundDef, char **buf)
 
vrpn_int32 decodeSound_local (const char *buf, char **filename, vrpn_SoundID *id, vrpn_SoundDef *soundDef, const int payload)
 
vrpn_int32 encodeSound_remote (const char *filename, const vrpn_SoundID id, char **buf)
 
vrpn_int32 decodeSound_remote (const char *buf, char **filename, vrpn_SoundID *id, const int payload)
 
vrpn_int32 encodeSoundID (const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundID (const char *buf, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundDef (const vrpn_SoundDef sound, const vrpn_SoundID id, const vrpn_int32 repeat, char *buf)
 
vrpn_int32 decodeSoundDef (const char *buf, vrpn_SoundDef *sound, vrpn_SoundID *id, vrpn_int32 *repeat)
 
vrpn_int32 encodeSoundPlay (const vrpn_SoundID id, const vrpn_int32 repeat, char *buf)
 
vrpn_int32 decodeSoundPlay (const char *buf, vrpn_SoundID *id, vrpn_int32 *repeat)
 
vrpn_int32 encodeListenerVelocity (const vrpn_float64 *velocity, char *buf)
 
vrpn_int32 decodeListenerVelocity (const char *buf, vrpn_float64 *velocity)
 
vrpn_int32 encodeListenerPose (const vrpn_PoseDef pose, char *buf)
 
vrpn_int32 decodeListenerPose (const char *buf, vrpn_PoseDef *pose)
 
vrpn_int32 encodeSoundPose (const vrpn_PoseDef pose, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundPose (const char *buf, vrpn_PoseDef *pose, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundVelocity (const vrpn_float64 *velocity, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundVelocity (const char *buf, vrpn_float64 *velocity, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundDistInfo (const vrpn_float64 min_back, const vrpn_float64 max_back, const vrpn_float64 min_front, const vrpn_float64 max_front, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundDistInfo (const char *buf, vrpn_float64 *min_back, vrpn_float64 *max_back, vrpn_float64 *min_front, vrpn_float64 *max_front, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundConeInfo (const vrpn_float64 cone_inner_angle, const vrpn_float64 cone_outer_angle, const vrpn_float64 cone_gain, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundConeInfo (const char *buf, vrpn_float64 *cone_inner_angle, vrpn_float64 *cone_outer_angle, vrpn_float64 *cone_gain, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundDoplerScale (const vrpn_float64 doplerfactor, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundDoplerScale (const char *buf, vrpn_float64 *doplerfactor, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundEqFactor (const vrpn_float64 eqfactor, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundEqFactor (const char *buf, vrpn_float64 *eqfactor, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundPitch (const vrpn_float64 pitch, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundPitch (const char *buf, vrpn_float64 *pitch, vrpn_SoundID *id)
 
vrpn_int32 encodeSoundVolume (const vrpn_float64 volume, const vrpn_SoundID id, char *buf)
 
vrpn_int32 decodeSoundVolume (const char *buf, vrpn_float64 *volume, vrpn_SoundID *id)
 
vrpn_int32 encodeLoadModel_local (const char *filename, char **buf)
 
vrpn_int32 decodeLoadModel_local (const char *buf, char **filename, const int payload)
 
vrpn_int32 encodeLoadModel_remote (const char *filename, char **buf)
 
vrpn_int32 decodeLoadModel_remote (const char *buf, char **filename, const int payload)
 
vrpn_int32 encodeLoadPolyQuad (const vrpn_QuadDef quad, char *buf)
 
vrpn_int32 decodeLoadPolyQuad (const char *buf, vrpn_QuadDef *quad)
 
vrpn_int32 encodeLoadPolyTri (const vrpn_TriDef tri, char *buf)
 
vrpn_int32 decodeLoadPolyTri (const char *buf, vrpn_TriDef *tri)
 
vrpn_int32 encodeLoadMaterial (const vrpn_int32 id, const vrpn_MaterialDef material, char *buf)
 
vrpn_int32 decodeLoadMaterial (const char *buf, vrpn_MaterialDef *material, vrpn_int32 *id)
 
vrpn_int32 encodeSetQuadVert (const vrpn_float64 vertices[4][3], const vrpn_int32 tag, char *buf)
 
vrpn_int32 decodeSetQuadVert (const char *buf, vrpn_float64(*vertices)[4][3], vrpn_int32 *tag)
 
vrpn_int32 encodeSetTriVert (const vrpn_float64 vertices[3][3], const vrpn_int32 tag, char *buf)
 
vrpn_int32 decodeSetTriVert (const char *buf, vrpn_float64(*vertices)[3][3], vrpn_int32 *tag)
 
vrpn_int32 encodeSetPolyOF (const vrpn_float64 openingfactor, const vrpn_int32 tag, char *buf)
 
vrpn_int32 decodeSetPolyOF (const char *buf, vrpn_float64 *openingfactor, vrpn_int32 *tag)
 
vrpn_int32 encodeSetPolyMaterial (const char *material, const vrpn_int32 tag, char *buf)
 
vrpn_int32 decodeSetPolyMaterial (const char *buf, char **material, vrpn_int32 *tag, const int payload)
 
- Protected Member Functions inherited from vrpn_BaseClass
virtual int init (void)
 Initialize things that the constructor can't. Returns 0 on success, -1 on failure.
 
virtual int register_senders (void)
 Register the sender for this device (by default, the name of the device). Return 0 on success, -1 on fail.
 
- Protected Member Functions inherited from vrpn_BaseClassUnique
int register_autodeleted_handler (vrpn_int32 type, vrpn_MESSAGEHANDLER handler, void *userdata, vrpn_int32 sender=vrpn_ANY_SENDER)
 Registers a handler with the connection, and remembers to delete at destruction.
 
int send_text_message (const char *msg, struct timeval timestamp, vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL, vrpn_uint32 level=0)
 Sends a NULL-terminated text message from the device d_sender_id.
 
SendTextMessageBoundCall send_text_message (vrpn_TEXT_SEVERITY type=vrpn_TEXT_NORMAL)
 Returns an object you can stream into to send a text message from the device like send_text_message(vrpn_TEXT_WARNING) << "Value of i is: " << i; This use requires including vrpn_SendTextMessageStreamProxy.h.
 
void server_mainloop (void)
 Handles functions that all servers should provide in their mainloop() (ping/pong, for example) Should be called by all servers in their mainloop()
 
void client_mainloop (void)
 Handles functions that all clients should provide in their mainloop() (warning of no server, for example) Should be called by all clients in their mainloop()
 
- Protected Member Functions inherited from vrpn_Text_Receiver
virtual int register_types (void)
 No types to register beyond the text, which is done in BaseClass.
 
- Static Protected Member Functions inherited from vrpn_BaseClassUnique
static int encode_text_message_to_buffer (char *buf, vrpn_TEXT_SEVERITY severity, vrpn_uint32 level, const char *msg)
 Encodes the body of the text message into a buffer, preparing for sending.
 
static int decode_text_message_from_buffer (char *msg, vrpn_TEXT_SEVERITY *severity, vrpn_uint32 *level, const char *buf)
 Decodes the body of the text message from a buffer from the connection.
 
- Static Protected Member Functions inherited from vrpn_Text_Receiver
static int VRPN_CALLBACK handle_message (void *userdata, vrpn_HANDLERPARAM p)
 
- Protected Attributes inherited from vrpn_Sound
vrpn_int32 load_sound_local
 
vrpn_int32 load_sound_remote
 
vrpn_int32 unload_sound
 
vrpn_int32 play_sound
 
vrpn_int32 stop_sound
 
vrpn_int32 change_sound_status
 
vrpn_int32 set_listener_pose
 
vrpn_int32 set_listener_velocity
 
vrpn_int32 set_sound_pose
 
vrpn_int32 set_sound_velocity
 
vrpn_int32 set_sound_distanceinfo
 
vrpn_int32 set_sound_coneinfo
 
vrpn_int32 set_sound_doplerfactor
 
vrpn_int32 set_sound_eqvalue
 
vrpn_int32 set_sound_pitch
 
vrpn_int32 set_sound_volume
 
vrpn_int32 load_model_local
 
vrpn_int32 load_model_remote
 
vrpn_int32 load_polyquad
 
vrpn_int32 load_polytri
 
vrpn_int32 load_material
 
vrpn_int32 set_polyquad_vertices
 
vrpn_int32 set_polytri_vertices
 
vrpn_int32 set_poly_openingfactor
 
vrpn_int32 set_poly_material
 
vrpn_int32 receive_text_message
 
struct timeval timestamp
 
- Protected Attributes inherited from vrpn_BaseClassUnique
vrpn_Connectiond_connection
 Connection that this object talks to.
 
char * d_servicename
 Name of this device, not including the connection part.
 
vrpn_int32 d_sender_id
 Sender ID registered with the connection.
 
vrpn_int32 d_text_message_id
 ID for text messages.
 
vrpn_int32 d_ping_message_id
 Ask the server if they are there.
 
vrpn_int32 d_pong_message_id
 Server telling that it is there.
 
- Protected Attributes inherited from vrpn_Text_Receiver
vrpn_Callback_List< vrpn_TEXTCBd_callback_list
 

Detailed Description

Definition at line 257 of file vrpn_Sound.h.

Constructor & Destructor Documentation

◆ vrpn_Sound_Client()

vrpn_Sound_Client::vrpn_Sound_Client ( const char * name,
vrpn_Connection * c )

Definition at line 870 of file vrpn_Sound.C.

References vrpn_Text_Receiver::register_message_handler().

Here is the call graph for this function:

◆ ~vrpn_Sound_Client()

vrpn_Sound_Client::~vrpn_Sound_Client ( )

Definition at line 878 of file vrpn_Sound.C.

Member Function Documentation

◆ LoadMaterial()

vrpn_int32 vrpn_Sound_Client::LoadMaterial ( const vrpn_int32 id,
const vrpn_MaterialDef material )

◆ LoadModel_local()

vrpn_int32 vrpn_Sound_Client::LoadModel_local ( const char * filename)

◆ LoadModel_remote()

vrpn_int32 vrpn_Sound_Client::LoadModel_remote ( const char * data)
Todo
Remote stuff not supported yet!

Definition at line 1216 of file vrpn_Sound.C.

◆ LoadPolyQuad()

vrpn_int32 vrpn_Sound_Client::LoadPolyQuad ( const vrpn_QuadDef quad)

◆ LoadPolyTri()

vrpn_int32 vrpn_Sound_Client::LoadPolyTri ( const vrpn_TriDef tri)

◆ loadSound()

vrpn_SoundID vrpn_Sound_Client::loadSound ( const char * sound,
const vrpn_SoundID id,
const vrpn_SoundDef soundDef )

◆ mainloop()

void vrpn_Sound_Client::mainloop ( )
virtual

Called once through each main loop iteration to handle updates. Remote object mainloop() should call client_mainloop() and then call d_connection->mainloop(). Server object mainloop() should service the device and then call server_mainloop(), but should not normally call d_connection->mainloop().

Implements vrpn_BaseClass.

Definition at line 1354 of file vrpn_Sound.C.

References vrpn_BaseClassUnique::client_mainloop(), vrpn_BaseClassUnique::d_connection, and vrpn_Connection::mainloop().

Here is the call graph for this function:

◆ playSound()

vrpn_int32 vrpn_Sound_Client::playSound ( const vrpn_SoundID id,
vrpn_int32 repeat )

◆ receiveTextMessage()

void vrpn_Sound_Client::receiveTextMessage ( const char * message,
vrpn_uint32 type,
vrpn_uint32 level,
struct timeval msg_time )
virtual

Definition at line 1367 of file vrpn_Sound.C.

◆ setListenerPose()

vrpn_int32 vrpn_Sound_Client::setListenerPose ( const vrpn_float64 position[3],
const vrpn_float64 orientation[4] )

◆ setListenerVelocity()

vrpn_int32 vrpn_Sound_Client::setListenerVelocity ( const vrpn_float64 velocity[4])

◆ setMaterialName()

vrpn_int32 vrpn_Sound_Client::setMaterialName ( const int id,
const char * materialname )

◆ setMaterialReflGain()

vrpn_int32 vrpn_Sound_Client::setMaterialReflGain ( const int id,
const vrpn_float64 reflectance_gain )

◆ setMaterialReflHF()

vrpn_int32 vrpn_Sound_Client::setMaterialReflHF ( const int id,
const vrpn_float64 reflectance_hf )

◆ setMaterialTransGain()

vrpn_int32 vrpn_Sound_Client::setMaterialTransGain ( const int id,
const vrpn_float64 transmittance_gain )

◆ setMaterialTransHF()

vrpn_int32 vrpn_Sound_Client::setMaterialTransHF ( const int id,
const vrpn_float64 transmittance_hf )

◆ setPolyMaterialName()

vrpn_int32 vrpn_Sound_Client::setPolyMaterialName ( const int id,
const char * materialname )

◆ setPolyOF()

vrpn_int32 vrpn_Sound_Client::setPolyOF ( const int id,
const vrpn_float64 OF )

◆ setQuadVertices()

vrpn_int32 vrpn_Sound_Client::setQuadVertices ( const int id,
const vrpn_float64 vertices[4][3] )

◆ setSoundConeInfo()

vrpn_int32 vrpn_Sound_Client::setSoundConeInfo ( const vrpn_SoundID id,
const vrpn_float64 inner_angle,
const vrpn_float64 outer_angle,
const vrpn_float64 gain )

◆ setSoundDistances()

vrpn_int32 vrpn_Sound_Client::setSoundDistances ( const vrpn_SoundID id,
const vrpn_float64 max_front_dist,
const vrpn_float64 min_front_dist,
const vrpn_float64 max_back_dist,
const vrpn_float64 min_back_dist )

◆ setSoundDopScale()

vrpn_int32 vrpn_Sound_Client::setSoundDopScale ( const vrpn_SoundID id,
vrpn_float64 dopfactor )

◆ setSoundEqValue()

vrpn_int32 vrpn_Sound_Client::setSoundEqValue ( const vrpn_SoundID id,
vrpn_float64 eq_value )

◆ setSoundPitch()

vrpn_int32 vrpn_Sound_Client::setSoundPitch ( const vrpn_SoundID id,
vrpn_float64 pitch )

◆ setSoundPose()

vrpn_int32 vrpn_Sound_Client::setSoundPose ( const vrpn_SoundID id,
vrpn_float64 position[3],
vrpn_float64 orientation[4] )

◆ setSoundVelocity()

vrpn_int32 vrpn_Sound_Client::setSoundVelocity ( const vrpn_SoundID id,
const vrpn_float64 velocity[4] )

◆ setSoundVolume()

vrpn_int32 vrpn_Sound_Client::setSoundVolume ( const vrpn_SoundID id,
const vrpn_float64 volume )

◆ setTriVertices()

vrpn_int32 vrpn_Sound_Client::setTriVertices ( const int id,
const vrpn_float64 vertices[3][3] )

◆ stopSound()

vrpn_int32 vrpn_Sound_Client::stopSound ( const vrpn_SoundID id)

◆ unloadSound()

vrpn_int32 vrpn_Sound_Client::unloadSound ( const vrpn_SoundID id)

The documentation for this class was generated from the following files: