📄 LineGeometry.js¶
📊 Analysis Summary¶
| Metric | Count |
|---|---|
| 🔧 Functions | 4 |
| 🧱 Classes | 1 |
| 📦 Imports | 1 |
| 📊 Variables & Constants | 7 |
📚 Table of Contents¶
🛠️ File Location:¶
📂 examples/jsm/lines/LineGeometry.js
📦 Imports¶
| Name | Source |
|---|---|
LineSegmentsGeometry |
../lines/LineSegmentsGeometry.js |
Variables & Constants¶
| Name | Type | Kind | Value | Exported |
|---|---|---|---|---|
length |
number |
let/var | array.length - 3 |
✗ |
points |
Float32Array<ArrayBuffer> |
let/var | new Float32Array( 2 * length ) |
✗ |
length |
number |
let/var | array.length - 3 |
✗ |
colors |
Float32Array<ArrayBuffer> |
let/var | new Float32Array( 2 * length ) |
✗ |
length |
number |
let/var | points.length - 1 |
✗ |
positions |
Float32Array<ArrayBuffer> |
let/var | new Float32Array( 6 * length ) |
✗ |
geometry |
any |
let/var | line.geometry |
✗ |
Functions¶
LineGeometry.setPositions(array: number[] | Float32Array<ArrayBufferLike>): LineGeometry¶
JSDoc:
/**
* Sets the given line positions for this geometry.
*
* @param {Float32Array|Array<number>} array - The position data to set.
* @return {LineGeometry} A reference to this geometry.
*/
Parameters:
arraynumber[] | Float32Array<ArrayBufferLike>
Returns: LineGeometry
Calls:
super.setPositions
Internal Comments:
Code
setPositions( array ) {
// converts [ x1, y1, z1, x2, y2, z2, ... ] to pairs format
const length = array.length - 3;
const points = new Float32Array( 2 * length );
for ( let i = 0; i < length; i += 3 ) {
points[ 2 * i ] = array[ i ];
points[ 2 * i + 1 ] = array[ i + 1 ];
points[ 2 * i + 2 ] = array[ i + 2 ];
points[ 2 * i + 3 ] = array[ i + 3 ];
points[ 2 * i + 4 ] = array[ i + 4 ];
points[ 2 * i + 5 ] = array[ i + 5 ];
}
super.setPositions( points );
return this;
}
LineGeometry.setColors(array: number[] | Float32Array<ArrayBufferLike>): LineGeometry¶
JSDoc:
/**
* Sets the given line colors for this geometry.
*
* @param {Float32Array|Array<number>} array - The position data to set.
* @return {LineGeometry} A reference to this geometry.
*/
Parameters:
arraynumber[] | Float32Array<ArrayBufferLike>
Returns: LineGeometry
Calls:
super.setColors
Internal Comments:
Code
setColors( array ) {
// converts [ r1, g1, b1, r2, g2, b2, ... ] to pairs format
const length = array.length - 3;
const colors = new Float32Array( 2 * length );
for ( let i = 0; i < length; i += 3 ) {
colors[ 2 * i ] = array[ i ];
colors[ 2 * i + 1 ] = array[ i + 1 ];
colors[ 2 * i + 2 ] = array[ i + 2 ];
colors[ 2 * i + 3 ] = array[ i + 3 ];
colors[ 2 * i + 4 ] = array[ i + 4 ];
colors[ 2 * i + 5 ] = array[ i + 5 ];
}
super.setColors( colors );
return this;
}
LineGeometry.setFromPoints(points: any[]): LineGeometry¶
JSDoc:
/**
* Setups this line segments geometry from the given sequence of points.
*
* @param {Array<Vector3|Vector2>} points - An array of points in 2D or 3D space.
* @return {LineGeometry} A reference to this geometry.
*/
Parameters:
pointsany[]
Returns: LineGeometry
Calls:
super.setPositions
Internal Comments:
Code
setFromPoints( points ) {
// converts a vector3 or vector2 array to pairs format
const length = points.length - 1;
const positions = new Float32Array( 6 * length );
for ( let i = 0; i < length; i ++ ) {
positions[ 6 * i ] = points[ i ].x;
positions[ 6 * i + 1 ] = points[ i ].y;
positions[ 6 * i + 2 ] = points[ i ].z || 0;
positions[ 6 * i + 3 ] = points[ i + 1 ].x;
positions[ 6 * i + 4 ] = points[ i + 1 ].y;
positions[ 6 * i + 5 ] = points[ i + 1 ].z || 0;
}
super.setPositions( positions );
return this;
}
LineGeometry.fromLine(line: Line): LineGeometry¶
JSDoc:
/**
* Setups this line segments geometry from the given line.
*
* @param {Line} line - The line that should be used as a data source for this geometry.
* @return {LineGeometry} A reference to this geometry.
*/
Parameters:
lineLine
Returns: LineGeometry
Calls:
this.setPositions
Internal Comments:
Code
Classes¶
LineGeometry¶
Class Code
class LineGeometry extends LineSegmentsGeometry {
/**
* Constructs a new line geometry.
*/
constructor() {
super();
/**
* This flag can be used for type testing.
*
* @type {boolean}
* @readonly
* @default true
*/
this.isLineGeometry = true;
this.type = 'LineGeometry';
}
/**
* Sets the given line positions for this geometry.
*
* @param {Float32Array|Array<number>} array - The position data to set.
* @return {LineGeometry} A reference to this geometry.
*/
setPositions( array ) {
// converts [ x1, y1, z1, x2, y2, z2, ... ] to pairs format
const length = array.length - 3;
const points = new Float32Array( 2 * length );
for ( let i = 0; i < length; i += 3 ) {
points[ 2 * i ] = array[ i ];
points[ 2 * i + 1 ] = array[ i + 1 ];
points[ 2 * i + 2 ] = array[ i + 2 ];
points[ 2 * i + 3 ] = array[ i + 3 ];
points[ 2 * i + 4 ] = array[ i + 4 ];
points[ 2 * i + 5 ] = array[ i + 5 ];
}
super.setPositions( points );
return this;
}
/**
* Sets the given line colors for this geometry.
*
* @param {Float32Array|Array<number>} array - The position data to set.
* @return {LineGeometry} A reference to this geometry.
*/
setColors( array ) {
// converts [ r1, g1, b1, r2, g2, b2, ... ] to pairs format
const length = array.length - 3;
const colors = new Float32Array( 2 * length );
for ( let i = 0; i < length; i += 3 ) {
colors[ 2 * i ] = array[ i ];
colors[ 2 * i + 1 ] = array[ i + 1 ];
colors[ 2 * i + 2 ] = array[ i + 2 ];
colors[ 2 * i + 3 ] = array[ i + 3 ];
colors[ 2 * i + 4 ] = array[ i + 4 ];
colors[ 2 * i + 5 ] = array[ i + 5 ];
}
super.setColors( colors );
return this;
}
/**
* Setups this line segments geometry from the given sequence of points.
*
* @param {Array<Vector3|Vector2>} points - An array of points in 2D or 3D space.
* @return {LineGeometry} A reference to this geometry.
*/
setFromPoints( points ) {
// converts a vector3 or vector2 array to pairs format
const length = points.length - 1;
const positions = new Float32Array( 6 * length );
for ( let i = 0; i < length; i ++ ) {
positions[ 6 * i ] = points[ i ].x;
positions[ 6 * i + 1 ] = points[ i ].y;
positions[ 6 * i + 2 ] = points[ i ].z || 0;
positions[ 6 * i + 3 ] = points[ i + 1 ].x;
positions[ 6 * i + 4 ] = points[ i + 1 ].y;
positions[ 6 * i + 5 ] = points[ i + 1 ].z || 0;
}
super.setPositions( positions );
return this;
}
/**
* Setups this line segments geometry from the given line.
*
* @param {Line} line - The line that should be used as a data source for this geometry.
* @return {LineGeometry} A reference to this geometry.
*/
fromLine( line ) {
const geometry = line.geometry;
this.setPositions( geometry.attributes.position.array ); // assumes non-indexed
// set colors, maybe
return this;
}
}
Methods¶
setPositions(array: number[] | Float32Array<ArrayBufferLike>): LineGeometry¶
Code
setPositions( array ) {
// converts [ x1, y1, z1, x2, y2, z2, ... ] to pairs format
const length = array.length - 3;
const points = new Float32Array( 2 * length );
for ( let i = 0; i < length; i += 3 ) {
points[ 2 * i ] = array[ i ];
points[ 2 * i + 1 ] = array[ i + 1 ];
points[ 2 * i + 2 ] = array[ i + 2 ];
points[ 2 * i + 3 ] = array[ i + 3 ];
points[ 2 * i + 4 ] = array[ i + 4 ];
points[ 2 * i + 5 ] = array[ i + 5 ];
}
super.setPositions( points );
return this;
}
setColors(array: number[] | Float32Array<ArrayBufferLike>): LineGeometry¶
Code
setColors( array ) {
// converts [ r1, g1, b1, r2, g2, b2, ... ] to pairs format
const length = array.length - 3;
const colors = new Float32Array( 2 * length );
for ( let i = 0; i < length; i += 3 ) {
colors[ 2 * i ] = array[ i ];
colors[ 2 * i + 1 ] = array[ i + 1 ];
colors[ 2 * i + 2 ] = array[ i + 2 ];
colors[ 2 * i + 3 ] = array[ i + 3 ];
colors[ 2 * i + 4 ] = array[ i + 4 ];
colors[ 2 * i + 5 ] = array[ i + 5 ];
}
super.setColors( colors );
return this;
}
setFromPoints(points: any[]): LineGeometry¶
Code
setFromPoints( points ) {
// converts a vector3 or vector2 array to pairs format
const length = points.length - 1;
const positions = new Float32Array( 6 * length );
for ( let i = 0; i < length; i ++ ) {
positions[ 6 * i ] = points[ i ].x;
positions[ 6 * i + 1 ] = points[ i ].y;
positions[ 6 * i + 2 ] = points[ i ].z || 0;
positions[ 6 * i + 3 ] = points[ i + 1 ].x;
positions[ 6 * i + 4 ] = points[ i + 1 ].y;
positions[ 6 * i + 5 ] = points[ i + 1 ].z || 0;
}
super.setPositions( positions );
return this;
}