ai_scene.h
Go to the documentation of this file.
1// Copyright 2025 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
16struct AtAssetIterator;
17struct AtMetadataStore;
18class AtUniverse;
19
59AI_API bool AiSceneLoad(AtUniverse* universe, const char* filename, const AtParamValueMap* params = nullptr);
60
104AI_API bool AiSceneWrite(AtUniverse* universe, const char* filename, const AtParamValueMap* params = nullptr, const AtMetadataStore* mds = NULL);
105
127AI_API AtAssetIterator* AiSceneGetAssetIterator(const char* filename,
128 const AtParamValueMap* params = nullptr);
129
136AI_API bool AiSceneFormatSupported(const char* extension);
137
148
155
161struct AtSceneFormatData;
162
169
176
184
191AI_API AI_PURE bool AiSceneFormatIteratorFinished(const AtSceneFormatIterator* iter);
192
200
207
215
223
230AI_API AI_PURE const char* AiSceneFormatGetName(const AtSceneFormatData* format_data);
231
238AI_API AI_PURE const char* AiSceneFormatGetDescription(const AtSceneFormatData* format_data);
239
246AI_API AI_PURE bool AiSceneFormatSupportsReading(const AtSceneFormatData* format_data);
247
254AI_API AI_PURE bool AiSceneFormatSupportsWriting(const AtSceneFormatData* format_data);
255
262AI_API const AtMetadataStore* AiSceneFormatGetMetadataStore(const AtSceneFormatData* format_data);
263
264/*\}*/
265
266/*\}*/
Key/Value storage.
AI_API AI_PURE bool AiSceneFormatSupportsWriting(const AtSceneFormatData *format_data)
True if the scene format supports writing to a file.
Definition: ai_scene.cpp:98
AI_API bool AiSceneLoad(AtUniverse *universe, const char *filename, const AtParamValueMap *params=nullptr)
Load all nodes from a scene file into a specific Arnold universe.
Definition: ai_scene.cpp:6
AI_API bool AiSceneFormatSupported(const char *extension)
Check if the scene format corresponding to a given filename extension is supported.
Definition: ai_scene.cpp:38
AI_API bool AiSceneWrite(AtUniverse *universe, const char *filename, const AtParamValueMap *params=nullptr, const AtMetadataStore *mds=NULL)
Write all nodes in the given universe to a scene file.
Definition: ai_scene.cpp:18
AI_API AI_PURE bool AiSceneFormatExtensionIteratorFinished(const AtSceneFormatExtensionIterator *iter)
Check if there are more scene formats extensions to iterate over.
Definition: ai_scene.cpp:78
AI_API AI_PURE const char * AiSceneFormatGetDescription(const AtSceneFormatData *format_data)
Get a description of the scene format.
Definition: ai_scene.cpp:88
AI_API AI_PURE bool AiSceneFormatSupportsReading(const AtSceneFormatData *format_data)
True if the scene format supports reading from file.
Definition: ai_scene.cpp:93
AI_API AI_PURE const char * AiSceneFormatGetName(const AtSceneFormatData *format_data)
Get the name of the scene format.
Definition: ai_scene.cpp:83
AI_API void AiSceneFormatExtensionIteratorDestroy(AtSceneFormatExtensionIterator *iter)
Destroys scene format extension iterator and releases any allocated memory.
Definition: ai_scene.cpp:68
AI_API AtSceneFormatIterator * AiSceneFormatIterator()
Get new scene format iterator.
Definition: ai_scene.cpp:43
AI_API const AtMetadataStore * AiSceneFormatGetMetadataStore(const AtSceneFormatData *format_data)
Get metadata for the scene format and its optional parameters.
Definition: ai_scene.cpp:103
AI_API AtAssetIterator * AiSceneGetAssetIterator(const char *filename, const AtParamValueMap *params=nullptr)
Creates a new iterator that loops over file dependencies (assets) defined in the given scene and rese...
Definition: ai_scene.cpp:30
AI_API const AtSceneFormatData * AiSceneFormatIteratorGetNext(AtSceneFormatIterator *iter)
Gets the next supported scene format.
Definition: ai_scene.cpp:53
AI_API void AiSceneFormatIteratorDestroy(AtSceneFormatIterator *iter)
Destroys scene format iterator and releases any allocated memory.
Definition: ai_scene.cpp:48
AI_API const char * AiSceneFormatExtensionIteratorGetNext(AtSceneFormatExtensionIterator *iter)
Gets the next supported scene format extension.
Definition: ai_scene.cpp:73
AI_API AI_PURE bool AiSceneFormatIteratorFinished(const AtSceneFormatIterator *iter)
Check if there are more scene formats to iterate over.
Definition: ai_scene.cpp:58
AI_API AtSceneFormatExtensionIterator * AiSceneFormatGetExtensionIterator(const AtSceneFormatData *format_data)
Get an iterator over all supported extensions for this scene format.
Definition: ai_scene.cpp:63
This structure holds a generic list of metadata items, each of which could optionally be associated t...
Provides access to information about the scene format.
Definition: ai_scene.h:154
Allows iterating over the list of supported extensions for a given scene format.
Definition: ai_scene.h:147
Allows iterating over the list of supported scene formats.
This represents a universe in Arnold.

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