Loading...
Searching...
No Matches
computationBuilders.h File Reference

This is a public header, but many of the symbols have private names because they are not intended for direct use by client code. More...

+ Include dependency graph for computationBuilders.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  Exec_ComputationBuilderAccessor< allowed >
 Accessor common to all scene object types that support requesting computations on the object. More...
 
struct  Exec_ComputationBuilderPropertyAccessor< allowed >
 Property accessor. More...
 
struct  Exec_ComputationBuilderAttributeAccessor< allowed >
 Attribute accessor. More...
 
struct  Exec_ComputationBuilderRelationshipAccessor< allowed >
 Relationship accessor. More...
 
struct  Attribute
 Attribute accessor, valid for providing input to a prim computation. More...
 
struct  Relationship
 Relationship accessor, valid for providing input to a prim computation. More...
 
struct  Prim
 Prim accessor, valid for providing input to an attribute computation. More...
 
struct  Stage
 Provides access to the stage, valid for providing input to any computation. More...
 
struct  Computation< ResultType >
 Computation value specifier, valid for providing input to any computation. More...
 
struct  Metadata< ValueType >
 Metadata value specifier, valid on a prim or attribute computation. More...
 
class  Exec_ComputationBuilder
 The top-level builder object (aka, the 'self' variable generated by EXEC_REGISTER_COMPUTATIONS_FOR_SCHEMA()). More...
 
class  Exec_PrimComputationBuilder
 Class used to build prim computation definitions. More...
 
class  Exec_AttributeComputationBuilder
 Class used to build attribute computation definitions. More...
 

Enumerations

enum class  Exec_ComputationBuilderProviderTypes : unsigned char { Prim = 1 << 0 , Attribute = 1 << 1 , Any = 0xff }
 An enum that is used as a template parameter to specify which kinds of providers a given input registration is allowed to be used on. More...
 

Functions

constexpr bool operator& (const Exec_ComputationBuilderProviderTypes a, const Exec_ComputationBuilderProviderTypes b)
 
 Constant (const char *) -> Constant< std::string >
 
 Constant (char *) -> Constant< std::string >
 
template<typename ValueType >
auto AttributeValue (const TfToken &attributeName)
 Input alias that yields the value of the named attribute.
 
template<typename ResultType >
auto ConnectionTargetedObjects (const TfToken &computationName)
 As a direct input to an attribute computation or after an Attribute() accessor, requests input values from the computation computationName of type ResultType on the objects targeted by the attribute's connections.
 

Detailed Description

This is a public header, but many of the symbols have private names because they are not intended for direct use by client code.

The public API here is accessed by client code via the 'self' parameter generated by the EXEC_REGISTER_COMPUTATIONS_FOR_SCHEMA macro. The documentation is set up to highlight all relevant public details.

Definition in file computationBuilders.h.

Enumeration Type Documentation

◆ Exec_ComputationBuilderProviderTypes

enum class Exec_ComputationBuilderProviderTypes : unsigned char
strong

An enum that is used as a template parameter to specify which kinds of providers a given input registration is allowed to be used on.

Definition at line 198 of file computationBuilders.h.

Function Documentation

◆ operator&()

constexpr bool operator& ( const Exec_ComputationBuilderProviderTypes  a,
const Exec_ComputationBuilderProviderTypes  b 
)
constexpr

Definition at line 205 of file computationBuilders.h.