Skeleton Loaderの書き込み

Custom Skeletonフォーマットを使用したい場合は、新しいSkeleton Loaderを使用してAtomsを拡張することができます。新しいSkeletonフォーマットを追加するには、

Atoms :: BaseSkeletonLoaderを拡張した新しいクラス定義を作成する必要があります。

その後、Atomsプラグインの中から新しいローダークラスを登録する必要があります。


クラス定義

#include <Atoms/Globals.h>
#include <AtomsCore/Metadata/MapMetadata.h>
#include <Atoms/Loaders/BaseSkeletonLoader.h>

#define kFooSkeletonLoaderId 101

namespace Atoms
{
	class ATOMSPLUGIN_EXPORT FooSkeletonLoader : public BaseSkeletonLoader
	{
	public:
		//! Type string
		/*!
		\return Class type string
		*/
		std::string typeStr() const;

		//! Class static type string. This is also the file extension of your file format
		static std::string const staticTypeStr;

		//! Type id
		/*!
		\return Class type id
		*/
		unsigned int typeId() const;

		//! Class static type id
		static const unsigned int staticTypeId;

		//! Constructor
		FooMeshLoader();

		//! Destructor
		~FooMeshLoader();

		//! Creator function
		/*!
		\return Return a new AlembicMeshLoader object
		*/
		static AtomsPtr<BaseMeshLoader> creator();

		//! load
		/*!
		Load an atoms file
		*/
		AtomsPtr<AtomsCore::MapMetadata> load(const std::string &filePath, const std::string& filter = "*");
	};
}

namespace Atoms
{
std::string const FooSkeletonLoader::staticTypeStr = "foo"; // the file extension

std::string FooSkeletonLoader::typeStr() const
{
	return FooSkeletonLoader::staticTypeStr;
}

const unsigned int FooSkeletonLoader::staticTypeId = kFooSkeletonLoaderId ;

unsigned int FooSkeletonLoader::typeId() const
{
	return FooSkeletonLoader::staticTypeId;
}

FooSkeletonLoader::FooSkeletonLoader() :
	BaseMeshLoader()
{
}

FooMeshLoader::~FooMeshLoader()
{
}

AtomsPtr<BaseMeshLoader> FooSkeletonLoader::creator()
{
	return std::dynamic_pointer_cast<BaseSkeletonLoader>(std::make_shared<FooSkeletonLoader>());
}

AtomsCore::Skeleton FooSkeletonLoader::load(const std::string &filePath)
{
	// This is the actual loader that atoms use to load the atomsskel
	// Change it to support your custom format
	// If the skeleton is not valid, always return a valid skeleton like in this example
	AtomsCore::Skeleton skel(1);
	AtomsCore::Archive skinGeoArc;
	if (!skinGeoArc.readFromFile(filePath))
	{
		AtomsUtils::Logger::warning() << "Could not read " << filePath;
		AtomsUtils::Logger::warning() << "Creating default skeleton";
		skel.addPelvis(0);
		skel.setRoot(0);
		skel.joint(0).setName("root");
		skel.buildIkData();
		skel.buildDetachedJointsList();
		skel.buildJointNameMap();
		return skel;
	}
	skinGeoArc >> skel;
	return std::move(skel);
}
}


Atomsは、load関数を呼び出して新しいSkeletonフォーマットを読み込みます。この関数は、Skeletonオブジェクトを入れて返す必要があります。
新しいloaderをAtomsに登録します。

extern "C"
{
	ATOMSPLUGIN_EXPORT bool initializePlugin()
	{
		SkeletonLoaderFactory& factory = SkeletonLoaderFactory::instance();
		factory.registerSkeletonLoader(FooSkeletonLoader::staticTypeStr, &FooSkeletonLoader::creator);
	}
}


Behaviour モジュールをコンパイルする

loaderは、プロシージャルでも使用されているので、新しいプラグインを2回コンパイルする必要があります。 Atoms.so / libライブラリへの初めてのリンクと、 2回目はAtomsProcedural.so / libライブラリにリンクします。


Windows:

Visual Studioでdllプロジェクトを作成し、atom、tbbおよびopenexr includesを追加して、BUILD_ATOMSPLUGIN、WIN、_CRT_ECURE_NO_WARNINGS、_CRT_N NSTDC_NO_DEPRECATE、およびFBXSDK SHAREDをプリプロセッサ定義に追加します。
次に、別のターゲットを作成し、Atomsをリンクする代わりにAtomsProceduralをリンクします。



Linux:

Atoms、tbbおよびopendexr includesとBUILD_ATOMSPLUGINをプリプロセッサ定義に追加して、共有オブジェクトとしてコンパイルします。
次に、別のターゲットを作成し、Atomsをリンクする代わりにAtomsProceduralをリンクします。


プラグインの使用

ATOMS_PLUGINS_PATH環境変数では、Atomsに対して、ライブラリがコンパイルされるフォルダが追加され、AtomsProceduralに対して、コンパイルされたライブラリが配置されるパスがATOMS_PROCEDURAL_PLUGINS_ATH env変数に追加されます。

Copyright © 2017, Toolchefs LTD.