Gizmo3D

gzAudioListener.h

Go to the documentation of this file.
00001 //*****************************************************************************
00002 // File         : gzAudioListener.h
00003 // Module       : 
00004 // Description  : Class definition of the gzAudioListener class
00005 // Author       : Anders Modén      
00006 // Product      : Gizmo3D 2.1.1
00007 //      
00008 // Copyright © 2003- Saab Training Systems AB, Sweden
00009 //          
00010 // NOTE:    Gizmo3D is a high performance 3D Scene Graph and effect visualisation 
00011 //          C++ toolkit for Linux, Mac OS X, Windows (Win32) and IRIX® for  
00012 //          usage in Game or VisSim development.
00013 //
00014 //
00015 // Revision History...                          
00016 //                                  
00017 // Who  Date    Description                     
00018 //                                  
00019 // AMO  060801  Created file    
00020 //
00021 //******************************************************************************
00022 #ifndef __GZ_AUDIO_LISTENER_H__
00023 #define __GZ_AUDIO_LISTENER_H__
00024 
00030 #include "gzNode.h"
00031 #include "gzCamera.h"
00032 
00033 //******************************************************************************
00034 // Class    : gzAudioListener
00035 //                                  
00036 // Purpose  : -
00037 //                                  
00038 // Notes    : - 
00039 //                                  
00040 // Revision History...                          
00041 //                                  
00042 // Who  Date    Description                     
00043 //                                  
00044 // AMO  060801  Created 
00045 //                                  
00046 //******************************************************************************
00047 class gzAudioListener : public gzNode
00048 {
00049 public:
00050     GZ_GRAPH_EXPORT gzAudioListener(const gzString &name=GZ_EMPTY_STRING);
00051 
00052     GZ_GRAPH_EXPORT virtual ~gzAudioListener(){};
00053 
00054     GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_GRAPH_EXPORT);  // typed interface
00055 
00056     // ---------- Common graph functions --------------------------------
00057 
00058     GZ_GRAPH_EXPORT virtual gzVoid updateNode();
00059 
00060     // ---------- Clone interface ---------------------------------------
00061     GZ_GRAPH_EXPORT virtual gzReference* clone() const;
00062 
00063     // ---------- gzAudioListener commands ------------------------------
00064 
00065     GZ_GRAPH_EXPORT gzVoid  followCamera(gzCamera *camera,gzBool updateCameraScene=TRUE);
00066 
00067     GZ_GRAPH_EXPORT gzBool  setPosition(const gzVec3 &position , gzBool immediate=FALSE);
00068     GZ_GRAPH_EXPORT gzBool  setOrientation(gzReal heading,gzReal pitch,gzReal roll,gzBool immediate=FALSE);
00069     GZ_GRAPH_EXPORT gzBool  setDirection(const gzVec3 &targetvector, gzReal roll , const gzVec3 &up=gzVec3(0,1,0),gzBool immediate=FALSE);
00070 
00071     GZ_GRAPH_EXPORT gzBool  setGain(gzFloat gain=1.0f, gzBool immediate=FALSE);
00072     
00073 
00074     // ---------- Action Interface --------------------------------------
00075 
00076     GZ_GRAPH_EXPORT virtual gzVoid preTraverseAction( gzTraverseAction *actionclass , gzContext *context);
00077 
00078 protected:
00079 
00080     gzRefPointer<gzCamera>  m_followCam;
00081 
00082     gzVec3                  m_position;
00083     gzVec3                  m_orientation;
00084     gzFloat                 m_gain;
00085 };
00086 
00087 
00088 
00089 #endif // __GZ_AUDIO_LISTENER_H__
00090 

Documentation for Gizmo3D generated at Wed Feb 20 11:54:02 2008 by   Saab Training Systems AB, ¸ (c) 2003-and beyond