/****************************************************************************
 *
 *	Copyright (c) 1999-2012, Fine Kernel Project, All rights reserved.
 *
 *	Redistribution and use in source and binary forms,
 *	with or without modification, are permitted provided that the
 *	following conditions are met:
 *
 *		- Redistributions of source code must retain the above
 *			copyright notice, this list of conditions and the
 *			following disclaimer.
 *
 *		- Redistributions in binary form must reproduce the above
 *			copyright notice, this list of conditions and the
 *			following disclaimer in the documentation and/or
 *			other materials provided with the distribution.
 *
 *		- Neither the name of the copyright holders nor the names
 *			of its contributors may be used to endorse or promote
 *			products derived from this software without specific
 *			prior written permission.
 *
 *	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 *	FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 *	COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 *	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *	(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *	SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *	HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 *	STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 *	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *	POSSIBILITY OF SUCH DAMAGE. 
 *
 ****************************************************************************/
/****************************************************************************
 *
 *	Copyright (c) 1999-2012, Fine Kernel Project, All rights reserved.
 *
 *	本ソフトウェアおよびソースコードのライセンスは、基本的に
 *	「修正 BSD ライセンス」に従います。以下にその詳細を記します。
 *
 *	ソースコード形式かバイナリ形式か、変更するかしないかを問わず、
 *	以下の条件を満たす場合に限り、再頒布および使用が許可されます。
 *
 *	- ソースコードを再頒布する場合、上記の著作権表示、本条件一覧、
 *		および下記免責条項を含めること。
 *
 *	- バイナリ形式で再頒布する場合、頒布物に付属のドキュメント等の
 *		資料に、上記の著作権表示、本条件一覧、および下記免責条項を
 *		含めること。
 *
 *	- 書面による特別の許可なしに、本ソフトウェアから派生した製品の
 *		宣伝または販売促進に、本ソフトウェアの著作権者の名前または
 *		コントリビューターの名前を使用してはならない。
 *
 *	本ソフトウェアは、著作権者およびコントリビューターによって「現
 *	状のまま」提供されており、明示黙示を問わず、商業的な使用可能性、
 *	および特定の目的に対する適合性に関す暗黙の保証も含め、またそれ
 *	に限定されない、いかなる保証もないものとします。著作権者もコン
 *	トリビューターも、事由のいかんを問わず、損害発生の原因いかんを
 *	問わず、かつ責任の根拠が契約であるか厳格責任であるか(過失その
 *	他の)不法行為であるかを問わず、仮にそのような損害が発生する可
 *	能性を知らされていたとしても、本ソフトウェアの使用によって発生
 *	した(代替品または代用サービスの調達、使用の喪失、データの喪失、
 *	利益の喪失、業務の中断も含め、またそれに限定されない)直接損害、
 *	間接損害、偶発的な損害、特別損害、懲罰的損害、または結果損害に
 *	ついて、一切責任を負わないものとします。
 *
 ****************************************************************************/
#ifndef __FK_TOPOLOGY_HEADER__
#define __FK_TOPOLOGY_HEADER__

#include <FK/Base.h>
#include <FK/Attribute.h>
#include <FK/Palette.h>

typedef char	   	fk_TopologyType;

const fk_TopologyType	FK_VERTEX_TYPE = 1;
const fk_TopologyType	FK_HALF_TYPE = 2;
const fk_TopologyType	FK_EDGE_TYPE = 3;
const fk_TopologyType	FK_LOOP_TYPE = 4;
const fk_TopologyType	FK_INDEXFACE_TYPE = 6;
const fk_TopologyType	FK_UNDEFINED_TYPE = -1;


//! ソリッドモデル位相要素用基底クラス
/*!
 *	このクラスは、 fk_Solid における位相要素の共通部分に関する機能を提供します。
 *	FK におけるソリッドモデルの構造については、
 *	ユーザーズマニュアルの「形状に対する高度な操作」の章を参照して下さい。
 *	\sa fk_Solid, fk_Vertex, fk_Half, fk_Edge, fk_Loop, fk_TopologyMaterial
 */

class fk_Topology : public fk_Attribute, public fk_BaseObject {

