Logo Search packages:      
Sourcecode: blender version File versions  Download package

AUD_VolumeFactory.h

/*
 * $Id$
 *
 * ***** BEGIN LGPL LICENSE BLOCK *****
 *
 * Copyright 2009 Jörg Hermann Müller
 *
 * This file is part of AudaSpace.
 *
 * AudaSpace is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AudaSpace 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with AudaSpace.  If not, see <http://www.gnu.org/licenses/>.
 *
 * ***** END LGPL LICENSE BLOCK *****
 */

#ifndef AUD_VOLUMEFACTORY
#define AUD_VOLUMEFACTORY

#include "AUD_EffectFactory.h"

/**
 * This factory changes the volume of another factory.
 * The set volume should be a value between 0.0 and 1.0, higher values at your
 * own risk!
 */
00036 class AUD_VolumeFactory : public AUD_EffectFactory
{
private:
      /**
       * The volume.
       */
00042       float m_volume;

public:
      /**
       * Creates a new volume factory.
       * \param factory The input factory.
       * \param volume The desired volume.
       */
      AUD_VolumeFactory(AUD_IFactory* factory = 0, float volume = 1.0);

      /**
       * Creates a new volume factory.
       * \param volume The desired volume.
       */
      AUD_VolumeFactory(float volume);

      /**
       * Returns the volume.
       */
      float getVolume();

      /**
       * Sets the volume.
       * \param volume The new volume value. Should be between 0.0 and 1.0.
       */
      void setVolume(float volume);

      virtual AUD_IReader* createReader();
};

#endif //AUD_VOLUMEFACTORY

Generated by  Doxygen 1.6.0   Back to index