ai_scene.h
Go to the documentation of this file.
1 // Copyright 2020 Autodesk, Inc. All rights reserved.
2 //
3 // Use of this software is subject to the terms of the Autodesk license
4 // agreement provided at the time of installation or download, or which
5 // otherwise accompanies this software in either electronic or hard copy form.
6 
12 #pragma once
13 
14 #include <ai_map.h>
15 
16 struct AtMetadataStore;
17 class AtUniverse;
18 
58 AI_API bool AiSceneLoad(AtUniverse* universe, const char* filename, const AtParamValueMap* params);
59 
103 AI_API bool AiSceneWrite(AtUniverse* universe, const char* filename, const AtParamValueMap* params, const AtMetadataStore* mds = NULL);
104 
111 AI_API bool AiSceneFormatSupported(const char* extension);
112 
123 
130 
136 struct AtSceneFormatData;
137 
144 
151 
159 
166 AI_API AI_PURE bool AiSceneFormatIteratorFinished(const AtSceneFormatIterator* iter);
167 
175 
182 
190 
198 
205 AI_API AI_PURE const char* AiSceneFormatGetName(const AtSceneFormatData* format_data);
206 
213 AI_API AI_PURE const char* AiSceneFormatGetDescription(const AtSceneFormatData* format_data);
214 
221 AI_API AI_PURE bool AiSceneFormatSupportsReading(const AtSceneFormatData* format_data);
222 
229 AI_API AI_PURE bool AiSceneFormatSupportsWriting(const AtSceneFormatData* format_data);
230 
237 AI_API const AtMetadataStore* AiSceneFormatGetMetadataStore(const AtSceneFormatData* format_data);
238 
239 /*\}*/
240 
241 /*\}*/
This represents a universe in Arnold.
AI_API const char * AiSceneFormatExtensionIteratorGetNext(AtSceneFormatExtensionIterator *iter)
Gets the next supported scene format extension.
Definition: ai_scene.cpp:63
AI_API bool AiSceneWrite(AtUniverse *universe, const char *filename, const AtParamValueMap *params, const AtMetadataStore *mds=NULL)
Write all nodes in the given universe to a scene file.
Definition: ai_scene.cpp:17
AI_API AI_PURE bool AiSceneFormatSupportsWriting(const AtSceneFormatData *format_data)
True if the scene format supports writing to a file.
Definition: ai_scene.cpp:88
AI_API AI_PURE bool AiSceneFormatIteratorFinished(const AtSceneFormatIterator *iter)
Check if there are more scene formats to iterate over.
Definition: ai_scene.cpp:48
AI_API bool AiSceneFormatSupported(const char *extension)
Check if the scene format corresponding to a given filename extension is supported.
Definition: ai_scene.cpp:28
This structure holds a generic list of metadata items, each of which could optionally be associated t...
Key/Value storage.
Provides access to information about the scene format.
Definition: ai_scene.h:129
AI_API const AtSceneFormatData * AiSceneFormatIteratorGetNext(AtSceneFormatIterator *iter)
Gets the next supported scene format.
Definition: ai_scene.cpp:43
AI_API void AiSceneFormatExtensionIteratorDestroy(AtSceneFormatExtensionIterator *iter)
Destroys scene format extension iterator and releases any allocated memory.
Definition: ai_scene.cpp:58
AI_API AI_PURE bool AiSceneFormatSupportsReading(const AtSceneFormatData *format_data)
True if the scene format supports reading from file.
Definition: ai_scene.cpp:83
AI_API void AiSceneFormatIteratorDestroy(AtSceneFormatIterator *iter)
Destroys scene format iterator and releases any allocated memory.
Definition: ai_scene.cpp:38
Allows iterating over the list of supported extensions for a given scene format.
Definition: ai_scene.h:122
AI_API bool AiSceneLoad(AtUniverse *universe, const char *filename, const AtParamValueMap *params)
Load all nodes from a scene file into a specific Arnold universe.
Definition: ai_scene.cpp:6
AI_API const AtMetadataStore * AiSceneFormatGetMetadataStore(const AtSceneFormatData *format_data)
Get metadata for the scene format and its optional parameters.
Definition: ai_scene.cpp:93
AI_API AtSceneFormatIterator * AiSceneFormatIterator()
Get new scene format iterator.
Definition: ai_scene.cpp:33
AI_API AI_PURE const char * AiSceneFormatGetName(const AtSceneFormatData *format_data)
Get the name of the scene format.
Definition: ai_scene.cpp:73
AI_API AI_PURE const char * AiSceneFormatGetDescription(const AtSceneFormatData *format_data)
Get a description of the scene format.
Definition: ai_scene.cpp:78
AI_API AI_PURE bool AiSceneFormatExtensionIteratorFinished(const AtSceneFormatExtensionIterator *iter)
Check if there are more scene formats extensions to iterate over.
Definition: ai_scene.cpp:68
Allows iterating over the list of supported scene formats.
AI_API AtSceneFormatExtensionIterator * AiSceneFormatGetExtensionIterator(const AtSceneFormatData *format_data)
Get an iterator over all supported extensions for this scene format.
Definition: ai_scene.cpp:53

© 2020 Autodesk, Inc. · All rights reserved · www.arnoldrenderer.com