JSDoc: Class: ND

Constructor

new ND(n, settingsopt)

N-dimensional graphics. Creates an N-dimensional graphic object, checks for a collision between an n-dimensional plane and an n-dimensional graphics object and returns the (n-1)-dimensional intersection geometry if a collision was occurs.

Parameters:

Name Type Attributes Default Description

n number space dimension of the graphical object.

settings

object

{}

The following settings are available

Properties

Name Type Attributes Default Description

object

object

geometry, position and rotation of the n-dimensional graphical object.

Properties

Name Type Attributes Default Description

name String <optional> name of n-dimensional graphical object.

color

number | String | object

'lime'

color of N-dimensional graphic object.

number - Hex triplet color. Example: 0xffffff - white color
String - color name. See list of available color names in the _colorKeywords object in the Color.js file.
object - Sets the color separately for each vertice.
	You can choose one way for setting of the vertice color from two available:
	
	1. Set the fourth w coordinate of each vertex in a range from
		settings.options.scales.w.min to
		settings.options.scales.w.max
		
		w coordinate is index of palette color. See  method from ColorPicker class.
		Example:
		settings.object.geometry.position: [
			//pyramid
			[0,-0.9428090415820634,0.33333333333333326, 1],
			[0.8164965662730563,0.4714045207910317,0.33333333333333326, 0.5],
			[-0.8164965662730563,0.4714045207910317,0.33333333333333326, 0],
			[7.32733549761259e-9,4.230438555019589e-9,-1.0, -1.0],
		],
	
	2. Set a settings.object.geometry.colors array. 
Have effect only if settings.object.geometry.colors are not defined.

faces

boolean | object

true or object - display the n-dimensional graphical object faces instead of edges.

Properties

Name	Type	Attributes	Default	Description
`opacity`	float	<optional>	0.5	color Float in the range of 0.0 - 1.0 indicating how transparent the material is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque. If the transparent property is not set to true, the material will remain fully opaque and this value will only affect its color. See Material.opacity.
`transparent`	boolean	<optional>	true	Defines whether this material is transparent. This has an effect on rendering as transparent objects need special treatment and are rendered after non-transparent objects. When set to true, the extent to which the material is transparent is controlled by setting its opacity property. See Material.transparent.

geometry

Array | Object

Array of vertices and indices of the n-dimensional graphical object.

Every item of array is n-dimensional vector of vertice of object.
Or Object. See object's keys below.

Properties

