//------------------------------------------------------------------------------
// Lamp : Open source game middleware
// Copyright (C) 2004  Junpei Ohtani ( Email : junpee@users.sourceforge.jp )
//
// This library 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 2.1 of the License, or (at your option) any later version.
//
// This library 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 this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//------------------------------------------------------------------------------

/** @file
 * サウンドリスナヘッダ
 * @author Junpee
 */

#ifndef SOUND_LISTENER_H_
#define SOUND_LISTENER_H_

namespace Lamp{

//------------------------------------------------------------------------------
/**
 * サウンドリスナ
 */
class SoundListener{
friend class LampSound;
public:
	//--------------------------------------------------------------------------
	/**
	 * 位置の設定
	 * @param position 位置
	 */
	virtual void setPosition(const Vector3& position);

	/**
	 * 位置の取得
	 * @return 位置
	 */
	virtual const Vector3& getPosition() const{ return position_; }

	//--------------------------------------------------------------------------
	/**
	 * 速度の設定
	 * @param velocity 速度
	 */
	virtual void setVelocity(const Vector3& velocity);

	/**
	 * 速度の取得
	 * @return 速度
	 */
	virtual const Vector3& getVelocity() const{ return velocity_; }

	//--------------------------------------------------------------------------
	/**
	 * 位置と速度の設定
	 * @param position 位置
	 * @param millisecond 前回からの時間をミリ秒で設定
	 */
	virtual void setPositionAndVelocity(
		const Vector3& position, float millisecond);

	//--------------------------------------------------------------------------
	/**
	 * 方向の設定
	 * @param frontDirection 前方向
	 * @param upDirection 上方向
	 */
	virtual void setDirection(
		const Vector3& frontDirection, const Vector3& upDirection);

	/**
	 * 前方向の取得
	 * @return 前方向
	 */
	virtual const Vector3& getFrontDirection() const{ return frontDirection_; }

	/**
	 * 上方向の取得
	 * @return 上方向
	 */
	virtual const Vector3& getUpDirection() const{ return upDirection_; }

	//--------------------------------------------------------------------------
	/**
	 * 距離係数の設定
	 *
	 * デフォルト値はSoundDefinitionで定義されています。
	 * @param distanceFactor 距離係数
	 */
	virtual void setDistanceFactor(float distanceFactor);

	/**
	 * 距離係数の取得
	 *
	 * デフォルト値はSoundDefinitionで定義されています。
	 * @return 距離係数
	 */
	virtual float getDistanceFactor() const{ return distanceFactor_; }

	//--------------------------------------------------------------------------
	/**
	 * ロールオフ係数の設定
	 * @param rolloffFactor ロールオフ係数
	 */
	virtual void setRolloffFactor(float rolloffFactor);

	/**
	 * ロールオフ係数の取得
	 * @return ロールオフ係数
	 */
	virtual float getRolloffFactor() const{ return rolloffFactor_; }

	//--------------------------------------------------------------------------
	/**
	 * ドップラー係数の設定
	 * @param dopplerFactor ドップラー係数
	 */
	virtual void setDopplerFactor(float dopplerFactor);

	/**
	 * ドップラー係数の取得
	 * @return ドップラー係数
	 */
	virtual float getDopplerFactor() const{ return dopplerFactor_; }

	//--------------------------------------------------------------------------
	/**
	 * 文字列への変換
	 * @return 文字列
	 */
	virtual String toString() const;

	//--------------------------------------------------------------------------
	/**
	 * 3D設定の適用
	 *
	 * 通常はLampSound::presentation()から呼ばれます。
	 */
	virtual void apply3DSettings();

private:
	//--------------------------------------------------------------------------
	/**
	 * コンストラクタ
	 * @param primaryBuffer プライマリバッファ
	 */
	SoundListener(DirectSoundPrimaryBuffer* primaryBuffer);

	/**
	 * デストラクタ
	 */
	virtual ~SoundListener();

	//--------------------------------------------------------------------------
	// コピーコンストラクタの隠蔽
	SoundListener(const SoundListener& copy);

	// 代入コピーの隠蔽
	void operator =(const SoundListener& copy);

	// リスナ
	DirectSound3DListener* listener_;
	// 位置
	Vector3 position_;
	// 速度
	Vector3 velocity_;
	// 前方向
	Vector3 frontDirection_;
	// 上方向
	Vector3 upDirection_;
	// 距離係数
	float distanceFactor_;
	// ロールオフ係数
	float rolloffFactor_;
	// ドップラー係数
	float dopplerFactor_;

};

//------------------------------------------------------------------------------
} // End of namespace Lamp
#endif // End of SOUND_LISTENER_H_
//------------------------------------------------------------------------------
