Katana Plug-in APIs 0.1
Classes | Static Public Member Functions

Foundry::Katana::FnGeolibCookInterfaceUtils Class Reference

#include <FnGeolibCookInterfaceUtilsService.h>

List of all members.

Classes

struct  BuildLocalsAndGlobalsInfo
struct  MatchesCELInfo

Static Public Member Functions

static void matchesCEL (MatchesCELInfo &matchesCELInfo, const Foundry::Katana::GeolibCookInterface &interface, const FnAttribute::StringAttribute &cel, const std::string &inputLocationPath=std::string(), int inputIndex=kFnKatGeolibDefaultInput)
static FnAttribute::GroupAttribute cookDaps (const Foundry::Katana::GeolibCookInterface &interface, const std::string &attrRoot, const std::string &inputLocationPath=std::string(), int inputIndex=kFnKatGeolibDefaultInput, const FnAttribute::Attribute &cookOrderAttr=FnAttribute::Attribute())
static FnAttribute::Attribute getGlobalAttrGeneric (BaseGlobalAttributeProviderLegacy &provider, const std::string &name, const std::string &locationPath, bool *didAbortPtr=NULL)

Detailed Description

Provides a number of utility functions commonly used by Ops.


Member Function Documentation

static FnAttribute::Attribute Foundry::Katana::FnGeolibCookInterfaceUtils::getGlobalAttrGeneric ( BaseGlobalAttributeProviderLegacy provider,
const std::string &  name,
const std::string &  locationPath,
bool *  didAbortPtr = NULL 
) [static]

This function is deprecated. Please use getGlobalAttrGeneric() with the BaseGlobalAttributeProvider type for the provider parameter instead.

Deprecated:
: Please use the variant with BaseGlobalAttributeProvider instead.
static void Foundry::Katana::FnGeolibCookInterfaceUtils::matchesCEL ( MatchesCELInfo matchesCELInfo,
const Foundry::Katana::GeolibCookInterface interface,
const FnAttribute::StringAttribute cel,
const std::string &  inputLocationPath = std::string(),
int  inputIndex = kFnKatGeolibDefaultInput 
) [static]

Evaluates the CEL expression against the input location path and updates matchesCELInfo based on the results.

Parameters:
matchesCELInfoa instance of MatchesCELInfo
interfacethe GeolibCookInterface passed to your cook()() function.
cela StringAttribute instance containing the CEL expression to be evaluated
inputLocationPaththe input location path the CEL expression will be evaluated against.
inputIndexthe input index on the incoming scene to be queried (if for example attributes are reference in the CEL expression)

The documentation for this class was generated from the following file:
 All Classes Functions Variables Typedefs Enumerations Enumerator