cvrAffineLocation.h

Go to the documentation of this file.

/*
 * Copyright (C) 1998 - 2005
 * Lehrstuhl fuer Technische Informatik, RWTH-Aachen, Germany
 *
 *
 * This file is part of the Computer Vision and Robotics Library (CVR-Lib)
 *
 * The CVR-Lib is free software; you can redistribute it and/or
 * modify it under the terms of the BSD License.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the authors nor the names of its contributors may be
 *    used to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


/**
 * \file   cvrAffineLocation.h
 *         Definition of cvr::affineLocation which extends cvr::location
 *         by a transformation matrix.
 *         Global read/write methods to iostream and ostream operators are
 *         provided as well.
 * \author Roland Neul
 * \date   07.06.2004
 *
 * $Id: cvrAffineLocation.h,v 1.2 2006/06/06 11:32:58 doerfler Exp $
 */


#ifndef _CVR_AFFINE_LOCATION_H_
#define _CVR_AFFINE_LOCATION_H_

#include <cvrMatrix.h>
#include <cvrLocation.h>

namespace cvr {
  /**
   * The %affineLocation class is simply used to store the %parameters
   * associated with an affine %location. The only difference between
   * cvr::affineLocation and cvr::location is an additional transformation
   * Matrix associated with the affine %location.
   */
  class affineLocation : public location {
  public:
    /**
     * Default constructor.
     */
    affineLocation();

    /**
     * Copy constructor.
     * @param other the object to be copied
     */
    affineLocation(const affineLocation& other);

    /**
     * Destructor
     */
    ~affineLocation();

    /**
     * Copy data of "other" functor.
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    affineLocation& copy(const affineLocation& other);

    /**
     * Alias for copy member
     * @param other the functor to be copied
     * @return a reference to this functor object
     */
    affineLocation& operator=(const affineLocation& other);

    /**
     * operator ==
     */
    bool operator==(const affineLocation& p);

    /**
     * operator !=
     */
    bool operator!=(const affineLocation& p);

    /**
     * The affine transformation matrix
     *
     * Default: identity
     */
    matrix<float> transMatrix;

    /**
     * Return the orientation of the major axis of shape description
     * (transMatrix). For a perfect circle 0 is returned. Due to the symmetry
     * the range is [0;Pi].
     */
    float affineOrientation() const;

  };

  /**
   * Read a affine %location from the ioHandler
   */
  bool read(ioHandler& handler,
            affineLocation& loc,
            const bool complete=true);

  /**
   * Write a affine %location into the ioHandler
   */
  bool write(ioHandler& handler,
             const affineLocation& loc,
             const bool complete=true);

}

namespace std {
  ostream& operator<<(ostream& s,
                      const cvr::affineLocation& loc);
}

#endif