EventDispatcher → Object3D →

ArrowHelper

An 3D arrow object for visualizing directions.

Code Example

const dir = new THREE.Vector3( 1, 2, 0 );
//normalize the direction vector (convert to vector of length 1)
dir.normalize();
const origin = new THREE.Vector3( 0, 0, 0 );
const length = 1;
const hex = 0xffff00;
const arrowHelper = new THREE.ArrowHelper( dir, origin, length, hex );
scene.add( arrowHelper );

Constructor

new ArrowHelper( dir : Vector3, origin : Vector3, length : number, color : number | Color | string, headLength : number, headWidth : number )

Constructs a new arrow helper.

dir	The (normalized) direction vector. Default is `(0, 0, 1)`.
origin	Point at which the arrow starts. Default is `(0, 0, 0)`.
length	Length of the arrow in world units. Default is `1`.
color	Color of the arrow. Default is `0xffff00`.
headLength	The length of the head of the arrow. Default is `length*0.2`.
headWidth	The width of the head of the arrow. Default is `headLength*0.2`.

Properties

.cone : Mesh

The cone part of the arrow helper.

.line : Line

The line part of the arrow helper.

Methods

.dispose()

Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.

.setColor( color : number | Color | string )

Sets the color of the helper.

color

The color to set.

.setDirection( dir : Vector3 )

Sets the direction of the helper.

dir

The normalized direction vector.

.setLength( length : number, headLength : number, headWidth : number )

Sets the length of the helper.

length

Length of the arrow in world units.

headLength

The length of the head of the arrow.

Default is length*0.2.

headWidth

The width of the head of the arrow.

Default is headLength*0.2.

Source

src/helpers/ArrowHelper.js