layout_2d.h

Go to the documentation of this file.

/*
 * layout_2d.h
 *
 * Copyright (C) 2007  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of the <organization> 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 THOMAS A. VAUGHAN ''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 THOMAS A. VAUGHAN 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.
 */

#ifndef WAVEPACKET_LAYOUT_2D_H__
#define WAVEPACKET_LAYOUT_2D_H__

// includes --------------------------------------------------------------------
#include "common/common.h"


/// \ingroup geometric
/*@{*/

////////////////////////////////////////////////////////////////////////////////
///
/// \defgroup layout Layout API
///
/// This is an extremely primitive API for performing basic object layout.  I
/// only have 2D layouts for now and have no plans for higher dimensions :)
///
/// This isn't much code but felt better abstracted to a general library
/// rather than put in the application.
///
////////////////////////////////////////////////////////////////////////////////

/*@{*/


namespace layout {

enum eLayoutType {
        eLayout_Horizontal      = 1,
        eLayout_Vertical        = 2,

        eLayout_Invalid         = 0
};

struct layout_info_t {
        // constructor, manipulators
        layout_info_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        type = eLayout_Invalid;
                        spacing = 0.0;
                }

        // data fields
        eLayoutType     type;   // what sort of layout?
        float           spacing;// spacing between objects
};


struct object_t {
        // constructor, manipulators
        object_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        id = "";
                        width = height = x = y = 0.0;
                }

        // data fields
        std::string     id;     // opaque ID for client
        float           width;
        float           height;
        float           x;
        float           y;
};

typedef std::vector<object_t> vec_obj_t;        // order matters!


////////////////////////////////////////////////////////////////////////////////
//
//      API
//
////////////////////////////////////////////////////////////////////////////////

/// the only function in the 2D layout library!
///
/// Given the layout instructions (layout_info_t object), and the list
/// of objects to be laid out (vec_obj_t vector), this routine calculates
/// the proper position for each object.
///  - On input, each object_t in the vector must have id, width and height set.
///  - On output, each object_t will be provided with x/y coordinates.
void performLayout(IN const layout_info_t& info,
                                IO vec_obj_t& objects);


};      // layout namespace

#endif  // WAVEPACKET_LAYOUT_2D_H__