EntropyCanvas::USDService
EntropyCanvas::USDService
Section titled “EntropyCanvas::USDService”Service for USD plugin registration. More…
#include <USDService.h>
Inherits from EntropyEngine::Core::EntropyService, EntropyEngine::Core::EntropyObject
Public Functions
Section titled “Public Functions”| Name | |
|---|---|
| ~USDService() override =default | |
| virtual void | unload() override |
| virtual EntropyEngine::Core::TypeSystem::TypeID | typeId() const override |
| virtual void | stop() override |
| virtual void | start() override |
| virtual const char * | name() const override |
| virtual void | load() override |
| virtual const char * | id() const override |
| virtual std::vector< EntropyEngine::Core::TypeSystem::TypeID > | dependsOnTypes() const override |
| const std::string & | appName() const Get the application name used for plugin directory. |
| USDService(const std::string & appName) Construct USDService with auto-derived plugin directory. | |
| USDService(const std::string & appName, const std::string & pluginDirectory) Construct USDService with explicit plugin directory. |
Additional inherited members
Section titled “Additional inherited members”Public Functions inherited from EntropyEngine::Core::EntropyService
| Name | |
|---|---|
| ~EntropyService() override =default | |
| virtual const char * | version() const |
| ServiceState | state() const |
| virtual std::vector< std::string > | dependsOn() const |
| virtual const char * | className() const override Runtime class name for diagnostics and reflection. |
Protected Functions inherited from EntropyEngine::Core::EntropyService
| Name | |
|---|---|
| void | setState(ServiceState s) |
Friends inherited from EntropyEngine::Core::EntropyService
| Name | |
|---|---|
| class | EntropyServiceRegistry |
Protected Classes inherited from EntropyEngine::Core::EntropyObject
| Name | |
|---|---|
| struct | HandleCore Optional handle identity stamped by an owner/registry. |
Public Functions inherited from EntropyEngine::Core::EntropyObject
| Name | |
|---|---|
| virtual | ~EntropyObject() =default |
| virtual const TypeSystem::TypeInfo * | typeInfo() const Optional richer type information; may be null. |
| bool | tryRetain() const Attempts to retain only if the object is still alive. |
| virtual std::string | toString() const Human-readable short string (class@ptr by default). |
| void | retain() const Increments the reference count. |
| void | release() const Decrements the reference count and deletes when it reaches zero. |
| uint32_t | refCount() const Current reference count (approximate under contention). |
| EntropyObject & | operator=(const EntropyObject & ) =delete |
| EntropyObject & | operator=(EntropyObject && ) =delete |
| bool | hasHandle() const |
| template <class OwnerT > OwnerT * | handleOwnerAs() const Returns the stamped owner pointer cast to the requested type. |
| const void * | handleOwner() const |
| uint32_t | handleIndex() const |
| uint64_t | handleId() const |
| uint32_t | handleGeneration() const |
| WeakControlBlock * | getWeakControlBlock() const Lazily retrieves or creates the weak control block. |
| virtual std::string | description() const Long-form description; defaults to toString(). |
| virtual std::string | debugString() const Debug-oriented string including refcount and handle when present. |
| virtual const char * | className() const Runtime class name for diagnostics and reflection. |
| virtual uint64_t | classHash() const Stable type hash for cross-language identification. |
| EntropyObject() =default | |
| EntropyObject(EntropyObject && ) =delete | |
| EntropyObject(const EntropyObject & ) =delete |
Protected Functions inherited from EntropyEngine::Core::EntropyObject
| Name | |
|---|---|
| void | _setHandleIdentity(void * owner, uint32_t index, uint32_t generation) |
| void | _clearHandleIdentity() |
Protected Attributes inherited from EntropyEngine::Core::EntropyObject
| Name | |
|---|---|
| std::atomic< WeakControlBlock * > | _weakBlock Lazily allocated control block for weak refs. |
| std::atomic< uint32_t > | _refCount Thread-safe retain/release counter. |
| struct EntropyEngine::Core::EntropyObject::HandleCore | _handle |
Friends inherited from EntropyEngine::Core::EntropyObject
| Name | |
|---|---|
| struct | HandleAccess |
Detailed Description
Section titled “Detailed Description”class EntropyCanvas::USDService;Service for USD plugin registration.
USDService handles:
- USD plugin registration (file format handlers, asset resolvers)
- Writes embedded plugInfo.json files to specified directory at runtime
Usage (simple - auto-derived path): USDService usdService(“MyApp”); usdService.load(); usdService.start();
Usage (explicit path): USDService usdService(“MyApp”, “/path/to/usd/plugins”); usdService.load(); usdService.start();
Public Functions Documentation
Section titled “Public Functions Documentation”function ~USDService
Section titled “function ~USDService”~USDService() override =defaultfunction unload
Section titled “function unload”virtual void unload() overrideReimplements: EntropyEngine::Core::EntropyService::unload
function typeId
Section titled “function typeId”virtual EntropyEngine::Core::TypeSystem::TypeID typeId() const overrideReimplements: EntropyEngine::Core::EntropyService::typeId
function stop
Section titled “function stop”virtual void stop() overrideReimplements: EntropyEngine::Core::EntropyService::stop
function start
Section titled “function start”virtual void start() overrideReimplements: EntropyEngine::Core::EntropyService::start
function name
Section titled “function name”inline virtual const char * name() const overrideReimplements: EntropyEngine::Core::EntropyService::name
function load
Section titled “function load”virtual void load() overrideReimplements: EntropyEngine::Core::EntropyService::load
function id
Section titled “function id”inline virtual const char * id() const overrideReimplements: EntropyEngine::Core::EntropyService::id
function dependsOnTypes
Section titled “function dependsOnTypes”inline virtual std::vector< EntropyEngine::Core::TypeSystem::TypeID > dependsOnTypes() const overrideReimplements: EntropyEngine::Core::EntropyService::dependsOnTypes
function appName
Section titled “function appName”inline const std::string & appName() constGet the application name used for plugin directory.
function USDService
Section titled “function USDService”explicit USDService( const std::string & appName)Construct USDService with auto-derived plugin directory.
Parameters:
- appName Application name (used for cache subdirectory)
Uses platform-appropriate cache directory:
- macOS: ~/Library/Caches/{appName}/USD/
- Linux: ~/.cache/{appName}/USD/
- Windows: LOCALAPPDATAappName}\USD\
function USDService
Section titled “function USDService”USDService( const std::string & appName, const std::string & pluginDirectory)Construct USDService with explicit plugin directory.
Parameters:
- appName Application name for logging
- pluginDirectory Directory where USD plugin files will be written
Updated on 2026-01-26 at 17:14:35 -0500