ai_universe.h

Go to the documentation of this file.

// Copyright 2025 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_bbox.h"
#include "ai_api.h"
#include "ai_node_entry.h"
#include "ai_string.h"
#include <stdint.h> // uint32_t etc
 
// forward declares
struct AtNode;
struct AtNodeIterator;
struct AtNodeEntry;
struct AtNodeEntryIterator;
struct AtAOVIterator;
struct AtParamValueMap;
struct AtAsset;
struct AtAssetIterator;
class AtRenderSession;
 
struct AtAOVEntry
{
   AtString name;        
   uint8_t  type;        
   int      blend_mode;  
   AtString expression;  
};
 
class AtUniverse;
 
#ifdef AI_CPU_COMPILER
AI_API         AtUniverse*          AiUniverse();
AI_API         void                 AiUniverseDestroy(AtUniverse* universe);
AI_API         bool                 AiUniverseCacheFlush(AtUniverse* universe, int cache_flags);
AI_API AI_PURE AtNode*              AiUniverseGetOptions(const AtUniverse* universe);
#endif // AI_CPU_COMPILER
AI_API AI_DEVICE AI_PURE AtNode*    AiUniverseGetCamera(const AtUniverse* universe);
#ifdef AI_CPU_COMPILER
AI_API AI_PURE AtBBox               AiUniverseGetSceneBounds(const AtUniverse* universe);
AI_API         AtNodeIterator*      AiUniverseGetNodeIterator(const AtUniverse* universe, unsigned int node_mask);
AI_API         AtNodeEntryIterator* AiUniverseGetNodeEntryIterator(unsigned int node_mask);
AI_API         AtAOVIterator*       AiUniverseGetAOVIterator(const AtUniverse* universe);
AI_API         void                 AiUniverseAddDefaultNodes(AtUniverse* universe, const AtParamValueMap* params);
AI_API         AtRenderSession*     AiUniverseGetRenderSession(const AtUniverse* universe);
AI_API         bool                 AiUniverseCompare(const AtUniverse* universe1, const AtUniverse* universe2, unsigned int node_mask = AI_NODE_ALL, AtParamValueMap* diffs = NULL);
AI_API         uint32_t             AiUniverseGetId(const AtUniverse* universe);
AI_API         AtUniverse*          AiUniverseGetFromId(uint32_t universe_id);
AI_API         AtAssetIterator*     AiUniverseGetAssetIterator(const AtUniverse* universe);
 
AI_API         void    AiNodeIteratorDestroy(AtNodeIterator* iter);
AI_API         AtNode* AiNodeIteratorGetNext(AtNodeIterator* iter);
AI_API AI_PURE bool    AiNodeIteratorFinished(const AtNodeIterator* iter);
/*\}*/
 
AI_API         void         AiNodeEntryIteratorDestroy(AtNodeEntryIterator* iter);
AI_API         AtNodeEntry* AiNodeEntryIteratorGetNext(AtNodeEntryIterator* iter);
AI_API AI_PURE bool         AiNodeEntryIteratorFinished(const AtNodeEntryIterator* iter);
/*\}*/
 
AI_API         void              AiAOVIteratorDestroy(AtAOVIterator* iter);
AI_API         const AtAOVEntry* AiAOVIteratorGetNext(AtAOVIterator* iter);
AI_API AI_PURE bool              AiAOVIteratorFinished(const AtAOVIterator* iter);
#endif // AI_CPU_COMPILER
/*\}*/
 
#define AI_CACHE_TEXTURE        0x0001  
#define AI_CACHE_BACKGROUND     0x0002  
#define AI_CACHE_QUAD           0x0004  
#define AI_CACHE_VOLUME_DISPLAY 0x0008  
#define AI_CACHE_ALL            (AI_CACHE_TEXTURE | AI_CACHE_BACKGROUND | AI_CACHE_QUAD | AI_CACHE_VOLUME_DISPLAY)  
/*\}*/
 
/*\}*/