DtMetadataPublisher.h

Go to the documentation of this file.

/****************************************************************************** 
** Copyright (c) 2012 VT-MAK Technologies, Inc. 
** All rights reserved. 
******************************************************************************/ 


#pragma once

#include <vrvVideoStream/vrvVideoStream.h>

#include <vrvVideoStream/DtMetadataElement.h>

#include <vrvCore/DtUniqueID.h>

#include <vrvUtil/DtUnicode.h>

#include <matrix/vlVector.h>

#include <vector>

namespace makArchives
{
   class DtMetadataPublisherRecord;
}

namespace makVrv
{
   class DtObserver;
   class DtDe;
   class DtVideoStream;
   class DtSceneObject;

   class DT_DLL_VRVVIDEOSTREAM DtMetadataPublisher
   {
   public: 
      friend class DtMetadataPublisherCreator;

      virtual ~DtMetadataPublisher();

      virtual void realize( const makArchives::DtMetadataPublisherRecord& metadataConfig );

      virtual void setObserverName( const DtUnicode& observerName );

      virtual bool isAttached();

      virtual void attachEntity( makVrv::DtUniqueID entity );

      virtual void detach();

      virtual void addMetadataElement( DtMetadataElement* element );
      
      virtual void tick( double dt );

      // Get the total number of bytes currently in the publisher's buffer
      virtual int numBytes();

      virtual unsigned char* getBytes();

      virtual const DtVideoStream& videoStream();

      virtual const DtSceneObject& attachedEntitySceneObject();

      virtual const DtObserver& observer();

      virtual bool haveValidTargetPoint() const;

      virtual DtVector targetPoint() const;

      virtual DtDe& de();

   protected:

      DtMetadataPublisher( DtDe& de, const DtVideoStream& videoStream );

      virtual void slot_attachToChanged( makVrv::DtObserver* obs );

      virtual DtSceneObject* findSceneObjectFromElement( const DtElementID& id );

      virtual void updateTargetPoint();

   private:
      
      DtMetadataPublisher();

      DtMetadataPublisher( const DtMetadataPublisher& orig );

      DtMetadataPublisher& operator=( const DtMetadataPublisher& rhs );

   protected:
      DtDe& myDe;
      const DtVideoStream& myVideoStream;
      std::vector<DtMetadataElement*> myElements;
      DtObserver* myObserver;

      DtSceneObject* myAttachedEntitySceneObject;
      bool myIsAttached;
      makVrv::DtUniqueID myAttachedEntity;

      unsigned char* myBuffer;
      int myBufferLength;
      bool myValidTargetPoint;
      DtVector myTargetPoint;
   };

   class DT_DLL_VRVVIDEOSTREAM DtMetadataPublisherCreator
   {
   public:
      DtMetadataPublisherCreator();
      virtual ~DtMetadataPublisherCreator();

      virtual DtMetadataPublisher* create( DtDe& de, const DtVideoStream& videoStream ) = 0;
   };
}