FnViewerLocationEvent.h

// Copyright (c) 2017 The Foundry Visionmongers Ltd. All Rights Reserved.

#ifndef FNVIEWER_LOCATIONEVENT_H
#define FNVIEWER_LOCATIONEVENT_H

#include <FnAttribute/FnAttribute.h>
#include <FnViewer/suite/FnViewerDelegateSuite.h>

#include <string>

namespace Foundry
{
namespace Katana
{
namespace ViewerAPI
{

struct ViewerLocationStateChanges
{
    ViewerLocationStateChanges() :
        locationRemoved(false),
        attributesUpdated(false),
        localXformUpdated(false),
        excludedChanged(false),
        descendantsHiddenChanged(false) {}

    explicit ViewerLocationStateChanges(FnViewerLocationEventBitField flags)
    {
        parseBitfield(flags);
    }

private:
    FnViewerLocationEventBitField writeBitfield() const
    {
        FnViewerLocationEventBitField flags = 0;
        if (locationRemoved)
        {
            flags |= kFnViewerLocationEvent_locationRemoved;
        }
        if (attributesUpdated)
        {
            flags |= kFnViewerLocationEvent_attributesUpdated;
        }
        if (localXformUpdated)
        {
            flags |= kFnViewerLocationEvent_localXformUpdated;
        }
        if (excludedChanged)
        {
            flags |= kFnViewerLocationEvent_excludedChanged;
        }
        if (descendantsHiddenChanged)
        {
            flags |= kFnViewerLocationEvent_descendantsHiddenChanged;
        }
        return flags;
    }

    void parseBitfield(FnViewerLocationEventBitField flags)
    {
        locationRemoved = flags & kFnViewerLocationEvent_locationRemoved;
        attributesUpdated = flags & kFnViewerLocationEvent_attributesUpdated;
        localXformUpdated = flags & kFnViewerLocationEvent_localXformUpdated;
        excludedChanged = flags & kFnViewerLocationEvent_excludedChanged;
        descendantsHiddenChanged = flags &
                kFnViewerLocationEvent_descendantsHiddenChanged;
    }

public:
    bool locationRemoved;

    bool attributesUpdated;

    bool localXformUpdated;

    bool excludedChanged;

    bool descendantsHiddenChanged;

    // @cond FN_INTERNAL_DEV
    friend struct ViewerLocationEvent;
    // @endcond
};

struct ViewerLocationEvent
{
    ViewerLocationEvent()
        : localXformIsAbsolute(false),
          excluded(false),
          descendantsHidden(false),
          isVirtualLocation(false) {}

    explicit ViewerLocationEvent(const FnViewerLocationEventStruct& cStruct)
    : locationPath(cStruct.locationPath),
      attributes(FnAttribute::Attribute::CreateAndRetain(cStruct.attributes)),
      localXformMatrix(
              FnAttribute::Attribute::CreateAndRetain(cStruct.localXformMatrix))
    {
        parseBitfield(cStruct.flags);
    }

    FnViewerLocationEventStruct getCStruct() const
    {
        FnViewerLocationEventStruct event;
        event.locationPath = locationPath.c_str();
        event.attributes = attributes.getHandle();
        event.localXformMatrix = localXformMatrix.getHandle();
        event.flags = writeBitfield();
        return event;
    }

private:
    FnViewerLocationEventBitField writeBitfield() const
    {
        FnViewerLocationEventBitField flags = 0;

        if (localXformIsAbsolute)
        {
            flags |= kFnViewerLocationEvent_localXformIsAbsolute;
        }
        if (excluded)
        {
            flags |= kFnViewerLocationEvent_excluded;
        }
        if (descendantsHidden)
        {
            flags |= kFnViewerLocationEvent_descendantsHidden;
        }
        if (isVirtualLocation)
        {
            flags |= kFnViewerLocationEvent_isVirtualLocation;
        }

        flags |= stateChanges.writeBitfield();

        return flags;
    }

    void parseBitfield(FnViewerLocationEventBitField flags)
    {
        localXformIsAbsolute = flags &
                kFnViewerLocationEvent_localXformIsAbsolute;
        excluded = flags & kFnViewerLocationEvent_excluded;
        descendantsHidden = flags & kFnViewerLocationEvent_descendantsHidden;
        isVirtualLocation = flags & kFnViewerLocationEvent_isVirtualLocation;

        stateChanges.parseBitfield(flags);
    }

public:
    std::string locationPath;

    FnAttribute::GroupAttribute attributes;

    FnAttribute::DoubleAttribute localXformMatrix;

    bool localXformIsAbsolute;

    bool excluded;

    bool descendantsHidden;

    bool isVirtualLocation;

    ViewerLocationStateChanges stateChanges;
};

}  // namespace ViewerAPI
}  // namespace Katana
}  // namespace Foundry

#endif