/*
Copyright 2008-2026
Matthias Ehmann,
Carsten Miller,
Andreas Walter,
Alfred Wassermann
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*/
import JXG from "../jxg.js";
import Type from "../utils/type.js";
import Geometry from '../math/geometry.js';
/**
* Constructs a new GeometryElement3D object.
* @class This is the basic class for 3D geometry elements like Point3D and Line3D.
* @constructor
* @augments JXG.GeometryElement
*
* @param {string} elType
*/
JXG.GeometryElement3D = function (view, elType) {
this.elType = elType;
/**
* Pointer to the view3D in which the element is constructed
* @type JXG.View3D
* @private
*/
this.view = view;
this.id = this.view.board.setId(this, elType);
/**
* Link to the 2D element(s) used to visualize the 3D element
* in a view. In case, there are several 2D elements, it is an array.
*
* @type Array
* @private
*
* @example
* p.element2D;
*/
this.element2D = null;
/**
* If this property exists (and is true) the element is a 3D element.
*
* @type Boolean
* @private
*/
this.is3D = true;
this.zIndex = 0.0;
this.view.objects[this.id] = this;
if (this.name !== "") {
this.view.elementsByName[this.name] = this;
}
};
JXG.extend(JXG.GeometryElement3D.prototype, {
setAttr2D: function(attr3D) {
var attr2D = attr3D;
attr2D.name = this.name;
attr2D.element3d = this;
attr2D.id = null; // The 2D element's id may not be controlled by the user.
return attr2D;
},
// Documented in element.js
setAttribute: function(attr) {
var i, key, value, arg, pair,
attributes = {};
// Normalize the user input
for (i = 0; i < arguments.length; i++) {
arg = arguments[i];
if (Type.isString(arg)) {
// pairRaw is string of the form 'key:value'
pair = arg.split(":");
attributes[Type.trim(pair[0])] = Type.trim(pair[1]);
} else if (!Type.isArray(arg)) {
// pairRaw consists of objects of the form {key1:value1,key2:value2,...}
JXG.extend(attributes, arg);
} else {
// pairRaw consists of array [key,value]
attributes[arg[0]] = arg[1];
}
}
for (i in attributes) {
if (attributes.hasOwnProperty(i)) {
key = i.replace(/\s+/g, "").toLowerCase();
value = attributes[i];
switch (key) {
case "fillColor":
case "numberpointshigh":
case "stepsu":
case "stepsv":
if (Type.exists(this.visProp[key]) &&
(!JXG.Validator[key] ||
(JXG.Validator[key] && JXG.Validator[key](value)) ||
(JXG.Validator[key] &&
Type.isFunction(value) &&
JXG.Validator[key](value())))
) {
value =
value.toLowerCase && value.toLowerCase() === "false"
? false
: value;
this._set(key, value);
}
break;
default:
this._set(key, value);
if (Type.exists(this.element2D)) {
this.element2D.setAttribute(attributes);
}
}
}
}
},
// Documented in element.js
getAttribute: function(key) {
var result;
key = key.toLowerCase();
switch (key) {
case "numberpointshigh":
case "stepsu":
case "stepsv":
result = this.visProp[key];
break;
default:
if (Type.exists(this.element2D)) {
result = this.element2D.getAttribute(key);
}
break;
}
return result;
},
// Documented in element.js
getAttributes: function() {
var attr = {},
i, key,
attr3D = ['numberpointshigh', 'stepsu', 'stepsv'],
le = attr3D.length;
if (Type.exists(this.element2D)) {
attr = Type.merge(this.element2D.getAttributes());
}
for (i = 0; i < le; i++) {
key = attr3D[i];
if (Type.exists(this.visProp[key])) {
attr[key] = this.visProp[key];
}
}
return attr;
},
// /**
// * Add transformations to this element.
// * @param {JXG.GeometryElement} el
// * @param {Transformation|Array} transform Either one {@link Transformation}
// * or an array of {@link JXG.Transformation}s.
// * @returns {JXG.CoordsElement} Reference to itself.
// */
addTransformGeneric: function (el, transform) {
var i,
list = Type.isArray(transform) ? transform : [transform],
len = list.length;
// There is only one baseElement possible
if (this.transformations.length === 0) {
this.baseElement = el;
}
for (i = 0; i < len; i++) {
this.transformations.push(list[i]);
}
return this;
},
removeTransformGeneric: function (transform) {
var i,
list = Type.isArray(transform) ? transform : [transform],
len = list.length;
for (i = 0; i < len; i++) {
Type.removeElementFromArray(this.transformations, list[i]);
}
if (this.transformations.length === 0) {
this.baseElement = null;
}
return this;
},
clearTransforms: function () {
this.transformations = [];
this.baseElement = null;
return this;
},
/**
* Set position of the 2D element. This is a
* callback function, executed in {@link JXG.GeometryElement#setPosition}.
* @param {Transformation} t transformation
* @memberof JXG.GeometryElement3D
* @private
* @see JXG.GeometryElement#setPosition
*/
setPosition2D: function(t) {
/* stub */
},
/**
* Project a 3D point to this element and update point.position. This function computes the
* preimage (u,v) of a 3D position \\((1, X, Y, Z)\\)
* @param {Array} p 3D position of the point (array of length 4, homogeneous coordinates)
* @param {Array} params Changed in place to the new parameters of the point in terms of the elements functions X, Y, Z.
* For example for a surface, params will contain values (u,v) such that the new 3D position is
* `p = [X(u, v), Z(u, v), Z(u, v)]`.
* @returns {Array} 3D coordinates of the projected point with homogeneous coordinates of the form [1, x, y, z].
* @memberof JXG.GeometryElement3D
* @private
*/
projectCoords: function(p, params) {
/* stub */
},
/**
* Computes the screen coordinates (e.g. of of the mouse pointer) to a position on a 3D object.
* @param {Array} pScr 2D screen coordinates (in pixel)
* @param {Array} params See {@link JXG.Math.Geometry.projectScreenCoordsToParametric}
* @returns Array of length 4 containing the coordinates of the nearest point on the curve or surface.
* @memberof JXG.GeometryElement3D
*/
// TODO check if Geometry.projectScreenCoordsToParametric has range or (range_u and range_v) - depending on the dimension given in params
projectScreenCoords: function (pScr, params, cyclic) {
return Geometry.projectScreenCoordsToParametric(pScr, this, params, cyclic);
},
// Documented in element.js
remove: function() {}
});
export default JXG.GeometryElement3D;