Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
HdDirtyBitsTranslator Class Reference

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

#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 HdDirtyBits RprimLocatorSetToDirtyBits (TfToken const &primType, HdDataSourceLocatorSet const &set)
 
static HD_API HdDirtyBits SprimLocatorSetToDirtyBits (TfToken const &primType, HdDataSourceLocatorSet const &set)
 
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 void RegisterTranslatorsForCustomSprimType (TfToken const &primType, LocatorSetToDirtyBitsFnc sToBFnc, DirtyBitsToLocatorSetFnc bToSFnc)
 Allows for customization of translation for unknown (to the system) sprim types.
 

Detailed Description

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

Definition at line 38 of file dirtyBitsTranslator.h.

Member Typedef Documentation

◆ DirtyBitsToLocatorSetFnc

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

Definition at line 72 of file dirtyBitsTranslator.h.

◆ LocatorSetToDirtyBitsFnc

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

Definition at line 69 of file dirtyBitsTranslator.h.

Member Function Documentation

◆ RegisterTranslatorsForCustomSprimType()

static HD_API void 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.

The documentation for this class was generated from the following file: