doc/html/ai__scene__format_8h_source.html

// Copyright 2021 Autodesk, Inc.  All rights reserved.

//

// Use of this software is subject to the terms of the Autodesk license

// agreement provided at the time of installation or download, or which

// otherwise accompanies this software in either electronic or hard copy form.


#pragma once


#include <ai_map.h>

#include <ai_scene.h>

#include <ai_version.h>


struct AtSceneFormatLib {

   const char**           extensions;

   const char*            name;

   const char*            description;

   const void*            methods;

   char                   version[AI_MAXSIZE_VERSION];

   const AtParamValueMap* params;

};


typedef bool (*AtSceneLoad)(AtUniverse* universe, const char* filename, const AtParamValueMap* params);


typedef bool (*AtSceneWrite)(AtUniverse* universe, const char* filename, const AtParamValueMap* params, const AtMetadataStore* mds);


struct AtSceneFormatMethods

{

   AtSceneLoad   SceneLoad;

   AtSceneWrite  SceneWrite;

};


#define AI_SCENE_FORMAT_EXPORT_METHODS(tag)    \

static AtSceneFormatMethods ai_scene_mtds = {  \

   NULL,                                       \

   NULL                                        \

};                                             \

const AtSceneFormatMethods* tag = &ai_scene_mtds;


#define scene_format_loader \

AI_EXPORT_LIB bool SceneFormatLoader(AtSceneFormatLib* format)


#define scene_load \

static bool SceneLoad(AtUniverse* universe, const char* filename, const AtParamValueMap* params); \

AI_OPTIONAL_METHOD_INSTALL(ai_scene_mtds, SceneLoad) \

static bool SceneLoad(AtUniverse* universe, const char* filename, const AtParamValueMap* params)


#define scene_write \

static bool SceneWrite(AtUniverse* universe, const char* filename, const AtParamValueMap* params, const AtMetadataStore* mds); \

AI_OPTIONAL_METHOD_INSTALL(ai_scene_mtds, SceneWrite) \

static bool SceneWrite(AtUniverse* universe, const char* filename, const AtParamValueMap* params, const AtMetadataStore* mds)

ai_map.h
Key/Value storage.

ai_scene.h
API for reading and writing scene file formats.

ai_version.h
Version number information and checking of backwards-compatibility.

AtSceneFormatLib::methods
const void * methods
pointer to load/write methods for this format
Definition: ai_scene_format.h:70

AtSceneFormatLib::extensions
const char ** extensions
null-terminated list of extensions used by this format
Definition: ai_scene_format.h:67

AtSceneFormatLib::description
const char * description
description for this scene format
Definition: ai_scene_format.h:69

AtSceneLoad
bool(* AtSceneLoad)(AtUniverse *universe, const char *filename, const AtParamValueMap *params)
Scene format load method.
Definition: ai_scene_format.h:83

AtSceneWrite
bool(* AtSceneWrite)(AtUniverse *universe, const char *filename, const AtParamValueMap *params, const AtMetadataStore *mds)
Scene format write method.
Definition: ai_scene_format.h:94

AtSceneFormatLib::name
const char * name
name of this scene format ("ASS", "USD", etc)
Definition: ai_scene_format.h:68

AtSceneFormatLib::version
char version[AI_MAXSIZE_VERSION]
Arnold version that this plugin was compiled against
Definition: ai_scene_format.h:71

AtSceneFormatLib::params
const AtParamValueMap * params
optional params that will be passed on to the methods
Definition: ai_scene_format.h:72

AtMetadataStore
This structure holds a generic list of metadata items, each of which could optionally be associated t...

AtSceneFormatLib
Used by dynamically-linked scene format plugins.
Definition: ai_scene_format.h:66

AtSceneFormatMethods
Scene format methods.
Definition: ai_scene_format.h:100

AtUniverse
This represents a universe in Arnold.