Data Structures
ai_universe.h File Reference

Global entry point to the scene graph elements (options, camera, lights, etc) More...

#include "ai_bbox.h"
#include "ai_api.h"
#include "ai_string.h"
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  AtAOVEntry
 

Macros

Cache Types
#define AI_CACHE_TEXTURE   0x0001
 Flushes all texturemaps.
 
#define AI_CACHE_BACKGROUND   0x0002
 Flushes all skydome importance tables for background.
 
#define AI_CACHE_QUAD   0x0004
 Flushes all quad lights importance tables.
 
#define AI_CACHE_ALL   0xFFFF
 Flushes all cache types simultaneously.
 

Functions

Methods
AI_API AtUniverseAiUniverse ()
 Creates a new secondary universe that can be used independently of the main default universe. More...
 
AI_API void AiUniverseDestroy (AtUniverse *universe)
 Destroys an existing secondary universe and releases any allocated resources. More...
 
AI_API AI_PURE bool AiUniverseIsActive ()
 Check whether the default universe is active or not. More...
 
AI_API bool AiUniverseCacheFlush (const AtUniverse *universe, int cache_flags)
 Flush one or several caches in a given Arnold universe. More...
 
AI_API AI_PURE AtNodeAiUniverseGetOptions (const AtUniverse *universe)
 Fetches the global options node for a specific Arnold universe. More...
 
AI_API AI_PURE AtNodeAiUniverseGetCamera (const AtUniverse *universe)
 Fetches the currently active camera node for a given Arnold universe. More...
 
AI_API AI_PURE AtBBox AiUniverseGetSceneBounds (const AtUniverse *universe)
 Returns the bounding box of the given Arnold universe. More...
 
AI_API AtNodeIterator * AiUniverseGetNodeIterator (const AtUniverse *universe, unsigned int node_mask)
 Creates a new node iterator for the given Arnold universe and resets it to the first node. More...
 
AI_API AtNodeEntryIterator * AiUniverseGetNodeEntryIterator (unsigned int node_mask)
 Creates a new node entry iterator and resets it to the first installed node entry. More...
 
AI_API AtAOVIterator * AiUniverseGetAOVIterator ()
 Creates a new AOV iterator and resets it to the first entry. More...
 
AI_API void AiUniverseAddDefaultNodes (AtUniverse *universe, const AtParamValueMap *params)
 Creates default camera and/or light nodes when they are not present in the scene. More...
 
AI_DEPRECATED bool AiUniverseCacheFlush (int cache_flags)
 Flush one or several caches in the default universe. More...
 
AI_DEPRECATED AtNodeAiUniverseGetOptions ()
 Fetches the global options node for the default Arnold universe. More...
 
AI_DEPRECATED AtNodeAiUniverseGetCamera ()
 Fetches the currently active camera node for the default Arnold universe. More...
 
AI_DEPRECATED AtBBox AiUniverseGetSceneBounds ()
 Returns the bounding box of the default Arnold universe. More...
 
AI_DEPRECATED AtNodeIterator * AiUniverseGetNodeIterator (unsigned int node_mask)
 Creates a new node iterator for the default Arnold universe and resets it to the first node. More...
 
Node Iterator API
AI_API void AiNodeIteratorDestroy (AtNodeIterator *iter)
 Destroys a node iterator when it is no longer needed. More...
 
AI_API AtNodeAiNodeIteratorGetNext (AtNodeIterator *iter)
 Returns current node and points node iterator to the next node. More...
 
AI_API AI_PURE bool AiNodeIteratorFinished (const AtNodeIterator *iter)
 Returns true if there are no more nodes to iterate over. More...
 
Node Entry Iterator API
AI_API void AiNodeEntryIteratorDestroy (AtNodeEntryIterator *iter)
 Destroys a node entry iterator when it is no longer needed. More...
 
AI_API AtNodeEntryAiNodeEntryIteratorGetNext (AtNodeEntryIterator *iter)
 Returns current node entry and points node entry iterator to the next node entry. More...
 
AI_API AI_PURE bool AiNodeEntryIteratorFinished (const AtNodeEntryIterator *iter)
 Returns true if there are no more node entries to iterate over. More...
 
AOV Iterator API
AI_API void AiAOVIteratorDestroy (AtAOVIterator *iter)
 Destroys a AOV iterator when it is no longer needed. More...
 
AI_API const AtAOVEntryAiAOVIteratorGetNext (AtAOVIterator *iter)
 Returns current AOV entry and points AOV iterator to the next AOV. More...
 
AI_API AI_PURE bool AiAOVIteratorFinished (const AtAOVIterator *iter)
 Returns true if there are no more AOV entries to iterate over. More...
 

Detailed Description

Global entry point to the scene graph elements (options, camera, lights, etc)


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