sfObject.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 <memory>
#include <string>
#include <sstream>
#include <Exports.h>
#include <ksHierarchyObject.h>
#include "sfUser.h"
#include "sfProperty.h"
#include "sfName.h"
 
namespace KS {
namespace SceneFusion2 {
    class sfSession;
 
    class EXTERNAL sfObject :
        public ksHierarchyObject<sfObject>
    {
    public:
        typedef std::shared_ptr<sfObject> SPtr;
 
        enum ObjectFlags : uint8_t
        {
            NoFlags = 0,
            OptionalChildren = 1 << 1,
            Transient = 1 << 2
        };
 
        static SPtr Create(const sfName& type, sfProperty::SPtr propertyPtr = nullptr, ObjectFlags flags = NoFlags);
 
        virtual ~sfObject() {};
 
        virtual std::string ToString() = 0;
 
        virtual const uint32_t& Id() const = 0;
 
        virtual const sfName& Type() const = 0;
 
        virtual const ObjectFlags Flags() const = 0;
 
        virtual sfProperty::SPtr Property() = 0;
 
        virtual void SetProperty(sfProperty::SPtr propertyPtr) = 0;
 
        virtual std::shared_ptr<sfSession> Session() = 0;
 
        virtual bool IsSyncing() = 0;
 
        virtual bool IsCreated() = 0;
 
        virtual bool IsCreatePending() = 0;
 
        virtual bool IsUnsubscriptionPending() = 0;
 
        virtual bool IsDeletePending() = 0;
 
        virtual sfUser::SPtr LockOwner() = 0;
 
        virtual bool CanEdit() = 0;
 
        virtual bool CanEditChildren() = 0;
 
        virtual bool IsLocked() = 0;
 
        virtual bool IsLockPending() = 0;
 
        virtual bool IsFullyLocked() = 0;
 
        virtual bool IsPartiallyLocked() = 0;
 
        virtual bool IsLockedDirectly() = 0;
 
        virtual void RequestLock() = 0;
 
        virtual void ReleaseLock() = 0;
 
        virtual bool SetChildIndex(int index) = 0;
    };
} // SceneFusion2
} // KS