{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Metadatas are one of the basic entities in Atoms. They wrap basic data types and inherit the basic object AtomsCore::Metadata.","type":"text"}]},{"type":"paragraph","content":[{"text":"The basic Metadata class has functions to clone, copy, serialize etc.","type":"text"}]},{"type":"paragraph","content":[{"text":"These are the basic metadata type that can be used inside Atoms:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BoolMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"BoolArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IntMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"IntArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DoubleMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"DoubleArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Vector3Metadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Vector3ArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"EulerMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"EulerArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"QuaternionMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"QuaternionArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MatrixMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MatrixArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CurveMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"CurveArrayetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MeshMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MeshArrayMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ImageMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"PoseMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"SkeletonMetadata","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"These are container metadata types:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"MapMetadata","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ArrayMetadata","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Unreal Specific metadata:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UnrealObjectMetadata (value is a TWeakObjectPtr - declared inside AtomsObjectMetadata.h)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"UnrealObjectArrayMetadata (Array of TWeakObjectPtr - declared inside AtomsObjectMetadata.h)","type":"text"},{"type":"hardBreak"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creating metadatas","type":"text"}]},{"type":"paragraph","content":[{"text":"You can create metadatas using the constructor of each type or you can use the metadata factory. Every metadata type has a unique typeId, it's used to register the metadata inside the metadata factory. Since the serialization code relies on this factory.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"AtomsCore::IntMetadata intMeta(5);\nAtomsCore::DoubleMetadata doubleMeta(654.4);\n\nAtomsCore::MetadataFactory& factory = AtomsCore::MetadataFactory::instance();\nAtomsPtr data = factory.createMetadata(AtomsCore::Vector3Metadata::staticTypeId());","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"MapMetada","type":"text"}]},{"type":"paragraph","content":[{"text":"The MapMetadata is a map container for metadatas. It can store different metadata types at the same time. It uses strings as keys.","type":"text"}]},{"type":"paragraph","content":[{"text":"To insert data inside a MapMetadata use the addEntry function. This function can clone the input metadata or store directly the input smart pointer, increasing the reference counter.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"AtomsCore::MapMetadata mapMeta;\n// Insert element cloning the data\nmapMeta.addEnetry(\"myKey1\", &AtomsCore::IntMetadata(4));\n\nAtomsPtr doubleMeta(new AtomsCore::DoubleMetadata(5.7));\n// Insert element cloning the data\nmapMeta.addEntry(\"myKey2\", std::static_pointer_cast(doubleMeta), true);\n\nAtomsPtr vecMeta(new AtomsCore::Vector3Metadata(AtomsCore::Vector3(1,0,0));\n// Insert element without cloning, copying the smart pointer and increasing the reference counter\nmapMeta.addEntry(\"myKey3\", std::static_pointer_cast(vecMeta), false);","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"text":"To get an entry from the map, use the getEntry or getTypedEntry function","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"AtomsPtr vecData = mapMeta.getTypedEntry(\"myKey3\");\nAtomsPtr intData = mapMeta.getEntry(\"myKey1\");","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"ArrayMetadata","type":"text"}]},{"type":"paragraph","content":[{"text":"The array metadata is similar to the MapMetadata but it stores metadata in a vector rather than a map.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Creating a new metadata type","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a new metadata type you must inherit the base Metadata class and register the new type in the metadata factory.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"c++"},"content":[{"text":"#include \n\nclass FooData\n{\npublic:\n\tfloat a;\n\tdouble b;\n\tchar c;\n};\n\ntypedef AtomsCore::MetadataImpl FooMetadata;\ntemplate<> bool AtomsCore::MetadataImpl::serialise(Archive& outStream) const;\ntemplate<> bool AtomsCore::MetadataImpl::deserialise(Archive& inStream);\ntemplate<> size_t MetadataImpl::memSize() const;\ntemplate<> void AtomsCore::MetadataImpl::toString(std::stringstream& inStream) const;\ntemplate class AtomsCore::MetadataImpl;\n\ntemplate<> std::string AtomsCore::MetadataImpl::staticTypeStr() { return \"FooMetadata\"; } //!< Bool metadata static type\ntemplate<> unsigned int AtomsCore::MetadataImpl::staticTypeId() { return 9999999; } //!< This must be a unique id\n\ntemplate<> bool AtomsCore::MetadataImpl::serialise(Archive& outStream) const\n{\n\tif (outStream.size == 0)\n\t{\n\t\toutStream.resize(memSize());\n\t}\n\t// the type id must be the first data to serialise\n\toutStream << typeId();\n\toutStream << m_value.a;\n\toutStream << m_value.b;\n\toutStream << m_value.c;\n}\ntemplate<> bool AtomsCore::MetadataImpl::deserialise(Archive& inStream)\n{\n\tunsigned int typeIdValue;\n\tinStream >> typeIdValue;\n\tif (typeIdValue != staticTypeId())\n\t\treturn false;\n\tinStream >> m_value.a;\n\tinStream >> m_value.b;\n\tinStream >> m_value.c;\n\treturn true;\n}\n\ntemplate<> void AtomsCore::MetadataImpl::toString(std::stringstream& inStream) const\n{\n\tinStream << \"FooData: a - \" << m_value.a << \" b - \" << m_value.b << \" c - \" << m_value.c;\n}\n\ntemplate<> size_t TypedArrayMetadata::memSize() const\n\t{\n\t\treturn sizeof(unsigned int) + sizeof(float) + sizeof(double) + sizeof(char); //typeid + a + b + c \n\t}\n\n\ntemplate class AtomsCore::MetadataImpl;\n\nvoid registerFooMetadata()\n{\n\tMetadataFactory& factory = MetadataFactory::instance();\n\tfactory.registerMetadata(FooMetadata::staticTypeStr(), FooMetadata::staticTypeId(), &FooMetadata::creator);\n\t\n}","type":"text"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported