abstractNodeVisuals.js

/*
 * A general superclass for the a graphic engine used by nodes on the Pedigree graph. Contains
 * information about positioning of the graphical elements of the node
 */

var AbstractNodeVisuals = Class.create({

    initialize: function(node, x, y) {
        this._node = node;
        this._absoluteX = x;
        this._absoluteY = y;
    },

    /*
     * Returns the node for which the graphics are being drawn
     */
    getNode: function() {
        return this._node;
    },

    /*
     * Returns the current X coordinate of this node on the canvas, taking into consideration transformation data.
     */
    getX: function() {
        return this._absoluteX;
    },

    /*
     * Changes the X coordinate of the node
     *
     * @param x the x coordinate on the canvas
     * @param animate set to true if you want to animate the transition
     * @param callback the function called at the end of the animation
     */
    setX: function(x, animate, callback) {
        this.setPos(x, this.getY(), animate, callback);
    },

    /*
     * Returns the current Y coordinate of this node on the canvas, taking into consideration transformation data.
     */
    getY: function() {
        return this._absoluteY;
    },

    /*
     * Changes the Y coordinate of the node
     *
     * @param y the y coordinate on the canvas
     * @param animate set to true if you want to animate the transition
     * @param callback the function called at the end of the animation
     */
    setY: function(y, animate, callback) {
        this.setPos(y, this.getX(), animate, callback);
    },

    /*
     * Returns an array containing the x and y coordinates of the node on canvas.
     */
    getPos: function() {
        return [this.getX(), this.getY()];
    },

    /*
     * [Abstract Method]
     * Changes the position of the node to (X,Y)
     *
     * @param x the x coordinate on the canvas
     * @param y the y coordinate on the canvas
     * @param animate set to true if you want to animate the transition
     * @param callback the function called at the end of the animation
     */
    setPos: function(x, y, animate, callback) {
    },

    /*
     * Determines whether this node is selected
     */
    setSelected: function(isSelected) {
        this._isSelected = isSelected;
    },

    /*
     * Returns a Raphael set of all the graphics and labels associated with this node.
     */
    getAllGraphics: function() {
        return editor.getPaper().set(this.getShapes());
    },

    /*
     * Returns a Raphael set of graphic elements of which the icon of the node consists. Does not
     * include hoverbox elements or labels.
     */
    getShapes: function() {
        return editor.getPaper().set()
    },

    /*
     * Removes all the graphical elements of this node from the canvas
     */
    remove: function() {
        this.getAllGraphics().remove();
    }
});