//------------------------------------------------------------------------------
// 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 SCENE_LEAF_H_
#define SCENE_LEAF_H_

#include <Graphics/Scene/SceneObject.h>

namespace Lamp{

//------------------------------------------------------------------------------
/**
 * シーンリーフ
 */
class SceneLeaf : public SceneObject{
friend class SceneNode;
friend class LODSceneNode;
public:
	//--------------------------------------------------------------------------
	/**
	 * 親の取得
	 * @return 親
	 */
	virtual SceneNode* getParent() const{ return parent_; }

	/**
	 * リファレンスカウントの取得
	 * @return リファレンスカウント
	 */
	virtual int getReferenceCount() const{
		if(parent_ != NULL){ return 1; }
		return 0;
	}

	//--------------------------------------------------------------------------
	/**
	 * コピー
	 * @param copyMask コピーマスク
	 * @return コピーされたシーンリーフ
	 */
	virtual SceneLeaf* copy(u_int copyMask = 0) const = 0;

	/**
	 * 再帰的破棄
	 * @param leaf 破棄するシーンリーフ
	 * @return 破棄したオブジェクト数
	 */
	static int recursiveDestroy(SceneLeaf* leaf);

	//--------------------------------------------------------------------------
	// 有効、無効
	//--------------------------------------------------------------------------
	/**
	 * 有効、無効の設定
	 * @param enabled trueなら有効、falseなら無効
	 */
	virtual void setEnabled(bool enabled){ enabled_ = enabled; }

	/**
	 * 有効、無効の取得
	 * @return trueなら有効、falseなら無効
	 */
	virtual bool isEnabled() const{ return enabled_; }

	/**
	 * グローバルでの有効、無効の取得
	 * @return trueなら有効、falseなら無効
	 */
	virtual bool isGlobalEnabled() const{ return globalEnabled_; }

	//--------------------------------------------------------------------------
	// RTTI
	//--------------------------------------------------------------------------
	/**
	 * シーンリーフかどうか
	 * @return シーンリーフならtrue
	 */
	virtual bool isSceneLeaf() const{ return true; }

protected:
	//--------------------------------------------------------------------------
	/**
	 * コンストラクタ
	 * @param name 名前
	 * @param scene シーン
	 */
	SceneLeaf(const String& name, Scene* scene);

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

	//--------------------------------------------------------------------------
	/**
	 * 走査
	 * @param parentMatrix 親行列
	 * @param parentEnabled 親が有効か
	 * @param parentScaled 親がスケールを使用しているか
	 * @param parentChanged 親に変更があったか
	 */
	virtual void traverse(const Matrix34& parentMatrix, bool parentEnabled,
		bool parentScaled, bool parentChanged);

	//--------------------------------------------------------------------------
	/**
	 * 親の設定
	 * @param parent 設定する親
	 */
	virtual void setParent(SceneNode* parent){
		Assert(parent != NULL);
		Assert(parent_ == NULL);
		parent_ = parent;
		globalEnabled_ = false;
	}

	/**
	 * 親の削除
	 * @param parent 削除する親
	 */
	virtual void removeParent(SceneNode* parent){
		Assert(parent_ != NULL);
		Assert(parent_ == parent);
		parent_ = NULL;
		globalEnabled_ = false;
	}

	/**
	 * シーンリーフの値コピー
	 * @param destination コピー先シーンリーフ
	 */
	virtual void copySceneLeafValue(SceneLeaf* destination) const;

private:
	//--------------------------------------------------------------------------
	// 親
	SceneNode* parent_;
	// 有効、無効フラグ
	bool enabled_;
	// グローバルでの有効無効フラグ
	bool globalEnabled_;


};

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