Three-typeable-text NPM

The Three.js Typeable Text Library v0.1.6

The intention of this library is to make creation and integration of typeable text elements seamless with threejs.

Support me here https://ko-fi.com/joshfield Follow me here https://twitter.com/HexaField

Design:

This is designed to be as simple as creating the ThreeTypeableText object, adding it to the scene, and optionally updating it to show the cursor. There is some basic functionality that should integrate with most project designs easily. You can find what is planned for this at the bottom.

Example:

A live demo can be found here

Usage:

function init()
{
    // ... initialise threejs

    var textField = new ThreeTypeableText({
        camera: camera,
        font: font,
        string: 'Hello text!'
    });
    
    scene.add(textField.getObject())
}

function animate()
{
    // ...
    
    textField.updateCursor() // only used for displaying the cursor, not necessary for functionality

    // ...
}

Parameters:

camera A THREE.Camera (only needed if useDocumentListeners is true)

font The THREE.Font to use (always needed)

string The text to display

useDocumentListeners: Use built-in document listeners (default: true)

material A THREE.Material to use (default: new THREE.MeshBasicMaterial({ side: THREE.DoubleSide }))

align Shifts the text. (options: 'left', 'center', 'right', default: 'center')

fontScale Scales the geometry (default: 1)

onChange A callback that is fired when the text changes internally

onFocus A callback that is fired when the focus changes internally (true if gaining focus, false otherwise)

maxEditHistory The number of copies of the string to put in edit history (default: 32)

API:

Setting useDocumentListeners to false will require you to use the following functions to update the text manually

// Change the text
textField.setText('New text!');

// Returns the text
textField.getText(); // returns 'New text!'

// To access the text as an object use
textField.getObject().position.setY(10)

// Move the cursor 3 letters to the right
textField.actionMoveCursor(3);

// Returns the character index of the cursor
textField.getCursorIndex(); // returns 3

// Text will now display 'Ne text!'
textField.actionBackspace();

// Text will now display 'Netext!'
textField.actionDelete();

// Move the cursor 1 letter to the left
textField.actionMoveCursor(-1);

// Text will now display 'N8etext!'
textField.actionType('8');

// Will now display 'Ne text!'
textField.actionUndo(2);

// Will return 'Netext!'
textField.actionRedo(1);

// Will stop all internal document listeners & hide the cursor
textField.actionFocus(false);

// Get the text height
textField.getLineHeight(); // depends on fontScale and the font itself

// Check to see if the user has clicked
// This should run on your mouse click event

// - supplying a valid THREE.Vector3 will move the cursor
// - supplying an invalid point will defocus the text

raycaster.setFromCamera(mouse, camera)
var intersections = raycaster.intersectObject(textField.getObject())
textField.actionClick(intersections.length > 0 ? intersections[0].point : false);