HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Static Public Member Functions | List of all members
HdDirtyBitsTranslator Class Reference

#include <dirtyBitsTranslator.h>

Public Types

using LocatorSetToDirtyBitsFnc = std::function< void(HdDataSourceLocatorSet const &, HdDirtyBits *)>
 
using DirtyBitsToLocatorSetFnc = std::function< void(const HdDirtyBits, HdDataSourceLocatorSet *)>
 

Static Public Member Functions

static HD_API void RprimDirtyBitsToLocatorSet (TfToken const &primType, const HdDirtyBits bits, HdDataSourceLocatorSet *set)
 
static HD_API void SprimDirtyBitsToLocatorSet (TfToken const &primType, const HdDirtyBits bits, HdDataSourceLocatorSet *set)
 
static HD_API void BprimDirtyBitsToLocatorSet (TfToken const &primType, const HdDirtyBits bits, HdDataSourceLocatorSet *set)
 
static HD_API void InstancerDirtyBitsToLocatorSet (TfToken const &primType, const HdDirtyBits bits, HdDataSourceLocatorSet *set)
 
static HD_API void TaskDirtyBitsToLocatorSet (const HdDirtyBits bits, HdDataSourceLocatorSet *set)
 
static HD_API HdDirtyBits RprimLocatorSetToDirtyBits (TfToken const &primType, HdDataSourceLocatorSet const &set)
 
static HD_API HdDirtyBits SprimLocatorSetToDirtyBits (TfToken const &primType, HdDataSourceLocatorSet const &set, const TfTokenVector &renderContexts={})
 
static HD_API HdDirtyBits BprimLocatorSetToDirtyBits (TfToken const &primType, HdDataSourceLocatorSet const &set)
 
static HD_API HdDirtyBits InstancerLocatorSetToDirtyBits (TfToken const &primType, HdDataSourceLocatorSet const &set)
 
static HD_API HdDirtyBits TaskLocatorSetToDirtyBits (HdDataSourceLocatorSet const &set)
 
static HD_API void RegisterTranslatorsForCustomSprimType (TfToken const &primType, LocatorSetToDirtyBitsFnc sToBFnc, DirtyBitsToLocatorSetFnc bToSFnc)
 

Detailed Description

A set of optimized functions for translating between dirty bits and datasource locators for different prim types.

Definition at line 21 of file dirtyBitsTranslator.h.

Member Typedef Documentation

using HdDirtyBitsTranslator::DirtyBitsToLocatorSetFnc = std::function<void(const HdDirtyBits, HdDataSourceLocatorSet *)>

Definition at line 63 of file dirtyBitsTranslator.h.

using HdDirtyBitsTranslator::LocatorSetToDirtyBitsFnc = std::function<void(HdDataSourceLocatorSet const&, HdDirtyBits *)>

Definition at line 60 of file dirtyBitsTranslator.h.

Member Function Documentation

static HD_API void HdDirtyBitsTranslator::BprimDirtyBitsToLocatorSet ( TfToken const &  primType,
const HdDirtyBits  bits,
HdDataSourceLocatorSet *  set 
)
static
static HD_API HdDirtyBits HdDirtyBitsTranslator::BprimLocatorSetToDirtyBits ( TfToken const &  primType,
HdDataSourceLocatorSet const &  set 
)
static
static HD_API void HdDirtyBitsTranslator::InstancerDirtyBitsToLocatorSet ( TfToken const &  primType,
const HdDirtyBits  bits,
HdDataSourceLocatorSet *  set 
)
static
static HD_API HdDirtyBits HdDirtyBitsTranslator::InstancerLocatorSetToDirtyBits ( TfToken const &  primType,
HdDataSourceLocatorSet const &  set 
)
static
static HD_API void HdDirtyBitsTranslator::RegisterTranslatorsForCustomSprimType ( TfToken const &  primType,
LocatorSetToDirtyBitsFnc  sToBFnc,
DirtyBitsToLocatorSetFnc  bToSFnc 
)
static

Allows for customization of translation for unknown (to the system) sprim types. Absence of registered functions for an unknown type falls back to DirtyAll equivalents in both directions.

static HD_API void HdDirtyBitsTranslator::RprimDirtyBitsToLocatorSet ( TfToken const &  primType,
const HdDirtyBits  bits,
HdDataSourceLocatorSet *  set 
)
static
static HD_API HdDirtyBits HdDirtyBitsTranslator::RprimLocatorSetToDirtyBits ( TfToken const &  primType,
HdDataSourceLocatorSet const &  set 
)
static
static HD_API void HdDirtyBitsTranslator::SprimDirtyBitsToLocatorSet ( TfToken const &  primType,
const HdDirtyBits  bits,
HdDataSourceLocatorSet *  set 
)
static
static HD_API HdDirtyBits HdDirtyBitsTranslator::SprimLocatorSetToDirtyBits ( TfToken const &  primType,
HdDataSourceLocatorSet const &  set,
const TfTokenVector &  renderContexts = {} 
)
static
static HD_API void HdDirtyBitsTranslator::TaskDirtyBitsToLocatorSet ( const HdDirtyBits  bits,
HdDataSourceLocatorSet *  set 
)
static
static HD_API HdDirtyBits HdDirtyBitsTranslator::TaskLocatorSetToDirtyBits ( HdDataSourceLocatorSet const &  set)
static
The documentation for this class was generated from the following file: