Figure.icc

Go to the documentation of this file.

/*
    Copyright (c) 2002-2009 Tampere University.
 
    This file is part of TTA-Based Codesign Environment (TCE).
 
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom the
    Software is furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    DEALINGS IN THE SOFTWARE.
 */
/**
 * @file Figure.icc
 *
 * Inline implementation of Figure class.
 *
 * @author Ari Metsähalme 2004 (ari.metsahalme-no.spam-tut.fi)
 * @note rating: yellow
 * @note reviewed Jul 22 2004 by tr, ml, jm, am
 */
 
#include <iostream>
using std::cerr;
using std::endl;
 
/**
 * Returns the top-left location of the Figure's bounding rectangle.
 *
 * @return The top-left location of the Figure's bounding rectangle.
 */
inline wxPoint
Figure::location() const {
    return location_;
}
 
/**
 * Sets the top-left location of the Figure's bounding rectangle.
 *
 * @param point New location.
 */
inline void
Figure::setLocation(wxPoint point) {
    location_ = point;
}
 
/**
 * Sets the x-coordinate of the Figure's location.
 *
 * @param x New x-coordinate.
 */
inline void
Figure::setX(int x) {
    location_.x = x;
    xSet_ = true;
}
 
/**
 * Sets the y-coordinate of the Figure's location.
 *
 * @param y New y-coordinate.
 */
inline void
Figure::setY(int y) {
    location_.y = y;
}
 
/**
 * Returns the Figure's bounding rectangle.
 *
 * @return The Figure's bounding rectangle.
 */
inline wxRect
Figure::bounds() const {
    return wxRect(location_, size_);
}
 
/**
 * Returns the Figure's virtual bounding rectangle for easying
 * selection of smaller blocks.
 *
 * Default implementation returns normal bounds.
 *
 * @return The Figure's virtual bounding rectangle.
 */
inline wxRect
Figure::virtualBounds() const {
    return wxRect(location_, size_);
}
 
/**
 * Sets an 'ok' x-coordinate, that will be used if not decided
 * otherwise.
 *
 * @param prefX New preferred x-coordinate.
 */
inline void
Figure::setPreferredX(int prefX) {
    location_.x = prefX;
}
 
/**
 * Tells if the x-coordinate of the Figure has been finally decided.
 * 
 * @return True if x-coordinate has been fixed.
 */
inline bool
Figure::xSet() const {
    return xSet_;
}
 
/**
 * Clears the flag that tells that the x-coordinate of this Figure has
 * been set.
 */
inline void
Figure::clearXSetFlag() {
    xSet_ = false;
}
 
/**
 * Adds a Figure as a child of this Figure.
 *
 * @param child Child to be added.
 */
inline void
Figure::addChild(Figure* child) {
    children_.push_back(child);
}
 
/**
 * Returns the number of child Figures.
 *
 * @return The number of child Figures.
 */
inline int
Figure::childCount() const {
    return children_.size();
}
 
/**
 * Returns the child figure at index.
 *
 * @param index Index of the child to return.
 * @return The child figure corresponding to the given index.
 */
inline Figure*
Figure::child(int index) const {
    return children_[index];
}
 
/**
 * Empty default implementation that can be used if no specific laying
 * out needs to be done.
 */
inline void
Figure::layoutSelf(wxDC*) {
}
 
/**
 * Empty default implementation that can be used if the Figure is invisible.
 *
 * @param dc Device context.
 */
inline void
Figure::drawSelf(wxDC*) {
}