GetDummy

method

module.exports.GetDummy()

module.exports.GetDummy = function() {
    var dummy = new NodeType(module.exports.DUMMY, "Dummy Node", "This is an invisible dummy node", null);

    dummy.hasOffsetEdge = false;
    dummy.hasPaddedEdge = false;

    dummy.padding = 0;
    dummy.width = 0;
    dummy.height = 0;
    dummy.scale = 1.0;

    return dummy;
};

NodeType

function

NodeType()

Option name	Type	Description
type	String	The name of this type (e.g. 'IfElseBranch')
name	String	The display friendly name of this type (e.g. 'If ... Else ...')
desc	String	This is a brief description of what this nodes of this type are for
svg	Fragment	This is a document fragment of svg which is the visual representation of nodes of this type

function NodeType(type, name, desc, svg) {
    this.id = "type-" + id_count;
    id_count += 1;

    this.type = type;
    this.name = name;
    this.desc = desc;

    this.hasOffsetEdge = false;
    this.hasPaddedEdge = false;

    // Default display parameters
    this.padding = 0;
    this.width = 0;
    this.height = 0;
    this.scale = 1.0;

    // Default type hierarchy relationships
    this.Parent = null;
    this.Children = null;
    this.DataProperties = null;
    this.Connections = null;
    this.Constraints = null;

    if(_.includes(svg, "<svg") || _.includes(svg, "<xml")) {
        this._svg  = svg;
        this._file = null;
    } else {
        this._svg = null;
        this._file = svg;
    }
}

NodeType.prototype.getJSON = function() {
    return {
        "id": this.id,
        "type": this.type
    };
};

NodeType.prototype.GetEdgeOffset = function(connType) {
    if(this.hasOffsetEdge) {
        if(connType !== undefined && this.Connections !== null) {
            if(this.Connections.hasOwnProperty(connType)) {
                return {
                    x: this.Connections[connType].x * this.scale,
                    y: this.Connections[connType].y * this.scale
                }
            }
        }

        return {
            x: this.scale * this.width / 2,
            y: this.scale * this.height / 2
        }
    }

    return {
        x: 0,
        y: 0
    };
};

NodeType.prototype.GetEdgePadding = function(connType) {
    if(this.hasPaddedEdge) {
        return this.padding;
    }

    return 0;
};

SetWidth

method

NodeType.prototype.SetWidth()

Option name	Type	Description
width	number	The width in pixels

NodeType.prototype.SetWidth = function(width) {
    this.width = width;
};

SetHeight

method

NodeType.prototype.SetHeight()

Option name	Type	Description
height	number	The height in pixels

NodeType.prototype.SetHeight = function(height) {
    this.height = height;
};

SetScale

method

NodeType.prototype.SetScale()

Option name	Type	Description
scale	number	A percentage between 0.0 and 1.0

NodeType.prototype.SetScale = function(scale) {
    if(scale > 1.0 || scale < 0.0) scale = 1.0;

    this.scale = scale;
};

SetProperties

method

NodeType.prototype.SetProperties()

Option name	Type	Description
json	number	JSON object describing the data properties for this type of node.

NodeType.prototype.SetProperties = function(json) {
    this.DataProperties = json;
};

NodeType.prototype.SetPadding = function(padding) {
    if(padding > 0) {
        this.hasPaddedEdge = true;
        this.padding = padding;
    } else {
        this.hasPaddedEdge = false;
        this.padding = 0;
    }
};

NodeType.prototype.SetConnections = function(connections) {
    if(connections !== null) {
        this.hasOffsetEdge = true;

        if(connections === "default") {
            this.Connections = null;
        } else {
            this.Connections = connections;
        }
    } else {
        this.hasOffsetEdge = false;
        this.Connections = null;
    }
};

SetConstraints

method

NodeType.prototype.SetConstraints()

Option name	Type	Description
json	number	JSON object describing the constraints for this type of node.

NodeType.prototype.SetConstraints = function(json) {
    this.Constraints = json;
};

SetParent

method

NodeType.prototype.SetParent()

Option name	Type	Description
parent	number	A reference to the parent NodeType object

NodeType.prototype.SetParent = function(parent) {
    this.Parent = parent;
};

SetChildren

method

NodeType.prototype.SetChildren()

Option name	Type	Description
children	number	An array with references to the children NodeType objects

NodeType.prototype.SetChildren = function(children) {
    this.Children = children;
};

HasParent

method

NodeType.prototype.HasParent() ->boolean

NodeType.prototype.HasParent = function() {
    return (this.Parent !== null);
};

GetParent

method

NodeType.prototype.GetParent() ->NodeType

NodeType.prototype.GetParent = function() {
    return this.Parent;
};

HasChildren

method

NodeType.prototype.HasChildren() ->boolean

NodeType.prototype.HasChildren = function() {
    return (this.Children !== null);
};

GetChildren

method

NodeType.prototype.GetChildren() ->object

NodeType.prototype.GetChildren = function() {
    return this.Children;
};

GetDataObject

method

NodeType.prototype.GetDataObject() ->object

NodeType.prototype.GetDataObject = function() {
    var obj = $.extend(true, {}, this.DataProperties, null);

    return obj;
};

GetConstraintObject

method

NodeType.prototype.GetConstraintObject() ->object

NodeType.prototype.GetConstraintObject = function() {
    return $.extend(true, {}, this.Constraints, null);
};

GetFragment

function

GetFragment()

Option name	Type	Description
view	String	The view property from the config json file. Either contains a path to an svg file, or inline svg code.

function GetFragment(view) {
    var frag = Snap.parse(view);

    var g = frag.select('g');
    g.attr('class', 'node-svg');

    return g;
}

getRawSvg

method

NodeType.prototype.getRawSvg() ->Fragment

NodeType.prototype.getRawSvg = function() {
    return Snap.parse(this._svg);
};

getSvg

method

NodeType.prototype.getSvg() ->Fragment

NodeType.prototype.getSvg = function() {
    return GetFragment(this._svg);
};