//------------------------------------------------------------------------------
// 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
 * Mayaアトリビュートユーティリティヘッダ
 * @author Junpee
 */

#ifndef MAYA_ATTRIBUTE_UTILITY_H_
#define MAYA_ATTRIBUTE_UTILITY_H_

namespace LampForMaya{

//------------------------------------------------------------------------------
/**
 * Mayaアトリビュートユーティリティ
 */
class MayaAttributeUtility{
public:
	//--------------------------------------------------------------------------
	// アトリビュートの取得
	//--------------------------------------------------------------------------
	/**
	 * アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static MObject getAttribute(
		const MObject& node, const String& attributeName);

	/**
	 * プラグの取得
	 * @param node アトリビュートを持つノード
	 * @param plugName プラグ名
	 */
	static MPlug getPlug(
		const MObject& node, const String& plugName);

	//--------------------------------------------------------------------------
	/**
	 * ブールアトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static bool getBool(const MObject& node, const MObject& attribute);

	/**
	 * ブールアトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static bool getBool(const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------
	/**
	 * 整数アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static int getInt(const MObject& node, const MObject& attribute);

	/**
	 * 整数アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static int getInt(const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------
	/**
	 * 実数アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static float getFloat(const MObject& node, const MObject& attribute);

	/**
	 * 実数アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static float getFloat(const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------
	/**
	 * 文字列アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static String getString(const MObject& node, const MObject& attribute);

	/**
	 * 文字列アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static String getString(const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------
	/**
	 * 実数三要素カラーアトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static Color3f getColor3f(
		const MObject& node, const MObject& attribute);

	/**
	 * 実数三要素カラーアトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static Color3f getColor3f(
		const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------
	/**
	 * ベクトルアトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static Vector3 getVector(
		const MObject& node, const MObject& attribute);

	/**
	 * ベクトルアトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static Vector3 getVector(
		const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------
	/**
	 * 行列アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attribute アトリビュート
	 */
	static Matrix44 getMatrix(
		const MObject& node, const MObject& attribute);

	/**
	 * 行列アトリビュートの取得
	 * @param node アトリビュートを持つノード
	 * @param attributeName アトリビュート名
	 */
	static Matrix44 getMatrix(
		const MObject& node, const String& attributeName);

	//--------------------------------------------------------------------------

private:
	// コンストラクタの隠蔽
	MayaAttributeUtility();

};

//------------------------------------------------------------------------------
} // End of namespace LampForMaya
#endif // End of MAYA_ATTRIBUTE_UTILITY_H_
//------------------------------------------------------------------------------

