runTimeMgr.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.11-windows/ufe/include/runTimeMgr.h"
#ifndef _runTimeMgr
#define _runTimeMgr
// ===========================================================================
// Copyright 2022 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================
 
#include "attributesHandler.h"
#include "connectionHandler.h"
#include "contextOpsHandler.h"
#include "hierarchyHandler.h"
#include "object3dHandler.h"
#include "materialHandler.h"
#include "sceneItemOpsHandler.h"
#include "sceneSegmentHandler.h"
#include "transform3dHandler.h"
#include "uiInfoHandler.h"
#include "cameraHandler.h"
#include "lightHandler.h"
#include "pathMappingHandler.h"
#include "nodeDefHandler.h"
#include "uiNodeGraphNodeHandler.h"
#include "batchOpsHandler.h"
#include "clipboardHandler.h"
#include "handlerInterface.h"
#include "rtid.h"
 
// Can't forward declare std::list or std::string.
#include <list>
#include <string>
 
UFE_NS_DEF {
 
 
class UFE_SDK_DECL RunTimeMgr
{
public:
 
    static RunTimeMgr& instance();
 
    RunTimeMgr(const RunTimeMgr&) = delete;
    RunTimeMgr& operator=(const RunTimeMgr&) = delete;
 
 
    struct UFE_SDK_DECL Handlers {
        HierarchyHandler::Ptr    hierarchyHandler;
        Transform3dHandler::Ptr  transform3dHandler;
        SceneItemOpsHandler::Ptr sceneItemOpsHandler;
        AttributesHandler::Ptr   attributesHandler;
        Object3dHandler::Ptr     object3dHandler;
        MaterialHandler::Ptr     materialHandler;
        ContextOpsHandler::Ptr   contextOpsHandler;
        UIInfoHandler::Ptr       uiInfoHandler;
        CameraHandler::Ptr       cameraHandler;
        LightHandler::Ptr        lightHandler;
        PathMappingHandler::Ptr  pathMappingHandler;
        NodeDefHandler::Ptr      nodeDefHandler;
        SceneSegmentHandler::Ptr sceneSegmentHandler;
        ConnectionHandler::Ptr   connectionHandler;
        UINodeGraphNodeHandler::Ptr uiNodeGraphNodeHandler;
        BatchOpsHandler::Ptr     batchOpsHandler;
    };
 
    Rtid register_(
        const std::string&              rtName,
        const Handlers&                 handlers
    );
    bool unregister(const Rtid& rtId);
 
    std::string getName(const Rtid& rtId) const;
 
    Rtid getId(const std::string& rtName) const;
 
    bool hasId(const Rtid& rtId) const;
 
    void setHierarchyHandler(
        const Rtid& rtId, const HierarchyHandler::Ptr& hierarchyHandler
    );
 
    void setTransform3dHandler(
        const Rtid& rtId, const Transform3dHandler::Ptr& transform3dHandler
    );
 
    void setSceneItemOpsHandler(
        const Rtid& rtId, const SceneItemOpsHandler::Ptr& sceneItemOpsHandler
    );
 
    void setAttributesHandler(
        const Rtid& rtId, const AttributesHandler::Ptr& attributesHandler
    );
 
    void setConnectionHandler(
        const Rtid& rtId, const ConnectionHandler::Ptr& connectionHandler
    );
 
    void setUINodeGraphNodeHandler(
        const Rtid& rtId, const UINodeGraphNodeHandler::Ptr& uiNodeGraphNodeHandler
    );
 
    void setObject3dHandler(
        const Rtid& rtId, const Object3dHandler::Ptr& object3dHandler
    );
 
    void setMaterialHandler(
        const Rtid& rtId, const MaterialHandler::Ptr& materialHandler
    );
 
    void setContextOpsHandler(
        const Rtid& rtId, const ContextOpsHandler::Ptr& contextOpsHandler
    );
 
    void setUIInfoHandler(
        const Rtid& rtId, const UIInfoHandler::Ptr& uiInfoHandler
    );
 
    void setCameraHandler(
        const Rtid& rtId, const CameraHandler::Ptr& cameraHandler
    );
 
    void setLightHandler(
        const Rtid &rtId, const LightHandler::Ptr &lightHandler);
 
    void setPathMappingHandler(
        const Rtid& rtId, const PathMappingHandler::Ptr& pathMappingHandler
    );
 
    void setNodeDefHandler(
        const Rtid& rtId, const NodeDefHandler::Ptr& nodeDefHandler
    );
 
    void setSceneSegmentHandler(
        const Rtid& rtId, const SceneSegmentHandler::Ptr& sceneSegmentHandler
    );
 
    void setBatchOpsHandler(
        const Rtid& rtId, const BatchOpsHandler::Ptr& batchOpsHandler
    );
 
    void setClipboardHandler(
        const Rtid& rtId, const ClipboardHandler::Ptr& clipboardHandler
    );
 
    HierarchyHandler::Ptr hierarchyHandler(const Rtid& rtId) const;
 
    const HierarchyHandler& hierarchyHandlerRef(const Rtid& rtId) const;
 
    Transform3dHandler::Ptr transform3dHandler(const Rtid& rtId) const;
 
    SceneItemOpsHandler::Ptr sceneItemOpsHandler(const Rtid& rtId) const;
 
    AttributesHandler::Ptr attributesHandler(const Rtid& rtId) const;
 
    ConnectionHandler::Ptr connectionHandler(const Rtid& rtId) const;
 
    UINodeGraphNodeHandler::Ptr uiNodeGraphNodeHandler(const Rtid& rtId) const;
 
    Object3dHandler::Ptr object3dHandler(const Rtid& rtId) const;
 
    MaterialHandler::Ptr materialHandler(const Rtid& rtId) const;
 
    ContextOpsHandler::Ptr contextOpsHandler(const Rtid& rtId) const;
 
    UIInfoHandler::Ptr uiInfoHandler(const Rtid& rtId) const;
 
    CameraHandler::Ptr cameraHandler(const Rtid& rtId) const;
 
    LightHandler::Ptr lightHandler(const Rtid &rtId) const;
 
    PathMappingHandler::Ptr pathMappingHandler(const Rtid& rtId) const;
 
    NodeDefHandler::Ptr nodeDefHandler(const Rtid& rtId) const;
 
    SceneSegmentHandler::Ptr sceneSegmentHandler(const Rtid& rtId) const;
 
    BatchOpsHandler::Ptr batchOpsHandler(const Rtid& rtId) const;
 
    ClipboardHandler::Ptr clipboardHandler(const Rtid& rtId) const;
 
    std::list<Rtid> getIds() const;
 
    void registerHandler(const Ufe::Rtid& rtId,
        const std::string& handlerId,
        const HandlerInterface::Ptr& handler);
 
    void unregisterHandler(const Ufe::Rtid& rtId, const std::string& handlerId);
 
    template <typename T> std::shared_ptr<T> handler(const Ufe::Rtid& rtId)
    {
        static_assert(std::is_base_of<HandlerInterface, T>::value, "Only Ufe::HandlerInterface types are allowed");
        return std::static_pointer_cast<T>(resolveHandler(rtId, T::id));
    }
 
private:
 
    RunTimeMgr();
 
    HandlerInterface::Ptr resolveHandler(const Ufe::Rtid& rtId, const std::string& handlerId);
 
};
 
}
 
#endif /* _runTimeMgr */