sfSession.h

/*************************************************************************
 *
 * KINEMATICOUP CONFIDENTIAL
 * __________________
 *
 *  Copyright (2016-2021) KinematicSoup Technologies Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of KinematicSoup Technologies Incorporated and its
 * suppliers, if any.  The intellectual and technical concepts contained
 * herein are proprietary to KinematicSoup Technologies Incorporated
 * and its suppliers and may be covered by Canadian and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from KinematicSoup Technologies Incorporated.
 */
#pragma once
#include <string>
#include <memory>
#include <ksEvent.h>
#include <Exports.h>
#include "sfUser.h"
#include "sfObject.h"
#include "sfProperty.h"
#include "sfDictionaryProperty.h"
#include "sfListProperty.h"
#include "sfReferenceProperty.h"
 
namespace KS {
namespace SceneFusion2 {
 
    class EXTERNAL sfSession : 
        public std::enable_shared_from_this<sfSession>
    {
    public:
        typedef std::shared_ptr<sfSession> SPtr;
 
        typedef std::function<void(sfObject::SPtr objPtr, int childIndex)> CreateHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr)> DeleteHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr)> ConfirmDeleteHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr)> LockHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr)> UnlockHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr)> LockOwnerChangeHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr)> DirectLockChangeHandler;
 
        typedef std::function<void(sfDictionaryProperty::SPtr dictPtr, const sfName& key)> DictionaryRemoveHandler;
 
        typedef std::function<void(sfObject::SPtr objPtr, int childIndex)> ParentChangeHandler;
 
        typedef std::function<void(sfProperty::SPtr propertyPtr)> PropertyChangeHandler;
 
        typedef std::function<void(sfListProperty::SPtr listPtr, int index, int count)> ListAddHandler;
 
        typedef std::function<void(sfListProperty::SPtr listPtr, int index, int count)> ListRemoveHandler;
 
        typedef std::function<void(sfUser::SPtr userPtr)> UserJoinHandler;
 
        typedef std::function<void(sfUser::SPtr userPtr)> UserLeaveHandler;
 
        typedef std::function<void(sfUser::SPtr userPtr)> UserColorChangeHandler;
 
        typedef std::function<void(bool, sfObject::SPtr objPtr)> AcknowledgeSubscriptionHandler;
 
        typedef ksEvent<sfObject::SPtr&>::SPtr ObjectEventHandle;
 
        typedef ksEvent<sfObject::SPtr&, int&>::SPtr ObjectIndexEventHandle;
 
        typedef ksEvent<sfUser::SPtr&>::SPtr UserEventHandle;
 
        typedef ksEvent<sfProperty::SPtr&>::SPtr PropertyEventHandle;
 
        typedef ksEvent<sfListProperty::SPtr&, int&, int&>::SPtr ListPropertyEventHandle;
        
        typedef ksEvent<sfDictionaryProperty::SPtr&, sfName&>::SPtr DictionaryPropertyEventHandle;
 
        typedef ksEvent<bool&, sfObject::SPtr&>::SPtr AcknowledgeSubscriptionEventHandle;
 
        virtual ~sfSession() {}
 
        virtual ObjectIndexEventHandle RegisterOnCreateHandler(CreateHandler handler) = 0;
 
        virtual void UnregisterOnCreateHandler(ObjectIndexEventHandle eventPtr) = 0;
 
        virtual ObjectEventHandle RegisterOnDeleteHandler(DeleteHandler handler) = 0;
 
        virtual void UnregisterOnDeleteHandler(ObjectEventHandle eventPtr) = 0;
 
        virtual ObjectEventHandle RegisterOnConfirmDeleteHandler(ConfirmDeleteHandler handler) = 0;
 
        virtual void UnregisterOnConfirmDeleteHandler(ObjectEventHandle eventPtr) = 0;
 
        virtual ObjectEventHandle RegisterOnLockHandler(LockHandler handler) = 0;
 
        virtual void UnregisterOnLockHandler(ObjectEventHandle eventPtr) = 0;
 
        virtual ObjectEventHandle RegisterOnUnlockHandler(UnlockHandler handler) = 0;
 
        virtual void UnregisterOnUnlockHandler(ObjectEventHandle eventPtr) = 0;
 
        virtual ObjectEventHandle RegisterOnLockOwnerChangeHandler(LockOwnerChangeHandler handler) = 0;
 
        virtual void UnregisterOnLockOwnerChangeHandler(ObjectEventHandle eventPtr) = 0;
 
        virtual ObjectEventHandle RegisterOnDirectLockChangeHandler(DirectLockChangeHandler handler) = 0;
 
        virtual void UnregisterOnDirectLockChangeHandler(ObjectEventHandle eventPtr) = 0;
 
        virtual ObjectIndexEventHandle RegisterOnParentChangeHandler(ParentChangeHandler handler) = 0;
 
        virtual void UnregisterOnParentChangeHandler(ObjectIndexEventHandle eventPtr) = 0;
 
        virtual PropertyEventHandle RegisterOnPropertyChangeHandler(PropertyChangeHandler handler) = 0;
 
        virtual void UnregisterOnPropertyChangeHandler(PropertyEventHandle eventPtr) = 0;
 
        virtual DictionaryPropertyEventHandle RegisterOnDictionaryRemoveHandler(DictionaryRemoveHandler handler) = 0;
 
        virtual void UnregisterOnDictionaryRemoveHandler(DictionaryPropertyEventHandle eventPtr) = 0;
 
        virtual ListPropertyEventHandle RegisterOnListAddHandler(ListAddHandler handler) = 0;
 
        virtual void UnregisterOnListAddHandler(ListPropertyEventHandle eventPtr) = 0;
 
        virtual ListPropertyEventHandle RegisterOnListRemoveHandler(ListRemoveHandler handler) = 0;
 
        virtual void UnregisterOnListRemoveHandler(ListPropertyEventHandle eventPtr) = 0;
 
        virtual UserEventHandle RegisterOnUserJoinHandler(UserJoinHandler handler) = 0;
 
        virtual void UnregisterOnUserJoinHandler(UserEventHandle eventPtr) = 0;
 
        virtual UserEventHandle RegisterOnUserLeaveHandler(UserLeaveHandler handler) = 0;
 
        virtual void UnregisterOnUserLeaveHandler(UserEventHandle eventPtr) = 0;
 
        virtual UserEventHandle RegisterOnUserColorChangeHandler(UserColorChangeHandler handler) = 0;
 
        virtual void UnregisterOnUserColorChangeHandler(UserEventHandle eventPtr) = 0;
 
        virtual AcknowledgeSubscriptionEventHandle RegisterOnAcknowledgeSubscriptionHandler(
            AcknowledgeSubscriptionHandler handler) = 0;
 
        virtual void UnregisterOnAcknowledgeSubscriptionHandler(AcknowledgeSubscriptionEventHandle eventPtr) = 0;
 
        virtual bool IsConnected() const = 0;
 
        virtual sfUser::SPtr LocalUser() const = 0;
 
        virtual uint32_t LocalUserId() = 0;
 
        virtual bool EditsDisabled() const = 0;
 
        virtual size_t NumObjects() const = 0;
 
        virtual sfObject::SPtr GetObject(uint32_t id) const = 0;
 
        virtual const std::list<sfObject::SPtr>& GetRootObjects() const = 0;
 
        virtual sfUser::SPtr GetUser(uint32_t id) const = 0;
 
        virtual const std::list<sfUser::SPtr>& GetUsers() const = 0;
 
        virtual uint32_t GetObjectCount(const sfName& type) const = 0;
 
        virtual uint32_t GetObjectLimit(const sfName& type) const = 0;
 
        virtual std::vector<sfReferenceProperty::SPtr> GetReferences(
            sfObject::SPtr objPtr) const = 0;
 
        virtual void Create(sfObject::SPtr objPtr) = 0;
 
        virtual void Create(sfObject::SPtr objPtr, sfObject::SPtr parentPtr, int childIndex) = 0;
 
        virtual void Create(std::list<sfObject::SPtr>& objectList) = 0;
 
        virtual void Create(std::list<sfObject::SPtr>& objectList, sfObject::SPtr parentPtr, int childIndex) = 0;
 
        virtual void Delete(sfObject::SPtr objPtr) = 0;
 
        virtual uint32_t GetStringTableId(const sfName& str) = 0;
 
        virtual sfName GetStringFromTable(uint32_t id) = 0;
 
        virtual sfName TryGetStringFromTable(uint32_t id) = 0;
 
        virtual void SetUserColor(float r, float g, float b) = 0;
 
        virtual void SubscribeToChildren(sfObject::SPtr objPtr) = 0;
 
        virtual void UnsubscribeFromChildren(sfObject::SPtr objPtr) = 0;
    };
} // SceneFusion2
} // KS