psentity.h

Go to the documentation of this file.

/*
 * psentity.h
 *
 * Copyright (C) 2001-2010 Atomic Blue (info@planeshift.it, http://www.planeshift.it)
 *
 * Credits : Andrea Rizzi <88whacko@gmail.com>
 *           Saul Leite <leite@engineer.com>
 *           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 _PSENTITY_H_
#define _PSENTITY_H_


#define DEFAULT_ENTITY_STATE 0
#define UNDEFINED_ENTITY_STATE -1

class psEntity
{
public:
    psEntity(bool isFactoryEntity, const char* entityName);

    ~psEntity();

    psEntity(psEntity* const &entity);

    bool IsFactoryEntity() const
    {
        return isFactoryEntity;
    }

    const csString &GetEntityName() const
    {
        return entityName;
    }

    void SetAsMeshEntity(const char* meshName);

    void SetAsFactoryEntity(const char* factoryName);

    float GetMaxRange() const
    {
        return maxRange;
    }

    void SetRange(float minRange, float maxRange);

    uint GetMeshID() const;

    void SetMeshID(uint id);

    csVector3 GetPosition()
    {
        return position;
    };

    bool DefineState(csRef<iDocumentNode> stateNode);

    bool IsActive() const
    {
        return isActive;
    }

    void SetActive(bool toggle)
    {
        isActive = toggle;
    }

    bool IsTemporary() const;

    bool IsPlaying() const;

    bool CanPlay(int time, float range) const;

    int GetState()
    {
        return state;
    };

    void SetState(int state, bool forceChange, bool setReady);

    bool Play(SoundControl* &ctrl, csVector3 entityPosition);

    void Stop();

    void Update(int time, float distance, int interval, SoundControl* &ctrl,
                csVector3 entityPosition);

private:
    struct EntityState
    {
        csStringArray resources;    
        float volume;               
        float probability;          
        int delay;                  
        int timeOfDayStart;         
        int timeOfDayEnd;           

        int fallbackState;          
        float fallbackProbability;  

        int references;             
    };

    bool isActive;                      

    bool isFactoryEntity;               
    csString entityName;                

    int state;                         
    int when;                           
    uint id;                            
    float minRange;                     
    float maxRange;                     
    csVector3      position;            

    SoundHandle* handle;                
    csHash<EntityState*, uint> states;  

    static void StopCallback(void* object);
};

#endif /*_PSENTITY_H_*/