|
| static KIND_API KindRegistry & | GetInstance () |
| | Return the single KindRegistry instance.
|
| |
| static KIND_API bool | HasKind (const TfToken &kind) |
| | Test whether kind is known to the registry.
|
| |
| static KIND_API TfToken | GetBaseKind (const TfToken &kind) |
| | Return the base kind of the given kind.
|
| |
| static KIND_API bool | IsA (const TfToken &derivedKind, const TfToken &baseKind) |
| | Test whether derivedKind is the same as baseKind or has it as a base kind (either directly or indirectly).
|
| |
| static KIND_API std::vector< TfToken > | GetAllKinds () |
| | Return an unordered vector of all kinds known to the registry.
|
| |
| static KIND_API bool | IsModel (const TfToken &kind) |
| | Returns true if kind IsA model kind.
|
| |
| static KIND_API bool | IsGroup (const TfToken &kind) |
| | Returns true if kind IsA group kind.
|
| |
| static KIND_API bool | IsAssembly (const TfToken &kind) |
| | Return true if kind IsA assembly kind.
|
| |
| static KIND_API bool | IsComponent (const TfToken &kind) |
| | Returns true if kind IsA component kind.
|
| |
| static KIND_API bool | IsSubComponent (const TfToken &kind) |
| | Returns true if kind IsA subcomponent kind.
|
| |
A singleton that holds known kinds and information about them.
See Kind Overview for a description of why kind exists, what the builtin registered kinds are, and how to extend the core kinds.
KindRegistry Threadsafty
KindRegistry serves performance-critical clients that operate under the stl threading model, and therefore itself follows that model in order to avoid locking during HasKind() and IsA() queries.
To make this robust, KindRegistry exposes no means to mutate the registry. All extensions must be accomplished via plugInfo.json files, which are consumed once during the registry initialization (See Extending the KindRegistry )
Definition at line 70 of file registry.h.
| static KIND_API bool IsA |
( |
const TfToken & |
derivedKind, |
|
|
const TfToken & |
baseKind |
|
) |
| |
|
static |
Test whether derivedKind is the same as baseKind or has it as a base kind (either directly or indirectly).
It is not required that derivedKind or baseKind be known to the registry: if they are unknown but equal, IsA will return true; otherwise if either is unknown, we will simply return false.
Therefore this method will not raise any errors.
Inheritance diagram for KindRegistry:
1.9.6 