Name	Type	Attributes	Default	Description
`position`	Array	<optional>		Array of vertices of the n-dimensional graphical object. Every item of array is n-dimensional vector of vertice of object. For example, if you want to create a tetrahedron, then you need to create an array of 4 vertices. settings.object.geometry.position: [ [-0.6, 0.1, 0.8],//0 [0.7, 0.5, 0.9],//1 [0, -0.4, 0.8],//2 [0, 0, -0.6]//3 ],
`colors`	Array	<optional>		Array of colors for the each vertex. Every vertex is associated with 3 values of the colors array. Each value of the colors array is red or green or blue color of the particular vertex in range from 0 to 1. 0 is no color. 1 is full color. For example: settings.object.geometry.colors: [ 1, 0, 0,//red color of the position[0] vertex. 0, 1, 0,//green color of the position[1] vertex. 0, 0, 1,//blue color of the position[2] vertex. 1, 1, 1,//white color of the position[3] vertex. ], Have effect only if settings.object.geometry.position points are not THREE.Vector4 type. See arrayFuncs parametr of the Player.getPoints(...) for details.
`opacity`	array	<optional>		array of opacities for the each vertex. Each item of array is float value in the range of 0.0 - 1.0 indicating how transparent the material is. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
`boRememberPosition`	Array	<optional>	true	true - Remember vertex positions for higher performance. As result, new vertex positions have no effect.
`indices`	Array	<optional>		Array of indices of vertices of the n-dimensional graphical object. Allows for vertices to be re-used across multiple segments. Indices is divided to segments: indices[0] is edges. Every edge is two indexes of the edge's vertices. Used in 1D objects and higher. indices[1] is faces. Every face is three indexes of the edges from indices[0]. Used in 3D objects and higher. indices[2] is bodies. Every bodie is four face indexes from indices[1]. Used in 4D objects and higher. For example: n = 1 line. settings.object.geometry.position = [ [-0.5, 1],//0 [0.5]//1 ] settings.object.geometry.indices = [ [ 0,//index of the settings.object.geometry.position[0] = [-0.5, 1] 1,//index of the settings.object.geometry.position[1] = [0.5] ]//0 ]//0 n = 2 triangle settings.object.geometry.position = [ [-0.7, 0.2],//0 [0.8, 0.6],//1 [0.1, -0.5]//2 ], //edges settings.object.geometry.indices[0] = [ [0, 1],//0 index of the settings.object.geometry.positions [-0.7, 0.2] and [0.8, 0.6] [0, 2],//1 index of the settings.object.geometry.positions [-0.7, 0.2] and [0.1, -0.5] [1, 2] //2 index of the settings.object.geometry.positions [0.8, 0.6] and [0.1, -0.5] ] n = 3 tetrahedron. settings.object.geometry.position = [ [0.8, -0.6, 0.1],//0 [0.9, 0.7, 0.5],//1 [0.8, 0, -0.4],//2 [-0.6, 0.1, 0.1]//3 ], //edges settings.object.geometry.indices[0] = [ [0, 1]//0 index of the settings.object.geometry.positions [0.8, -0.6, 0.1] and [0.9, 0.7, 0.5] [0, 2]//1 index of the settings.object.geometry.positions [0.8, -0.6, 0.1] and [0.8, 0, -0.4] [0, 3]//2 index of the settings.object.geometry.positions [0.8, -0.6, 0.1] and [-0.6, 0.1, 0.1] [1, 2]//3 index of the settings.object.geometry.positions [0.9, 0.7, 0.5] and [0.8, 0, -0.4] [1, 3]//4 index of the settings.object.geometry.positions [0.9, 0.7, 0.5] and [-0.6, 0.1, 0.1] [2, 3]//5 index of the settings.object.geometry.positions [0.8, 0, -0.4] and [-0.6, 0.1, 0.1] ] //faces. Indices of the edges settings.object.geometry.indices[0] settings.object.geometry.indices[1] = [ [0, 1, 3]//tetrahedron's face 0 [0, 2, 4]//tetrahedron's face 1 [3, 4, 5]//tetrahedron's face 2 [1, 2, 5]//tetrahedron's face 3 ] n = 4 pentachoron 5-cell. settings.object.geometry.position = [ [0.8, -0.6, 0.1, -0.85],//0 [0.9, 0.7, 0.5, -0.55],//1 [0.8, 0, -0.4, 0],//2 [-0.6, 0.1, -0.3, 0.55],//3 [-0.5, 0.2, 0.3, 0.85],//4 ], //edges settings.object.geometry.indices[0] = [ [0, 1]//0 index of the settings.object.geometry.positions [0.8, -0.6, 0.1, -0.85] and [0.9, 0.7, 0.5, -0.55] [0, 2]//1 index of the settings.object.geometry.positions [0.8, -0.6, 0.1, -0.85] and [0.8, 0, -0.4, 0] [0, 3]//2 index of the settings.object.geometry.positions [0.8, -0.6, 0.1, -0.85] and [-0.6, 0.1, -0.3, 0.55] [0, 4]//3 index of the settings.object.geometry.positions [0.8, -0.6, 0.1, -0.85] and [-0.5, 0.2, 0.3, 0.85] [1, 2]//4 index of the settings.object.geometry.positions [0.9, 0.7, 0.5, -0.55] and [0.8, 0, -0.4, 0] [1, 3]//5 index of the settings.object.geometry.positions [0.9, 0.7, 0.5, -0.55] and [-0.6, 0.1, -0.3, 0.55] [1, 4]//6 index of the settings.object.geometry.positions [0.9, 0.7, 0.5, -0.55] and [-0.5, 0.2, 0.3, 0.85] [2, 3]//7 index of the settings.object.geometry.positions [0.8, 0, -0.4, 0] and [-0.6, 0.1, -0.3, 0.55] [2, 4]//8 index of the settings.object.geometry.positions [0.8, 0, -0.4, 0] and [-0.5, 0.2, 0.3, 0.85] [3, 4]//9 index of the settings.object.geometry.positions [-0.6, 0.1, 0.1, 0.55] and [-0.5, 0.2, 0.3, 0.85] ] //faces. Indices of the edges settings.object.geometry.indices[0] settings.object.geometry.indices[1] = [ [7, 8, 9],//0 no 0, 1 vertices [5, 6, 9],//1 no 0, 2 vertices [4, 6, 8],//2 no 0, 3 vertices [4, 5, 7],//3 no 0, 4 vertices [2, 3, 9],//4 no 1, 2 vertices [1, 3, 8],//5 no 1, 3 vertices [1, 2, 7],//6 no 1, 4 vertices [0, 3, 6],//7 no 2, 3 vertices [0, 2, 5],//8 no 2, 4 vertices [0, 1, 4],//9 no 3, 4 vertices ] //bodies. Indices of the faces settings.object.geometry.indices[1] settings.object.geometry.indices[2] = [ [2, 1, 3, 0],//0 no 0 vertice [5, 6, 4, 0],//1 no 1 vertice [8, 7, 1, 4],//2 no 2 vertice [9, 7, 2, 5],//3 no 3 vertice [9, 8, 3, 6],//4 no 4 vertice ]

position

Array | number

Array - position of the n-dimensional graphical object in n-dimensional coordinates.

number - position of the 0 coordinate of the n-dimensional graphical object.

rotation

Array | number

Array - rotation in radians of the n-dimensional graphical object in n-dimensional coordinates.

n space dimension	Array index	Axis of rotation	Axis type	Note
0				no rotation
1				no rotation
2	0			No effect for 2-dimensional space
	1			No effect for 2-dimensional space
	2	2(z)	point
3	0	0(x)	line
	1	1(y)
	2	2(z)
4	0	0, 1(xy)	plane
	1	0, 2(xz)
	2	0, 3(xw)
	3	1, 2(yz)
	4	1, 3(yw)
	5	2, 3(zw)
5	0	0, 1, 2(xyz)	3D space
	1	0, 1, 3(xyw)
	2	0, 1, 4(xy4)
	3	0, 2, 3(xzw)
	4	0, 2, 4(xz4)
	5	0, 3, 4(xw4)
	6	1, 2, 3(yzw)
	7	1, 2, 4(yz4)
	8	1, 3, 4(yw4)
	9	2, 3, 4(zw4)

number - rotation in radians around axis 0 or rotation around axis 2 for 2D objects i.e. space dimension n = 2.
See Can rotations in 4D be given an explicit matrix form?, Rotation matrix.
Examples:
n = 4, rotation = [Math.PI / 5, 1, 2, 3, 4, 5]
rotation around 0, 1(xy) plane is Math.PI / 5 radians.
rotation around 0, 2(xz) plane is 1 radian.
etc.

n = 4, rotation = Math.PI / 5
rotation around 0, 1(xy) plane is Math.PI / 5 radians.

n = 2, rotation = [0, 0, Math.PI / 4]
rotation around 2(z) point is Math.PI / 4 radians.

n = 2, rotation = Math.PI / 5
rotation around 2(z) point is Math.PI / 5 radians.

geometry.iAxes Array <optional> array of indices of the axes. For example if iAxes is [1,2], then axis 1 interpret as axis 0 and axis 2 interpret as axis 1. As result, you can rotate axes around another axis to 90 degrees. In example above you have rotated axis 1 and 2 around axis 0 to 90 degrees.

plane Boolean <optional> false true - create vectorPlane. See settings.vectorPlane below.

vectorPlane Array <optional> n-dimensional position of the panel intersecting with the settings.object.geometry n-dimensional graphical object. Available only if settings.plane is true.

scene THREE.Scene <optional> THREE.Scene. Define scene if you want visualise n-dimensional plane and n-dimensional object to 3-D space of the scene.

options Options <optional> See Options. Uses only if scene is defined.

onIntersection Event <optional> Plane and object intersection event. The onIntersection function parameter is the (n-1)-dimensional geometry of the intersection if a collision occurred, or undefined if a collision did not occur.

isRaycaster Boolean <optional> true false - Ignoring of the mouse over of the object event or accept of the event if isRaycaster is true or undefined.

Source:

nD.js, line 39

See:

Extends

MyObject

Members

defaultColor

Gets default color of the 3D object, that added to scene.

Source:

nD.js, line 3439

geometry

returns geometry of N-dimensional object. See settings.object.geometry parameter of ND.
	key geometry - get or set a geometry of nD object. See See settings.object.geometry parameter of ND.
	key D3 - Projection of nD object to 3D space for visualization.
		D3.points - Points of projection. See .setFromPoints of THREE.BufferGeometry.
		D3.indices - Indices of points of projection. See .setIndex of THREE.BufferGeometry.
		D3.color - color of projection.

Source:

nD.js, line 3326

object

Gets and sets an object. See settings.object of the ND constructor parameter above.

Source:

nD.js, line 3334

object3D

Gets a 3D object that created from ND and added to scene.

Source:

nD.js, line 3330

object3Dopacity

Sets an opacity of the graphical object. Opacity is range from 0 is transparent to 1 is opacity. Default is 1.

Source:

nD.js, line 3451

vectorPlane

Gets N-dimensional vector of the plane that intersects nD object. See settings.vectorPlane of the ND constructor parameter above.

Source:

nD.js, line 3314

Methods

getPoint(i)

Parameters:

Name	Type	Description
`i`	number	position id.

Source:

nD.js, line 2090

Returns:

Vector of the i position of the settings.bufferGeometry.attributes.position

intersection(geometryIntersectionopt, iIntersectionsopt)

Parameters:

Name Type Attributes Default Description

geometryIntersection

geometryIntersection

{ position: [], indices: [[]] }

Arrays of vertices and indexes of the result of the intersection of the panel and the nD object. See settings.object.geometry of ND constructor for details.

Properties

Name	Type	Attributes	Description
`position`	array	<optional>	Array of vertices of the result of the intersection. See settings.object.geometry.position of ND constructor for details.
`indices`	array	<optional>	Array of indices of vertices of the result of the intersection. See settings.object.geometry.indices of ND constructor for details.

iIntersections array <optional> Array of indices that have been added to geometryIntersection.indices

Source:

nD.js, line 2797

Returns:

an array of intersection points of vectorPlane and geometry. See constructor for details.

positionOffset(position, positionId)

Position offset.

Parameters:

Name	Type	Description
`position`	object	BufferGeometry position attribute of the graphical object.
`positionId`	number	Position identifier.

Source:

nD.js, line 3446

Returns:

Offset of the position in the position attribute.