controlInstance.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2020 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/


#pragma once

#include "legionDataStore/export.h"

#include "legionDataStore/dataTypes.h"
#include "legionDataStore/vector.h"
#include "legionDataStore/objectType.h"

#include "legionDataStore/span.h"


namespace Legion
{
   typedef UInt32 ControlId;
   typedef UInt32 ParameterId;
   typedef UInt64 ControlHandle;

   class ControlManager;

   const UInt16 BROADCAST_ADDR = 0xffff;

   class LEGION_DLL ControlInstance
   {
   public:
      ControlInstance(ControlHandle handle);

      virtual ~ControlInstance();

      ControlInstance(const ControlInstance& orig);

      ControlInstance& operator=(const ControlInstance& orig);

      ControlHandle handle() const;

      ControlId typeId() const;

      void setSourceId(ClientId id);
      ClientId sourceId() const;

      void setTargetId(ClientId id);
      ClientId targetId() const;


      template<typename DATA_TYPE>
      DATA_TYPE data(ParameterId parameterId) const;

      template<typename DATA_TYPE>
      const Span<DATA_TYPE> dataArray(ParameterId parameterId) const;

      template<typename DATA_TYPE>
      void setData(ParameterId parameterId, const DATA_TYPE& val);

      template<typename DATA_TYPE>
      void setDataArray(ParameterId parameterId, const Span<DATA_TYPE>& val);

      template<typename DATA_TYPE>
      void addDataArray(ParameterId parameterId, const Span<DATA_TYPE>& val);

      template<typename DATA_TYPE>
      void removeDataArray(ParameterId parameterId, const Span<DATA_TYPE>& val);


      void setDataArrayLength(ParameterId parameterId, UInt32 length);
      UInt32 dataArrayLength(ParameterId parameterId) const;

   protected:
      ControlHandle myHandle;
   };
}