/*
Copyright 2008-2026
Matthias Ehmann,
Michael Gerhaeuser,
Carsten Miller,
Bianca Valentin,
Alfred Wassermann,
Peter Wilfahrt
This file is part of JSXGraph.
JSXGraph is free software dual licensed under the GNU LGPL or MIT License.
You can redistribute it and/or modify it under the terms of the
* GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version
OR
* MIT License: https://github.com/jsxgraph/jsxgraph/blob/master/LICENSE.MIT
JSXGraph 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 for more details.
You should have received a copy of the GNU Lesser General Public License and
the MIT License along with JSXGraph. If not, see <https://www.gnu.org/licenses/>
and <https://opensource.org/licenses/MIT/>.
*/
/*global JXG: true, define: true*/
/*jslint nomen: true, plusplus: true*/
import JXG from "../jxg.js";
import Type from "../utils/type.js";
/**
* @class
* A composition is a simple container that manages none or more {@link JXG.GeometryElement}s.
* @param {Object} elements A list of elements with a descriptive name for the element as the key and a reference
* to the element as the value of every list entry. The name is used to access the element later on.
* @example
* var p1 = board.create('point', [1, 2]),
* p2 = board.create('point', [2, 3]),
* c = new JXG.Composition({
* start: p1,
* end: p2
* });
*
* // moves p1 to [3, 3]
* c.start.moveTo([3, 3]);
* @class JXG.Composition
*/
JXG.Composition = function (elements) {
var e,
that = this,
genericMethods = [
/**
* Invokes setAttribute for every stored element with a setAttribute method and hands over the given arguments.
* See {@link JXG.GeometryElement#setAttribute} for further description, valid parameters and return values.
* @name setAttribute
* @memberOf JXG.Composition.prototype
* @function
*/
"setAttribute",
/**
* Invokes setParents for every stored element with a setParents method and hands over the given arguments.
* See {@link JXG.GeometryElement#setParents} for further description, valid parameters and return values.
* @name setParents
* @memberOf JXG.Composition.prototype
* @function
*/
"setParents",
/**
* Invokes prepareUpdate for every stored element with a prepareUpdate method and hands over the given arguments.
* See {@link JXG.GeometryElement#prepareUpdate} for further description, valid parameters and return values.
* @name prepareUpdate
* @memberOf JXG.Composition.prototype
* @function
*/
"prepareUpdate",
/**
* Invokes updateRenderer for every stored element with a updateRenderer method and hands over the given arguments.
* See {@link JXG.GeometryElement#updateRenderer} for further description, valid parameters and return values.
* @name updateRenderer
* @memberOf JXG.Composition.prototype
* @function
*/
"updateRenderer",
/**
* Invokes update for every stored element with a update method and hands over the given arguments.
* See {@link JXG.GeometryElement#update} for further description, valid parameters and return values.
* @name update
* @memberOf JXG.Composition.prototype
* @function
*/
"update",
/**
* Invokes fullUpdate for every stored element with a fullUpdate method and hands over the given arguments.
* See {@link JXG.GeometryElement#fullUpdate} for further description, valid parameters and return values.
* @name fullUpdate
* @memberOf JXG.Composition.prototype
* @function
*/
"fullUpdate",
/**
* Invokes highlight for every stored element with a highlight method and hands over the given arguments.
* See {@link JXG.GeometryElement#highlight} for further description, valid parameters and return values.
* @name highlight
* @memberOf JXG.Composition.prototype
* @function
*/
"highlight",
/**
* Invokes noHighlight for every stored element with a noHighlight method and hands over the given arguments.
* See {@link JXG.GeometryElement#noHighlight} for further description, valid parameters and return values.
* @name noHighlight
* @memberOf JXG.Composition.prototype
* @function
*/
"noHighlight"
],
generateMethod = function (what) {
return function () {
var i;
for (i in that.elements) {
if (that.elements.hasOwnProperty(i)) {
if (Type.exists(that.elements[i][what])) {
that.elements[i][what].apply(that.elements[i], arguments);
}
}
}
return that;
};
};
for (e = 0; e < genericMethods.length; e++) {
this[genericMethods[e]] = generateMethod(genericMethods[e]);
}
this.elements = {};
this.objects = this.elements;
this.elementsByName = {};
this.objectsList = [];
// unused, required for select()
this.groups = {};
for (e in elements) {
if (elements.hasOwnProperty(e)) {
this.add(e, elements[e]);
}
}
this.dump = true;
this.subs = {};
};
Type.copyMethodMap(JXG.Composition, {
setAttribute: "setAttribute",
setProperty: "setAttribute",
setParents: "setParents",
add: "add",
remove: "remove",
select: "select"
});
JXG.extend(
JXG.Composition.prototype,
/** @lends JXG.Composition.prototype */ {
/**
* Adds an element to the composition container.
* @param {String} what Descriptive name for the element, e.g. <em>startpoint</em> or <em>area</em>. This is used to
* access the element later on. There are some reserved names: <em>elements, add, remove, update, prepareUpdate,
* updateRenderer, highlight, noHighlight</em>, and all names that would form invalid object property names in
* JavaScript.
* @param {JXG.GeometryElement|JXG.Composition} element A reference to the element that is to be added. This can be
* another composition, too.
* @returns {Boolean} True, if the element was added successfully. Reasons why adding the element failed include
* using a reserved name and providing an invalid element.
*/
add: function (what, element) {
if (!Type.exists(this[what]) && Type.exists(element)) {
if (Type.exists(element.id)) {
this.elements[element.id] = element;
} else {
this.elements[what] = element;
}
if (Type.exists(element.name)) {
this.elementsByName[element.name] = element;
}
element.on("attribute:name", this.nameListener, this);
this.objectsList.push(element);
this[what] = element;
Type.extendInstanceMethodMap(this, what, what);
return true;
}
return false;
},
/**
* Remove an element from the composition container.
* @param {String} what The name used to access the element.
* @returns {Boolean} True, if the element has been removed successfully.
*/
remove: function (what) {
var found = false,
e;
for (e in this.elements) {
if (this.elements.hasOwnProperty(e)) {
if (this.elements[e].id === this[what].id) {
found = true;
break;
}
}
}
if (found) {
delete this.elements[this[what].id];
if (Type.exists(this[what].name)) {
delete this.elementsByName[this[what].name];
}
Type.removeElementFromArray(this.objectsList, this[what]);
if (this.hasOwnProperty("methodMap")) {
delete this.methodMap[what];
}
delete this[what];
}
return found;
},
nameListener: function (oval, nval, el) {
delete this.elementsByName[oval];
this.elementsByName[nval] = el;
},
select: function (filter) {
// for now, hijack JXG.Board's select() method
if (Type.exists(JXG.Board)) {
return JXG.Board.prototype.select.call(this, filter);
}
return new JXG.Composition();
},
getParents: function () {
return this.parents;
},
getType: function () {
return this.elType;
},
getAttributes: function () {
var attr = {},
e;
for (e in this.subs) {
if (this.subs.hasOwnProperty(e)) {
attr[e] = this.subs[e].visProp;
}
}
return this.attr;
}
}
);
export default JXG.Composition;