import TextOpentype from '@mobilizing/library/js/Mobilizing/renderer/3D/three/shape/3D/composite/TextOpentype.js'

public class |source

TextOpentype

Extends:

Mesh → TextOpentype

3D Text is created from a standard font file compatible with opentype.js.

Constructor Summary

Public Constructor
public	constructor(params: Object)

Member Summary

Public Members
public	bevelEnabled: *
public	bevelSegments: *
public	bevelSize: *
public	bevelThickness: *
public	depth: *
public	fontFile: *
public	fontSize: *
public	geometry: *
public	geometryNormalAttributes: *
public	geometryUVAttributes: *
public	geometryVerticesAttributes: *
public	index: number
public	indices: *[]
public	lineMode: *
public	lineModeDivision: *
public	material: *
public	steps: *
public	text: *
public	transform: *

Private Members
private	_extrudeSettings: {"steps": , "depth": , "bevelEnabled": , "bevelThickness": , "bevelSize": , "bevelSegments": }
private	_font: *
private	_mesh: *

Method Summary

Public Methods
public	createTextGeometry(shapes: *)
public	createTextLines(shapes: *)
public	makeShapes(text: ):
public	setText(text: *)

Inherited Summary

From class Mesh
public static	generateStrokeMesh(mesh: Mesh, inflateValue: Number): Mesh Static Utils to generate the stroke Mesh from a given shape
public static	generateStrokeShape(mesh: Mesh, inflateValue: Number): * Static Utils to generate the stroke for the given vertices with the given stroke width
public static	geometryIsCW(geometry: Geometry): Boolean Static Utils to check the direction of a geometry (ccw o cw)
public	events: *
public	geometry: *
public	geometryColorAttributes: *
public	geometryNormalAttributes: *
public	geometryUVAttributes: *
public	geometryVerticesAttributes: *
public	indices: *[]
public	material: *
public	maxVertices: *
public	name: *
public	normalsCount: number
public	rootName: *
public	transform: *
public	type: *
public	uvCount: number
public	vertexCount: number
private	_mesh: *
public	attachMaterial(material: Material) Attach the material to this mesh.
public	clone(): * deep clone this Mesh return {Mesh} a new clone (copy) of this Mesh in a new Mesh object
public	computeNormals() compute Face and Vertex Normals for the current geometry
public	constructMesh() Call this method to construct a custom mesh
public	erase(recursive: Boolean) Erase this mesh's geometry and material from memory
public	generateFillMesh(vertices: *) Generate the mesh for the given vertices and generates flat uvs for it.
public	generateFlatUVs() Generate the flat uvs for this mesh.
public	genereateMesh() genereate a mesh from already made geometry and material
public	getBoundingBox(force: Boolean): Object Compute and returns the bounding box of the current geometry or Node, which is an object made of 2 Vector3.
public	getBoundingSphere(force: Boolean): Object Compute and returns the bounding sphere of the current geometry or Node, which is an object with a radius :
public	getCenter(): Vector3 Returns the center of the geometry (vertices) based on boundingbox
public	getHeight(): Number Shortcut for getSize().y
public	getLength(): Number Shortcut for getSize().z
public	getNativeGeometry(): *
public	getNativeObject(): *
public	getSize(): Vector3 Returns the size of the geometry (vertices) based on boundingbox
public	getUVs(index: integer): Array Get the UV of this mesh geometry
public	getVertexColors(): Array<Color> Get the vertexColors of this mesh geometry's vertices
public	getVertices(): Array Get the vertices of this mesh geometry
public	getVisible(): Boolean Get the visibility of this mesh
public	getWidth(): Number Shortcut for getSize().x
public	makeGeometryBuffers() Generate Float32Array and BufferAttribute for this geometry
public	pushNormal(n1: Vector2, n2: Vector2, n3: Vector2) Adds a Normal to the current geometry
public	pushQuad(v1: Vector3, v2: Vector3, v3: Vector3, v4: Vector3) Adds a Quad to the current geometry
public	pushTriangle(v1: Vector3, v2: Vector3, v3: Vector3) Adds a triangle to the current geometry
public	pushUV(uv1: Vector2, uv2: Vector2, uv3: Vector2) Adds a UV to the current geometry
public	pushVertex(v: Vector3) Adds a vertex to the current geometry
public	reverseNormals() convinient method to reverse this Mesh geometry's normals
public	setCastShadow(enabled: Boolean) setCastShadow
public	setCenter(x: number, y: number, z: number) Defines the position of the geometry's center (NOT the transform!).
public	setEventEmitterTrigger(scope: , eventType: )
public	setMaterial(material: Material \| String) Sets this Mesh material.
public	setMaxVertices(val: *)
public	setReceiveShadow(enabled: Boolean) setReceiveShadow
public	setRootName(name: String)
public	setRotationX(value: float) Set the rotation around x axis of the vertices (not the transform!)
public	setRotationY(value: float) Set the rotation around y axis of the vertices (not the transform!)
public	setRotationZ(value: float) Set the rotation around z axis of the vertices (not the transform!)
public	setScale(number\|Vector3\|Vector2: float \| Vector3 \| Vector2, Number: float, Number: float) Set the scale of the geometry (vertices) - this is not like scaling the transform.
public	setTranslation(value: float, value: float, value: float) Set the translation along all axis of the vertices (not the transform!)
public	setUVs(index: integer, uvs: Array) Set the UV of this mesh geometry
public	setVertex(index: , vertex: )
public	setVertexColors(colors: Array<Color>) Set the vertexColors of this mesh geometry's vertices
public	setVertices(vertices: Object) Set the vertices of this mesh geometry
public	setVisible(value: Boolean) Set the visibility of this mesh
private	updateMaterial() Updates this mesh material

