viewbox.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the papyrus library.                             *
 *                                                                         *
 *   papyrus is free software; you can redistribute it and/or modify       *
 *   it under the terms of the GNU Lesser General Public License           *
 *   version 3.0 as published by the Free Software Foundation.             *
 *                                                                         *
 *   papyrus 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 version 3.0 for more details.       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with the papyrus library. If not, see                   *
 *   <http://www.gnu.org/licenses/>.                                       *
 ***************************************************************************/
#ifndef PAPYRUSVIEWBOX_H
#define PAPYRUSVIEWBOX_H

#include <papyrus/pointer.h>
#include <papyrus/region.h>
#include <papyrus/matrix.h>

namespace Papyrus {

class Viewbox : public Region {
  public:

    typedef enum ALIGN {
        ALIGN_NONE,
        ALIGN_XMIN_YMIN,
        ALIGN_XMID_YMIN,
        ALIGN_XMAX_YMIN,
        ALIGN_XMIN_YMID,
        ALIGN_XMID_YMID,
        ALIGN_XMAX_YMID,
        ALIGN_XMIN_YMAX,
        ALIGN_XMID_YMAX,
        ALIGN_XMAX_YMAX,
    } ALIGN;

    typedef enum MEET_OR_SLICE {
        MEET,
        SLICE
    } MEET_OR_SLICE;

    typedef PapyrusPointer<Viewbox> pointer;

    // TODO Add support for Object id constructors
    // TODO review whether the constructor needs to be made protected
    
    Viewbox(double x=0.0, double y=0.0, double w=0.0, double h=0.0, ALIGN align=ALIGN_NONE, MEET_OR_SLICE meet_or_slice = MEET);

    Viewbox(const Region& region, ALIGN align=ALIGN_NONE, MEET_OR_SLICE meet_or_slice = MEET);

    static pointer create(double x=0.0, double y=0.0, double w=0.0, double h=0.0, ALIGN align=ALIGN_NONE, MEET_OR_SLICE meet_or_slice = MEET);

    static pointer create(const Region& region, ALIGN align=ALIGN_NONE, MEET_OR_SLICE meet_or_slice = MEET);

    virtual ~Viewbox();

    Viewbox& operator=( const Region& other );

    Viewbox& operator=( const Viewbox& other );

    bool operator==( const Region& other );

    bool operator==( const Viewbox& other );

    void set_preserve_aspect_ratio(ALIGN align, MEET_OR_SLICE meet_or_slice = MEET);

    ALIGN alignment() const;

    MEET_OR_SLICE meet_or_slice() const;

    Matrix transformation_matrix(const Region& box) const;

protected:
    ALIGN m_align;
    MEET_OR_SLICE m_meet_or_slice;

};

}

#endif