 private:
	int					ID;
	bool				ariveFlg;
	fk_TopologyType		type;
	void				SetType(fk_TopologyType);
	
 protected:

#ifndef FK_DOXYGEN_USER_PROCESS

	void				SetID(int);
	void				InitTopology(int, fk_TopologyType);


	void				DeleteElem(void);
	void				MakeElem(int);
	bool				CloneElem(fk_Topology *);

#endif

 public:
	//! コンストラクタ
	fk_Topology(void);
	//! デストラクタ
	virtual ~fk_Topology();

	//! ID取得関数
	/*!
	 *	\return 位相要素ID
	 */
	int		getID(void) const;

	//! 位相タイプ取得関数
	/*!
	 *	位相タイプを返します。返り値は以下のいずれかとなります。
	 *
	 *	\retval FK_VERTEX_TYPE		頂点を表します。
	 *	\retval FK_HALF_TYPE		半稜線を表します。
	 *	\retval FK_EDGE_TYPE		稜線を表します。
	 *	\retval FK_LOOP_TYPE		ループを表します。
	 *	\retval FK_INDEXFACE_TYPE	インデックスフェースセットを表します。
	 *	\retval FK_UNDEFINED_TYPE	未定義な位相要素を表します。
	 */
	fk_TopologyType		getType(void) const;
};


//! 位相要素個別マテリアル管理クラス
/*!
 *	このクラスは、 fk_Solid における位相要素について、
 *	個別にマテリアルを管理する機能を提供します。
 *
 *	fk_Solid による1つの形状内で、
 *	各位相要素について別々にマテリアルを設定したい場合は、
 *	このクラスのメンバ関数を用います。
 *
 *	\sa fk_Solid, fk_Vertex, fk_Edge, fk_Loop, fk_Topology, fk_Shape, fk_Model
 */
class fk_TopologyMaterial {

	friend class		fk_DataBase;

 private:
	int					mateID;
	fk_MaterialMode		mateMode;

	void				CloneMaterial(fk_TopologyMaterial *);

 public:
	//! コンストラクタ
	fk_TopologyMaterial(void);

	//! デストラクタ
	virtual ~fk_TopologyMaterial();

	//! マテリアルモード設定関数
	/*!
	 *	各位相要素の描画の際に、個別のマテリアルを利用するかどうかを設定します。
	 *	fk_Solid による形状では、
	 *	個別マテリアルを有効とするのには以下の条件を満たす必要があります。
	 *	- fk_Model にてマテリアルモードが FK_PARENT_MODE になっている。
	 *		(fk_Model::setMaterialMode() を参照して下さい。)
	 *	- fk_Solid にてマテリアルモードが FK_PARENT_MODE になっている。
	 *		(fk_Shape::setMaterialMode() を参照して下さい。)
	 *	.
	 *	上記の条件を満たさない場合、個別のマテリアル設定の有無に関わらず
	 *	全ての位相要素がモデルに設定されたマテリアルによって描画を行います。
	 *
	 *	\param[in] mode
	 *		前述の条件を前提として、位相要素のマテリアルを以下のように設定します。
	 *		\arg FK_CHILD_MODE		個別設定を利用します。
	 *		\arg FK_PARENT_MODE		モデル設定を利用します。
	 *		\arg FK_NONE_MODE		描画を行いません。
	 */
	void				setElemMaterialMode(fk_MaterialMode mode);

	//!	マテリアルID設定関数
	/*!
	 *	位相要素の個別マテリアルを、パレットの ID によって設定します。
	 *	パレットに関する解説は
	 *	fk_Shape::setPalette() や fk_Shape::pushPalette() を参照して下さい。
	 *	\param[in] ID	マテリアルの ID
	 */
	void				setElemMaterialID(int ID);

	//! マテリアルモード参照関数
	/*!
	 *	現在のマテリアルモードを参照します。
	 *	\return マテリアルモード
	 */
	fk_MaterialMode		getElemMaterialMode(void);

	//! マテリアル ID 参照関数
	/*!
	 *	現在のマテリアル ID を参照します。
	 *	\return マテリアル ID
	 */
	int					getElemMaterialID(void);
};

#endif // !__FK_TOPOLOGY_HEADER__
