Planeshift

pseffectobjsound.h

Go to the documentation of this file.
00001 /*
00002  * Author: Andrew Robberts
00003  *
00004  * Copyright (C) 2003 Atomic Blue ([email protected], http://www.atomicblue.org)
00005  *
00006  *
00007  * This program is free software; you can redistribute it and/or
00008  * modify it under the terms of the GNU General Public License
00009  * as published by the Free Software Foundation (version 2 of the License)
00010  * This program is distributed in the hope that it will be useful,
00011  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013  * GNU General Public License for more details.
00014  * You should have received a copy of the GNU General Public License
00015  * along with this program; if not, write to the Free Software
00016  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
00017  *
00018  */
00019 
00020 #ifndef PS_EFFECT_OBJ_SOUND_HEADER
00021 #define PS_EFFECT_OBJ_SOUND_HEADER
00022 
00023 #include "pseffectobj.h"
00024 
00025 class psEffect2DRenderer;
00026 struct iSoundManager;
00027 
00032 class psEffectObjSound : public psEffectObj
00033 {
00034 public:
00035 
00036     psEffectObjSound(iView* parentView, psEffect2DRenderer* renderer2d);
00037     ~psEffectObjSound();
00038 
00039     // inheritted function overloads
00040     bool Load(iDocumentNode* node, iLoaderContext* ldr_context);
00041     bool Render(const csVector3 &up);
00042     bool Update(csTicks elapsed);
00043     bool AttachToAnchor(psEffectAnchor* newAnchor);
00044     psEffectObj* Clone() const;
00045 
00046 
00047 private:
00048 
00052     bool PostSetup();
00053 
00054     csRef<iSoundManager> soundManager;
00055     csString soundName;
00056     uint soundID;
00057 
00058     float minDist;
00059     float maxDist;
00060 
00061     csString effectID;
00062 
00063     float volumeMultiplier;
00064     bool loop;
00065     bool playedOnce;
00066 };
00067 
00070 #endif