FramePathVerifier.hpp

Go to the documentation of this file.

/***********************************
   Copyright 2018 Ravishankar Mathur

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
***********************************/

#ifndef _OF_FRAMEPATHVERIFIER_
#define _OF_FRAMEPATHVERIFIER_

#include <OpenFrames/Export.h>
#include <OpenFrames/FrameTracker.hpp>
#include <vector>

namespace OpenFrames
{

class ReferenceFrame;
typedef std::vector<ReferenceFrame*> FramePath;

  class OF_EXPORT FramePathVerifier : public FrameTracker
  {
  public:
    FramePathVerifier();

      // Called when a frame is added to or removed from a tracked frame
    virtual void childAdded(ReferenceFrame* child, ReferenceFrame* parent) {};
    virtual void childRemoved(ReferenceFrame* child, ReferenceFrame* parent);

      // Does not apply to this type of FrameTracker
    virtual void setRoot( ReferenceFrame* frame ) {}

    void setFramePath(const FramePath &path);
    inline bool isFramePathValid() {return _valid;}
  protected:
    virtual ~FramePathVerifier();
    void _clearPath();

    FramePath _framePath;
    bool _valid;
  };

} // !namespace OpenFrames

#endif