computationBuilders.h File Reference

#include "pxr/pxr.h"
#include "pxr/exec/exec/api.h"
#include "pxr/exec/exec/builtinComputations.h"
#include "pxr/exec/exec/providerResolution.h"
#include "pxr/exec/exec/typeRegistry.h"
#include "pxr/exec/exec/types.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"
#include "pxr/base/vt/traits.h"
#include "pxr/base/vt/value.h"
#include "pxr/exec/vdf/context.h"
#include "pxr/exec/vdf/traits.h"
#include "pxr/usd/sdf/path.h"
#include <memory>
#include <type_traits>
#include <utility>

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_ComputationBuilderComputationValueSpecifier< allowed >
class	Exec_ComputationBuilderCommonBase
class	Exec_ComputationBuilderValueSpecifierBase
struct	Exec_ComputationBuilderConstantValueSpecifier
struct	Exec_ComputationBuilderComputationValueSpecifier< allowed >
struct	Exec_ComputationBuilderAccessorBase
struct	Exec_ComputationBuilderConstantAccessorBase
struct	Exec_ComputationBuilderAccessor< allowed >
struct	Exec_ComputationBuilderPropertyAccessor< allowed >
	Property accessor. More...
struct	Exec_ComputationBuilderAttributeAccessor< allowed >
	Attribute accessor. More...
struct	Exec_ComputationBuilderRelationshipAccessor< allowed >
	Relationship accessor. More...
struct	exec_registration::Attribute
	Attribute accessor, valid for providing input to a prim computation. More...
struct	exec_registration::Relationship
	Relationship accessor, valid for providing input to a prim computation. More...
struct	exec_registration::Prim
	Prim accessor, valid for providing input to an attribute computation. More...
struct	exec_registration::Stage
	Provides access to the stage, valid for providing input to any computation. More...
struct	exec_registration::Computation< ResultType >
	Computation value specifier, valid for providing input to any computation. More...
struct	exec_registration::Metadata< ValueType >
	Metadata value specifier, valid on a prim or attribute computation. More...
struct	exec_registration::Constant< ValueType >
struct	exec_registration::NamespaceAncestor< ResultType >
class	ExecComputationBuilder
struct	ExecComputationBuilder::ConstructionAccess
class	Exec_ComputationBuilderBase
class	Exec_ComputationBuilderCRTPBase< Derived >
class	ExecPrimComputationBuilder
	Class used to build prim computation definitions. More...
class	ExecAttributeComputationBuilder
	Class used to build attribute computation definitions. More...
class	ExecAttributeExpressionBuilder
	Class used to build attribute expression definitions. More...

Namespaces
	exec_registration

Enumerations
enum	Exec_ComputationBuilderProviderTypes : unsigned char { Exec_ComputationBuilderProviderTypes::Prim = 1 << 0, Exec_ComputationBuilderProviderTypes::Attribute = 1 << 1, Exec_ComputationBuilderProviderTypes::Any = 0xff }

Functions
constexpr bool	operator& (const Exec_ComputationBuilderProviderTypes a, const Exec_ComputationBuilderProviderTypes b)
	exec_registration::Constant (const char *) -> Constant< std::string >
	exec_registration::Constant (char *) -> Constant< std::string >
template<typename ValueType >
auto	exec_registration::AttributeValue (const TfToken &attributeName)
template<typename ResultType >
auto	exec_registration::Connections (const TfToken &computationName)
template<typename ResultType >
auto	exec_registration::IncomingConnections (const TfToken &computationName)

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

enum 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.

Enumerator
Prim
Attribute
Any

Definition at line 198 of file computationBuilders.h.

Function Documentation

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

Definition at line 205 of file computationBuilders.h.