pssoundsector.h

Go to the documentation of this file.

/*
 * pssoundsector.h
 *
 * Copyright (C) 2001-2010 Atomic Blue (info@planeshift.it, http://www.planeshift.it)
 *
 * Credits : Mathias 'AgY' Voeroes <agy@operswithoutlife.net>
 *           and all past and present planeshift coders
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef _PSSOUNDSECTOR_H_
#define _PSSOUNDSECTOR_H_

//====================================================================================
// Crystal Space Includes
//====================================================================================
#include <csutil/hash.h>
#include <csutil/csstring.h>
#include <csgeom/vector3.h>

//------------------------------------------------------------------------------------
// Forward Declarations
//------------------------------------------------------------------------------------
class psMusic;
class psEntity;
class psEmitter;
class SoundControl;
class GEMClientActor;
struct iMeshWrapper;
struct iDocumentNode;

class psSoundSector
{
public:
    csString                     name;               
    bool                         active;             
    psMusic*                     activeambient;      
    psMusic*                     activemusic;        
    csArray<psMusic*>            ambientarray;       
    csArray<psMusic*>            musicarray;         
    csArray<psEmitter*>          emitterarray;       
    csHash<psEntity*, csString>  factories;          
    csHash<psEntity*, csString>  meshes;             
    csHash<psEntity*, uint>      tempEntities;       

    psSoundSector(iObjectRegistry* objectReg);

    psSoundSector(csRef<iDocumentNode> sectorNode, iObjectRegistry* objectReg);

    ~psSoundSector();
    void AddAmbient(csRef<iDocumentNode> Node);
    void UpdateAmbient(int type, SoundControl* &ctrl);
    void DeleteAmbient(psMusic* &ambient);
    void AddMusic(csRef<iDocumentNode> Node);
    void UpdateMusic(bool loopToggle, int type, SoundControl* &ctrl);
    void DeleteMusic(psMusic* &music);

    void AddEmitter(csRef<iDocumentNode> Node);

    void UpdateAllEmitters(SoundControl* &ctrl);

    void UpdateAllEntities(SoundControl* &ctrl);

    void DeleteEmitter(psEmitter* &emitter);
    void AddEntityDefinition(csRef<iDocumentNode> entityNode);

    void UpdateEntity(iMeshWrapper* mesh, const char* meshName, SoundControl* &ctrl);
    void DeleteEntity(psEntity* &entity);

    void AddObjectEntity(iMeshWrapper* mesh, const char* meshName);

    void RemoveObjectEntity(iMeshWrapper* mesh, const char* meshName);



    void SetEntityState(int state, iMeshWrapper* mesh, const char* actorName, bool forceChange);

    void Load(csRef<iDocumentNode> sectorNode);
    void Reload(csRef<iDocumentNode> sector);
    void Delete();

private:
    iObjectRegistry* objectReg;

    psEntity* GetAssociatedEntity(iMeshWrapper* mesh, const char* meshName) const;
};

#endif /*_PSSOUNDSECTOR_H_*/