Class: Glyph

Glyph(geometry, materialIn, idIn) → {Glyph}

new Glyph(geometry, materialIn, idIn) → {Glyph}

Zinc representation of glyph graphic, it contains the colours, geometry and transformation of the glyph.
Parameters:
Name Type Description
geometry THREE.Geometry Geometry of the glyph .
materialIn THREE.Material Material of the glyph.
idIn Number Id of the glyph.
Author:
  • Alan Wu
Source:
Returns:
Type
Glyph

Methods

dispose()

Clear and free its memory.
Source:

fromMesh(meshIn) → {Boolean}

Create a glyph using mesh
Parameters:
Name Type Description
meshIn THREE.Mesh Mesh to create the glyph from
Source:
Returns:
true if successful
Type
Boolean

getGlyphset() → {Boolean}

Get the {Glyphset} containing this glyph.
Source:
Returns:
true if successful
Type
Boolean

getGroup() → {THREE.Group}

Get the group containing the label and mesh.
Source:
Returns:
Type
THREE.Group

getLabel() → {Label}

Get the label of this glyph
Source:
Returns:
Type
Label

getMesh() → {THREE.Mesh}

Get the mesh of this glyph.
Source:
Returns:
Type
THREE.Mesh

setColour(color)

Set the color of the glyph and its label.
Parameters:
Name Type Description
color THREE.Color Colour to be set.
Source:

setLabel(text)

Set and update the text containing this glyph.
Parameters:
Name Type Description
text String Label to be set for this instance
Source:

setTransformation(position, axis1, axis2, position)

Set the transformation of this glyph.
Parameters:
Name Type Description
position Array Three components vectors containing position of the transformation.
axis1 Array Three components vectors containing axis1 rotation of the transformation.
axis2 Array Three components vectors containing axis2 rotation of the transformation.
position Array Three components vectors containing axis3 rotation of the transformation.
Source:

showLabel(colour)

Display label with the choosen colour. It will replace the current label.
Parameters:
Name Type Description
colour THREE.Color Colour for the label.
Source: