Global

Methods

ModifiedDeviceOrientationControls()

Author:
  • richt / http://richt.me
  • WestLangley / http://github.com/WestLangley W3C Device Orientation control (http://w3c.github.io/deviceorientation/spec-source-orientation.html)
Source:

StereoCameraZoomFixed()

Author:
  • mrdoob / http://mrdoob.com/
Source:

StereoEffect()

Author:
  • alteredq / http://alteredqualia.com/
Source:

createBufferGeometry()

Create and return a new buffer geometry with the size of length, and initial coords.
Source:

createPointQuadGeometry()

Build the shared quad geometry every point instance is drawn with plus the per instance `instancePosition` attribute used to place it - the actual on screen billboard offset and constant pixel sizing is computed in createInstancedPointsMaterial.
Source:

createTextSprite(text, textHeight, colour, fontFace, fontWeight) → {SpriteText}

Create a text sprite rendered with a node material, the canvas resolution is chosen from the size of the text on screen.
Parameters:
Name Type Description
text String Text to display.
textHeight Number Height of a line of text in view units.
colour String CSS colour of the text.
fontFace String Font family.
fontWeight Number | String Font weight.
Source:
Returns:
Type
SpriteText

extractColorFrames()

Extract the per time step, flat [r0, g0, b0, r1, g1, b1, ...] colour arrays from a time varying BufferGeometry. Returns undefined unless localMorphColour is requested and the geometry actually carries morph colour targets, mirroring the legacy vertexColors/onBeforeCompile gating.
Source:

extractPositionFrames()

Extract the per time step, flat [x0, y0, z0, x1, y1, z1, ...] position arrays from a (possibly time varying) BufferGeometry.
Source:

extractStaticColorFrame()

Extract the plain, non-morph per-vertex 'color' attribute (if any) so a Pointset still shows static vertex colours from the file when there is no colour animation to blend between.
Source:

mergeAttributes(attributes) → (nullable) {BufferAttribute}

Merges a set of attributes into a single instance. All attributes must have compatible properties and types. Instances of InterleavedBufferAttribute are not supported.
Parameters:
Name Type Description
attributes Array.<BufferAttribute> The attributes to merge.
Source:
Returns:
The merged attribute. Returns `null` if the merge does not succeed.
Type
BufferAttribute

mergeGeometries(geometries, useGroupsopt) → (nullable) {BufferGeometry}

Merges a set of geometries into a single instance. All geometries must have compatible attributes.
Parameters:
Name Type Attributes Default Description
geometries Array.<BufferGeometry> The geometries to merge.
useGroups boolean <optional>
 false Whether to use groups or not.
Source:
Returns:
The merged geometry. Returns `null` if the merge does not succeed.
Type
BufferGeometry

releaseTextSprite()

Stop tracking a text sprite, call this when it is disposed.
Source:

setTextPixelsPerUnit(value)

Update the number of screen pixels per unit of text height, e.g. when the viewport is resized. Text sprites are redrawn if it has changed significantly.
Parameters:
Name Type Description
value Number viewportHeight * pixelRatio / (2 * tan(fov / 2))
Source:

setTextSpriteHeight()

Set the height of a text sprite and redraw it once at the matching resolution.
Source:

Type Definitions

IMAGE_UINT8_RETURN

Type:
  • Set
Properties:
Name Type Description
array Uint8Array Array containing the uint8 image value.
width Number Phyiscal image width.
height Number Phyiscal image height.
Source:

SLIDE_SETTINGS

Type:
  • Set
Properties:
Name Type Description
direction String the value must be x, y or z, specify the direction the slide should be facing.
value Number Normalised value of the location on direction.
id String ID of the mesh, it is only available if the settings is returned from TextureSlides.createSlide or TextureSlides.getTextureSettings.
Source:

SLIDE_SETTINGS

Type:
  • Set
Properties:
Name Type Description
direction String the value must be x, y or z, specify the direction the slide should be facing.
value Number Normalised value of the location on direction.
id String ID of the mesh, it is only available if the settings is returned from TextureSlides.createSlide or TextureSlides.getTextureSettings.
Source: