OpenVDB  8.1.1
Namespaces | Classes | Typedefs | Functions
openvdb::v8_1::ax Namespace Reference

Namespaces

 ast
 
 codegen
 
 math
 

Classes

class  AttributeRegistry
 This class stores a list of access names, types and their dependency connections. More...
 
class  Compiler
 The compiler class. This holds an llvm context and set of compiler options, and constructs executable objects (e.g. PointExecutable or VolumeExecutable) from a syntax tree or snippet of code. More...
 
struct  CompilerOptions
 Settings which control how a Compiler class object behaves. More...
 
class  CustomData
 The custom data class is a simple container for named openvdb metadata. Its primary use case is passing arbitrary "external" data to an AX executable object when calling Compiler::compile. For example, it is the mechanism by which we pass data held inside of a parent DCC to executable AX code. More...
 
struct  FunctionOptions
 Options that control how functions behave. More...
 
class  Logger
 Logger for collecting errors and warnings that occur during AX compilation. More...
 
class  PointExecutable
 Object that encapsulates compiled AX code which can be executed on a collection of VDB Point Data grids. Executables are created by the compiler and hold the final immutable JIT compiled function and context. More...
 
class  VolumeExecutable
 Object that encapsulates compiled AX code which can be executed on a collection of VDB volume grids. Executables are created by the compiler and hold the final immutable JIT compiled function and context. More...
 

Typedefs

using String.h = TypedMetadata< ax::codegen::String >
 

Functions

void initialize ()
 Initializes OpenVDB AX and subsequent LLVM components. More...
 
bool isInitialized ()
 Check to see if OpenVDB AX components have been initialized. More...
 
void uninitialize ()
 Uninitialize and deregister OpenVDB AX. More...
 
void run (const char *ax, openvdb::GridBase &grid)
 Run a full AX pipeline (parse, compile and execute) on a single OpenVDB Grid. More...
 
void run (const char *ax, openvdb::GridPtrVec &grids)
 Run a full AX pipeline (parse, compile and execute) on a vector of OpenVDB numerical grids OR a vector of OpenVDB Point Data grids. More...
 

Typedef Documentation

using String.h = TypedMetadata<ax::codegen::String>

Function Documentation

void openvdb::v8_1::ax::initialize ( )

Initializes OpenVDB AX and subsequent LLVM components.

Must be called before any AX compilation or execution is performed. Can be safely called from multiple threads. Cannot be called after uninitialize has been called.

bool openvdb::v8_1::ax::isInitialized ( )

Check to see if OpenVDB AX components have been initialized.

Note
Can be safely called from multiple threads.
void openvdb::v8_1::ax::run ( const char *  ax,
openvdb::GridBase grid 
)

Run a full AX pipeline (parse, compile and execute) on a single OpenVDB Grid.

This method wraps the parsing, compilation and execution of AX code for a single OpenVDB grid of any standard grid type (including OpenVDB Points Grids). Provided AX code is expected to only refer to the provided single grid. On success, the grid will have its voxels or point data modified as dictated by the provided AX code.

Note
Various defaults are applied to this pipeline to provide a simple run signature. For OpenVDB Numerical grids, only active voxels are processed. For OpenVDB Points grids, all points are processed. Any warnings generated by the parser, compiler or executable will be ignored.
Various runtime errors may be thrown from the different AX pipeline stages. See Exceptions.h for the possible different errors.
Parameters
axThe null terminated AX code string to parse and compile
gridThe grid to which to apply the compiled AX function
void openvdb::v8_1::ax::run ( const char *  ax,
openvdb::GridPtrVec grids 
)

Run a full AX pipeline (parse, compile and execute) on a vector of OpenVDB numerical grids OR a vector of OpenVDB Point Data grids.

This method wraps the parsing, compilation and execution of AX code for a vector of OpenVDB grids. The vector must contain either a set of any numerical grids supported by the default AX types OR a set of OpenVDB Points grids. On success, grids in the provided grid vector will be iterated over and updated if they are written to.

Warning
The type of grids provided changes the type of AX compilation. If the vector is empty, this function immediately returns with no other effect.
Note
Various defaults are applied to this pipeline to provide a simple run signature. For numerical grids, only active voxels are processed and missing grid creation is disabled. For OpenVDB Points grids, all points are processed. Any warnings generated by the parser, compiler or executable will be ignored.
Various runtime errors may be thrown from the different AX pipeline stages. See Exceptions.h for the possible different errors.
Parameters
axThe null terminated AX code string to parse and compile
gridsThe grids to which to apply the compiled AX function
void openvdb::v8_1::ax::uninitialize ( )

Uninitialize and deregister OpenVDB AX.

This has the important function of shutting down LLVM and correctly freeing statically allocated LLVM types. Should be called on application termination. Can be safely called from multiple threads.