Data Structures
ai_node_entry.h File Reference

AtNodeEntry type and methods. More...

#include "ai_params.h"
#include "ai_string.h"

Go to the source code of this file.

Data Structures

struct  AtCommonMethods
 Methods common to all nodes. More...
 
struct  AtNodeMethods
 Node methods. More...
 
struct  AtMetaDataEntry
 

Macros

Node Types
#define AI_NODE_UNDEFINED   0x0000
 Undefined type.
 
#define AI_NODE_OPTIONS   0x0001
 Options node (following the "singleton" pattern, there is only one options node)
 
#define AI_NODE_CAMERA   0x0002
 Camera nodes (persp_camera, fisheye_camera, etc)
 
#define AI_NODE_LIGHT   0x0004
 Light source nodes (spot_light, etc)
 
#define AI_NODE_SHAPE   0x0008
 Geometry nodes (sphere, polymesh, etc)
 
#define AI_NODE_SHADER   0x0010
 Shader nodes (lambert, etc)
 
#define AI_NODE_OVERRIDE   0x0020
 EXPERIMENTAL: override nodes support "delayed parameter overrides" for procedural nodes.
 
#define AI_NODE_DRIVER   0x0040
 Output driver nodes (driver_tiff, etc)
 
#define AI_NODE_FILTER   0x0080
 Pixel sample filter nodes (box_filter, etc.
 
#define AI_NODE_COLOR_MANAGER   0x0800
 Color manager nodes (Syncolor, OCIO, etc)
 
#define AI_NODE_OPERATOR   0x1000
 Operator plug-in nodes.
 
#define AI_NODE_ALL   0xFFFF
 Bitmask including all node types, used by AiASSWrite()
 
Derived Node Types
#define AI_NODE_SHAPE_PROCEDURAL   0x0100
 Procedural shape node.
 
#define AI_NODE_SHAPE_VOLUME   0x0200
 Volume shape node.
 
#define AI_NODE_SHAPE_IMPLICIT   0x0400
 Implicit shape node.
 

Functions

AtNodeEntry Methods
AI_API AI_PURE const AtNodeEntryAiNodeEntryLookUp (const AtString name)
 Look up a node entry from a name string. More...
 
AI_API AI_PURE const char * AiNodeEntryGetName (const AtNodeEntry *nentry)
 Return the name of the given AtNodeEntry. More...
 
AI_API AI_PURE AtString AiNodeEntryGetNameAtString (const AtNodeEntry *nentry)
 Return the name of the given AtNodeEntry as an AtString. More...
 
AI_API AI_PURE int AiNodeEntryGetType (const AtNodeEntry *nentry)
 Return the type of the given AtNodeEntry. More...
 
AI_API AI_PURE const char * AiNodeEntryGetTypeName (const AtNodeEntry *nentry)
 Return the type of the given AtNodeEntry as a string. More...
 
AI_API AI_PURE int AiNodeEntryGetDerivedType (const AtNodeEntry *nentry)
 Return the derived type of the given AtNodeEntry. More...
 
AI_API AI_PURE const char * AiNodeEntryGetDerivedTypeName (const AtNodeEntry *nentry)
 Return the derived type of the given AtNodeEntry as a string, if applicable. More...
 
AI_API AI_PURE int AiNodeEntryGetOutputType (const AtNodeEntry *nentry)
 Return the output type of the given AtNodeEntry. More...
 
AI_API AI_PURE const char * AiNodeEntryGetFilename (const AtNodeEntry *nentry)
 Return the filename (so/dll path) of an AtNodeEntry. More...
 
AI_API AI_PURE const char * AiNodeEntryGetVersion (const AtNodeEntry *nentry)
 Return the version that this node was linked with. More...
 
AI_API AI_PURE int AiNodeEntryGetCount (const AtNodeEntry *nentry)
 Return the number of instances of a particular node. More...
 
AI_API AI_PURE int AiNodeEntryGetNumParams (const AtNodeEntry *nentry)
 Return the number of parameters of a given AtNodeEntry. More...
 
AI_API AI_PURE const AtParamEntry * AiNodeEntryGetParameter (const AtNodeEntry *nentry, int i)
 Return the i'th parameter in an AtNodeEntry. More...
 
AI_API AI_PURE const AtParamEntry * AiNodeEntryLookUpParameter (const AtNodeEntry *nentry, const AtString param)
 Look up a parameter in a node entry from a name string. More...
 
AI_DEPRECATED const AtNodeEntryAiNodeEntryLookUp (const char *name)
 
AI_DEPRECATED const AtParamEntry * AiNodeEntryLookUpParameter (const AtNodeEntry *nentry, const char *param)
 
AI_API AtParamIterator * AiNodeEntryGetParamIterator (const AtNodeEntry *nentry)
 Creates and returns a new AtParamIterator for this node entry. More...
 
AI_API AtMetaDataIterator * AiNodeEntryGetMetaDataIterator (const AtNodeEntry *nentry, const char *param=NULL)
 Creates and returns a new AtMetaDataIterator for this node entry. More...
 
AI_API void AiNodeEntryInstall (int type, uint8_t output_type, const char *name, const char *filename, const AtNodeMethods *methods, const char *version)
 Install a new node in the system. More...
 
AI_API void AiNodeEntryUninstall (const char *name)
 Uninstall a node from the system. More...
 
AtParamIterator Methods
AI_API void AiParamIteratorDestroy (AtParamIterator *iter)
 Destroys a param iterator when it is no longer needed. More...
 
AI_API const AtParamEntry * AiParamIteratorGetNext (AtParamIterator *iter)
 Returns current param entry and points param iterator to the next one. More...
 
AI_API bool AiParamIteratorFinished (const AtParamIterator *iter)
 Returns true if there are no more parameters to iterate over. More...
 
AtMetaDataIterator Methods
AI_API void AiMetaDataIteratorDestroy (AtMetaDataIterator *iter)
 Destroys a metadata iterator when it is no longer needed. More...
 
AI_API const AtMetaDataEntryAiMetaDataIteratorGetNext (AtMetaDataIterator *iter)
 Returns current metadata entry and points metadata iterator to the next one. More...
 
AI_API bool AiMetaDataIteratorFinished (const AtMetaDataIterator *iter)
 Returns true if there is no more metadata to iterate over. More...
 

Detailed Description

AtNodeEntry type and methods.


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