Public Constructors

public constructor(params: Object) source

Construct an empty and unfinished Mesh for which a geometry must be constructed. Once filled with vertices, constructMesh method must be called, or a method generating a complete Mesh must be used (i.e generateFillMesh)

Override:

Mesh#constructor

Params:

Name	Type	Attribute	Description
params	Object		Parameters object, given by the constructor.
params.text	Number	optional default: "text"	the text string
params.fontSize	Number	optional default: 1	the text font height
params.depth	Number	optional default: 1	the glyph extrusion height. 0 to have flat letters.
params.bevelSegments	Number	optional default: 5	the text bevel details and tesselation
params.bevelEnabled	Boolean	optional default: false	the text geometry uses curves
params.bevelSize	Number	optional default: 1	the text geometry bevel
params.font	Number		the text font to use.

Public Members

public bevelEnabled: * source

public bevelSegments: * source

public bevelSize: * source

public bevelThickness: * source

public depth: * source

public fontFile: * source

public fontSize: * source

public geometry: * source

Override:

Mesh#geometry

public geometryNormalAttributes: * source

Override:

Mesh#geometryNormalAttributes

public geometryUVAttributes: * source

Override:

Mesh#geometryUVAttributes

public geometryVerticesAttributes: * source

Override:

Mesh#geometryVerticesAttributes

public index: number source

public indices: *[] source

Override:

Mesh#indices

public lineMode: * source

public lineModeDivision: * source

public material: * source

Override:

Mesh#material

public steps: * source

public text: * source

public transform: * source

Override:

Mesh#transform

Private Members

private _extrudeSettings: {"steps": , "depth": , "bevelEnabled": , "bevelThickness": , "bevelSize": , "bevelSegments": } source

private _font: * source

private _mesh: * source

Override:

Mesh#_mesh

Public Methods

public createTextGeometry(shapes: *) source

Params:

Name	Type	Attribute	Description
shapes	*

public createTextLines(shapes: *) source

Params:

Name	Type	Attribute	Description
shapes	*

public makeShapes(text: ): source

Params:

Name	Type	Attribute	Description
text	*

Return:

public setText(text: *) source

Params:

Name	Type	Attribute	Description
text	*

TextOpentype

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(params: Object) source

Override:

Params:

Public Members

public bevelEnabled: * source

public bevelSegments: * source

public bevelSize: * source

public bevelThickness: * source

public depth: * source

public fontFile: * source

public fontSize: * source

public geometry: * source

Override:

public geometryNormalAttributes: * source

Override:

public geometryUVAttributes: * source

Override:

public geometryVerticesAttributes: * source

Override:

public index: number source

public indices: *[] source

Override:

public lineMode: * source

public lineModeDivision: * source

public material: * source

Override:

public steps: * source

public text: * source

public transform: * source

Override:

Private Members

private _extrudeSettings: {"steps": *, "depth": *, "bevelEnabled": *, "bevelThickness": *, "bevelSize": *, "bevelSegments": *} source

private _font: * source

private _mesh: * source

Override:

Public Methods

public createTextGeometry(shapes: *) source

Params:

public createTextLines(shapes: *) source

Params:

public makeShapes(text: *): * source

Params:

Return:

public setText(text: *) source

Params:

private _extrudeSettings: {"steps": , "depth": , "bevelEnabled": , "bevelThickness": , "bevelSize": , "bevelSegments": } source

public makeShapes(text: ): source