ARMarker.h

Go to the documentation of this file.

/*
 *  ARMarker.h
 *  ARToolKit5
 *
 *  This file is part of ARToolKit.
 *
 *  ARToolKit is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Lesser General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  ARToolKit is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with ARToolKit.  If not, see <http://www.gnu.org/licenses/>.
 *
 *  As a special exception, the copyright holders of this library give you
 *  permission to link this library with independent modules to produce an
 *  executable, regardless of the license terms of these independent modules, and to
 *  copy and distribute the resulting executable under terms of your choice,
 *  provided that you also meet, for each linked independent module, the terms and
 *  conditions of the license of that module. An independent module is a module
 *  which is neither derived from nor based on this library. If you modify this
 *  library, you may extend this exception to your version of the library, but you
 *  are not obligated to do so. If you do not wish to do so, delete this exception
 *  statement from your version.
 *
 *  Copyright 2015 Daqri, LLC.
 *  Copyright 2010-2015 ARToolworks, Inc.
 *
 *  Author(s): Julian Looser, Philip Lamb
 *
 */

#ifndef ARMARKER_H
#define ARMARKER_H

#include <AR/ar.h>
#include <AR/arFilterTransMat.h>

#include <ARWrapper/Image.h>
#include <ARWrapper/ARPattern.h>

#include <vector>

class ARController; // Forward declaration of owner.

class ARMarker {
    
private:
    ARFilterTransMatInfo *m_ftmi;
    ARdouble   m_filterCutoffFrequency;
    ARdouble   m_filterSampleRate;

protected:
    ARdouble trans[3][4];                   

        void allocatePatterns(int count);

        void freePatterns();

    ARdouble m_positionScaleFactor;

public:
    
        enum MarkerType {
                SINGLE,                                                         
                MULTI,                                                          
        NFT                                 
        };

        int UID;                                                                
        MarkerType type;                                                
        
    // Factory methods.
    static std::vector<ARMarker *> newFromConfigDataFile(const char *markersConfigDataFilePath, ARPattHandle *arPattHandle, int *patternDetectionMode_out);
    static ARMarker* newWithConfig(const char* cfg, ARPattHandle *arPattHandle);
    
        
    // Inputs from subclasses.
    bool visiblePrev;                       
        bool visible;                                                   
    
    // Output.
        ARdouble transformationMatrix[16];              
        ARdouble transformationMatrixR[16];             
        
        int patternCount;                                               
        ARPattern** patterns;                                   

        ARMarker(MarkerType type);

        virtual ~ARMarker();
        
    void setPositionScalefactor(ARdouble scale);
    ARdouble positionScalefactor();
    
    virtual bool update(const ARdouble transL2R[3][4] = NULL);

        ARPattern* getPattern(int n);
    
    // Filter control.
    void setFiltered(bool flag);
    bool isFiltered();
    ARdouble filterSampleRate();
    void setFilterSampleRate(ARdouble rate);
    ARdouble filterCutoffFrequency();
    void setFilterCutoffFrequency(ARdouble freq);

};


#endif // !ARMARKER_H