Skip to content

API Reference

Jump to bottom Edit New page
sole edited this page Apr 4, 2012 · 37 revisions

API documentation focus has moved from this page to the HTML documentation, as of December 2011. Although this page is still a useful reference, if you would like to contribute to API documentation, please add to the Sphinx documentation.

# THREE.Camera

(extends THREE.Object3D)

  • Constructor

    • ()

  • Properties

    • matrixWorldInverse <THREE.Matrix4>
    • projectionMatrix <THREE.Matrix4>
    • projectionMatrixInverse <THREE.Matrix4>

  • Methods

    • lookAt ( target <THREE.Vector3> )

# THREE.PerspectiveCamera

(extends THREE.Object3D, THREE.Camera)

  • Constructor

    • ( fov <Number>, aspect <Number>, near <Number>, far <Number> )

  • Properties

    • fov <Number>
    • aspect <Number>
    • near <Number>
    • far <Number>

  • Methods

    • updateProjectionMatrix ()

# THREE.OrthographicCamera

(extends THREE.Object3D, THREE.Camera)

  • Constructor

    • ( left <Number>, right <Number>, top <Number>, bottom <Number>, near <Number>, far <Number> )

  • Properties

    • left <Number>
    • right <Number>
    • top <Number>
    • bottom <Number>
    • near <Number>
    • far <Number>

  • Methods

    • updateProjectionMatrix ()

# THREE.TrackballCamera (extends THREE.Camera)

  • Constructor

    • (params) (documented in extras/cameras/TrackballCamera.js)

  • Methods

    • update ( parentMatrixWorld <THREE.Matrix4>, forceUpdate <Boolean>, camera <THREE.Camera> )
    • ...

# THREE.Color

  • Constructor

    • ( hex <Number> )

  • Properties

    • r <Number>
    • g <Number>
    • b <Number>

  • Methods

    • copy ( color <THREE.Color> )
    • setRGB ( r <Number>, g <Number>, b <Number> )
    • setHSV ( h <Number>, s <Number>, v <Number> )
    • setHex ( hex <Number> )
    • getHex ()
    • getContextStyle ()
    • clone ()

# THREE.Edge

  • Constructor

    • ( v1 <THREE.Vertex>, v2 <THREE.Vertex>, vi1 <Number>, vi2 <Number> )

  • Properties

    • vertices <Array>
    • vertexIndices <Array>
    • faces <Array>
    • faceIndices <Array>

# THREE.Face3

  • Constructor

    • ( a <Number>, b <Number>, c <Number>, normal <THREE.Vector3>, color <THREE.Color>, materials <Array> )

  • Properties

    • a <Number>
    • b <Number>
    • c <Number>
    • normal <THREE.Vector3>
    • vertexNormals [ <THREE.Vector3>, <THREE.Vector3>, <THREE.Vector3> ]
    • color <THREE.Color>
    • vertexColors [ <THREE.Color>, <THREE.Color>, <THREE.Color> ]
    • vertexTangents <Array>
    • materials <Array>
    • centroid <THREE.Vector3>

# THREE.Face4

  • Constructor

    • ( a <Number>, b <Number>, c <Number>, d <Number>, normal <THREE.Vector3>, color <THREE.Color>, materials <Array> )

  • Properties

    • a <Number>
    • b <Number>
    • c <Number>
    • d <Number>
    • vertexNormals [ <THREE.Vector3>, <THREE.Vector3>, <THREE.Vector3>, <THREE.Vector3> ]
    • normal <THREE.Vector3>
    • color <THREE.Color>
    • vertexColors [ <THREE.Color>, <THREE.Color>, <THREE.Color>, <THREE.Color> ]
    • vertexTangents <Array>
    • materials <Array>
    • centroid <THREE.Vector3>

# THREE.Geometry

  • Constructor

    • ()

  • Properties

    • id <String>
    • vertices <Array>
    • colors <Array>
    • faces <Array>
    • faceUvs <Array><Array>
    • faceVertexUvs <Array><Array>
    • morphTargets <Array><Array>
    • skinWeights <Array>
    • skinIndices <Array>
    • boundingBox <Array>
    • boundingSphere <Number>
    • hasTangents <Boolean>

  • Methods

    • computeCentroids ()
    • computeFaceNormals ( userVertexNormals <Boolean> )
    • computeVertexNormals ()
    • computeTangents ()
    • computeBoundingBox ()
    • computeBoundingSphere ()

# THREE.Matrix3

  • Constructor

    • ()

  • Properties

    • m <Array>

  • Methods

    • transpose ()
    • transposeIntoArray ( r <Array> )

# THREE.Matrix4

  • Constructor

    • ( n11 <Number>, n12 <Number>, n13 <Number>, n14 <Number>, n21 <Number>, n22 <Number>, n23 <Number>, n24 <Number>, n31 <Number>, n32 <Number>, n33 <Number>, n34 <Number>, n41 <Number>, n42 <Number>, n43 <Number>, n44 <Number> )

  • Properties

    • n11 <Number>
    • n12 <Number>
    • n13 <Number>
    • n14 <Number>
    • n21 <Number>
    • n22 <Number>
    • n23 <Number>
    • n24 <Number>
    • n31 <Number>
    • n32 <Number>
    • n33 <Number>
    • n34 <Number>
    • n41 <Number>
    • n42 <Number>
    • n43 <Number>
    • n44 <Number>
    • flat <Array>
    • m33 <THREE.Matrix3>

  • Methods

    • set ( n11 <Number>, n12 <Number>, n13 <Number>, n14 <Number>, n21 <Number>, n22 <Number>, n23 <Number>, n24 <Number>, n31 <Number>, n32 <Number>, n33 <Number>, n34 <Number>, n41 <Number>, n42 <Number>, n43 <Number>, n44 <Number> )
    • identity ()
    • copy ( m <THREE.Matrix4> )
    • lookAt ( eye <THREE.Vector3>, center <THREE.Vector3>, up <THREE.Vector3> )
    • multiplyVector3 ( v <THREE.Vector3> )
    • multiplyVector4 ( v <THREE.Vector3> )
    • rotateAxis ( v <THREE.Vector3> )
    • crossVector ( a <THREE.Vector3> )
    • multiply ( a <THREE.Matrix4>, b <THREE.Matrix4> )
    • multiplyToArray ( a <THREE.Matrix4>, b <THREE.Matrix4>, r <Array> )
    • multiplySelf ( m <THREE.Matrix4> )
    • multiplyScalar ( s <Number> )
    • determinant ()
    • transpose ()
    • clone ()
    • flatten ()
    • flattenToArray ( flat <Array> )
    • flattenToArrayOffset ( flat <Array>, offset <Number> )
    • setTranslation ( x <Number>, y <Number>, z <Number> )
    • setScale ( x <Number>, y <Number>, z <Number> )
    • setRotationX ( theta <Number> )
    • setRotationY ( theta <Number> )
    • setRotationZ ( theta <Number> )
    • setRotationAxis ( axis <THREE.Vector3>, angle <Number> )
    • setPosition ( v <THREE.Vector3> )
    • setRotationFromEuler ( v <THREE.Vector3> )
    • setRotationFromQuaternion ( v <THREE.Quaternion> )
    • scale ( v <THREE.Vector3> )
    • extractPosition ( m <THREE.Matrix4> )
    • extractRotation ( m <THREE.Matrix4>, s <Number> )

  • Static

    • makeInvert ( m1 <THREE.Matrix4>, m2 <THREE.Matrix4> )
    • makeInvert3x3 ( m1 <THREE.Matrix4> )
    • makeFrustum ( left <Number>, right <Number>, bottom <Number>, top <Number>, near <Number>, far <Number> )
    • makePerspective ( fov <Number>, aspect <Number>, near <Number>, far <Number> )
    • makeOrtho ( left <Number>, right <Number>, bottom <Number>, top <Number>, near <Number>, far <Number> )

# THREE.Object3D

  • Properties

    • name <String>
    • id <Number>
    • parent <THREE.Object3D>
    • children <Array>
    • up <THREE.Vector3>
    • position <THREE.Vector3>
    • rotation <THREE.Vector3>
    • eulerOrder <String>
    • scale <THREE.Vector3>
    • dynamic <Boolean>
    • doubleSided <Boolean>
    • flipSided <Boolean>
    • renderDepth <Number>
    • rotationAutoUpdate <Boolean>
    • matrix <Matrix4>
    • matrixWorld <Matrix4>
    • matrixRotationWorld <Matrix4>
    • matrixAutoUpdate <Boolean>
    • matrixWorldNeedsUpdate <Boolean>
    • quaternion <Quaternion>
    • useQuaternion <Boolean>
    • boundRadius <Number>
    • boundRadiusScale <Number>
    • visible <Boolean>
    • castShadow <Boolean>
    • receiveShadow <Boolean>
    • frustumCulled <Boolean>

  • Methods

    • translate ( distance <Number>, axis <THREE.Vector3> )
    • translateX ( distance <Number> )
    • translateY ( distance <Number> )
    • translateZ ( distance <Number> )
    • lookAt ( vector <THREE.Vector3> )
    • add ( object <THREE.Object3D> )
    • remove ( object <THREE.Object3D> )
    • getChildByName ( name <String>, doRecurse <Boolean> )
    • updateMatrix ()
    • updateMatrixWorld ( force <Boolean> )

# THREE.Quaternion

  • Properties

    • x
    • y
    • z
    • w

  • Methods

    • set
    • setFromEuler
    • calculateW
    • inverse
    • length
    • normalize
    • multiplySelf
    • multiplyVector3

  • Static

    • slerp

# THREE.Ray

  • Properties

    • origin <THREE.Vector3>
    • direction <THREE.Vector3>

  • Methods

    • intersectScene ( scene <THREE.Scene> )
    • intersectObjects ( objects <Array> )
    • intersectObject ( object <THREE.Object3D> )

# THREE.Rectangle

  • Methods

    • resize
    • getX
    • getY
    • getWidth
    • getHeight
    • getLeft
    • getTop
    • getRight
    • getBottom
    • set
    • addPoint
    • add3Points
    • addRectangle
    • inflate
    • minSelf
    • intersects
    • empty
    • isEmpty

# THREE.UV

  • Properties

    • u
    • v

  • Methods

    • set
    • copy

# THREE.Vector2

  • Properties

    • x
    • y

  • Methods

    • set
    • copy
    • addSelf
    • add
    • subSelf
    • sub
    • multiplyScalar
    • negate
    • unit
    • length
    • lengthSq
    • clone

# THREE.Vector3

  • Properties

    • x
    • y
    • z

  • Methods

    • set ( x <Number>, y <Number>, z <Number> )
    • copy ( source <THREE.Vector3> )
    • add ( vector1 <THREE.Vector3>, vector2 <THREE.Vector3> )
    • addSelf ( vector2 <THREE.Vector3> )
    • addScalar ( factor <Number> )
    • sub ( vector1 <THREE.Vector3>, vector2 <THREE.Vector3> )
    • subSelf ( vector2 <THREE.Vector3> )
    • cross
    • crossSelf
    • multiply ( vector1 <THREE.Vector3>, vector2 <THREE.Vector3> )
    • multiplySelf ( vector2 <THREE.Vector3> )
    • multiplyScalar ( factor <Number> ) (only *Self)
    • divideSelf ( vector2 <THREE.Vector3> )
    • divideScalar ( factor <Number> ) (only *Self)
    • negate
    • distanceTo ( target <THREE.Vector3> )
    • distanceToSquared
    • length
    • lengthSq
    • lengthManhattan
    • normalize
    • setLength
    • isZero
    • clone ()

# THREE.Vector4

  • Properties

    • x
    • y
    • z
    • w

  • Methods

    • set
    • copy
    • add
    • addSelf
    • sub
    • subSelf
    • multiplyScalar
    • divideScalar
    • lerpSelf
    • clone

# THREE.Vertex

  • Properties

    • position

# THREE.Light

(extends THREE.Object3D)

  • Properties

    • color

# THREE.AmbientLight

(extends THREE.Object3D, THREE.Light)

# THREE.DirectionalLight

(extends THREE.Object3D, THREE.Light)

  • Properties

    • position
    • intensity

# THREE.PointLight

(extends THREE.Object3D, THREE.Light)

  • Properties

    • position
    • intensity

# THREE.Material

# THREE.FlatShading

# THREE.SmoothShading

# THREE.NormalBlending

# THREE.AdditiveBlending

# THREE.SubtractiveBlending

# THREE.LineBasicMaterial

(extends THREE.Material)

  • Properties

    • id
    • color
    • opacity
    • blending
    • depthTest
    • linewidth
    • linecap
    • linejoin
    • vertexColors

# THREE.MeshBasicMaterial

(extends THREE.Material)

  • Properties

    • id
    • color
    • opacity
    • map
    • lightMap
    • envMap
    • combine
    • reflectivity
    • refractionRatio
    • fog
    • shading
    • blending
    • depthTest
    • wireframe
    • wireframeLinewidth
    • wireframeLinecap
    • wireframeLinejoin
    • vertexColors
    • skinning

# THREE.MeshDepthMaterial

(extends THREE.Material)

  • Properties

    • id
    • opacity
    • shading
    • blending
    • depthTest
    • wireframe
    • wireframeLinewidth

# THREE.MeshFaceMaterial

# THREE.MeshLambertMaterial

(extends THREE.Material)

  • Properties

    • id
    • color
    • opacity
    • map
    • lightMap
    • envMap
    • combine
    • reflectivity
    • refractionRatio
    • fog
    • shading
    • blending
    • depthTest
    • wireframe
    • wireframeLinewidth
    • wireframeLinecap
    • wireframeLinejoin
    • vertexColors
    • skinning

# THREE.MeshNormalMaterial

(extends THREE.Material)

  • Properties

    • id
    • opacity
    • shading
    • blending
    • depthTest
    • wireframe
    • wireframeLinewidth

# THREE.MeshPhongMaterial

(extends THREE.Material)

  • Properties

    • id
    • color
    • ambient
    • specular
    • shininess
    • opacity
    • map
    • lightMap
    • envMap
    • combine
    • reflectivity
    • refractionRatio
    • fog
    • shading
    • blending
    • depthTest
    • skinning

# THREE.MeshShaderMaterial

(extends THREE.Material)

  • Properties

    • id
    • fragmentShader
    • vertexShader
    • uniforms
    • opacity
    • shading
    • blending
    • depthTest
    • wireframe
    • wireframeLinewidth
    • wireframeLinecap
    • wireframeLinejoin
    • vertexColors
    • skinning

# THREE.ParticleBasicMaterial

(extends THREE.Material)

  • Properties

    • id
    • color
    • opacity
    • map
    • size
    • blending
    • depthTest
    • offset
    • vertexColors

# THREE.ParticleCanvasMaterial

(extends THREE.Material)

  • Properties

    • id
    • program
    • opacity
    • blending

# THREE.ParticleDOMMaterial

(extends THREE.Material)

  • Properties

    • id
    • domElement

# THREE.CubeReflectionMapping

# THREE.CubeRefractionMapping

# THREE.LatitudeReflectionMapping

# THREE.LatitudeRefractionMapping

# THREE.SphericalReflectionMapping

# THREE.SphericalRefractionMapping

# THREE.UVMapping

# THREE.UniformsUtils

  • Properties

    • merge
    • clone

# THREE.Texture

  • Properties

    • image
    • mapping
    • wrapS
    • wrapT
    • magFilter
    • minFilter
    • needsUpdate

  • Methods

    • clone

# THREE.MultiplyOperation

# THREE.MixOperation

# THREE.RepeatWrapping

# THREE.ClampToEdgeWrapping

# THREE.MirroredRepeatWrapping

# THREE.NearestFilter

# THREE.NearestMipMapNearestFilter

# THREE.NearestMipMapLineaFilter

# THREE.LinearFilter

# THREE.LinearMipMapNearestFilter

# THREE.LinearMipMapLinearFilter

# THREE.ByteType

# THREE.UnsignedByteType

# THREE.ShortType

# THREE.UnsignedShortType

# THREE.FloatType

# THREE.AlphaFormat

# THREE.RGBFormat

# THREE.RGBAFormat

# THREE.LuminanceFormat

# THREE.LuminanceAlphaFormat

# THREE.Bone

(extends THREE.Object3D)

  • Properties

    • skin
    • skinMatrix
    • hasNoneBoneChildren

  • Methods

    • update
    • addChild

# THREE.Line

(extends THREE.Object3D)

  • Properties

    • geometry
    • materials
    • type

# THREE.LineStrip

# THREE.Pieces

# THREE.LOD

(extends THREE.Object3D)

  • Properties

    • LODs

  • Methods

    • add
    • update

# THREE.Mesh

(extends THREE.Object3D)

  • Properties

    • geometry
    • materials
    • filpSided
    • doubleSided
    • overdraw

# THREE.Particle

(extends THREE.Object3D)

  • Properties

    • materials
    • matrixAutoUpdate

# THREE.ParticleSystem

(extends THREE.Object3D)

  • Properties

    • geometry
    • materials
    • sortParticles

# THREE.Ribbon

(extends THREE.Object3D)

  • Properties

    • geometry
    • materials

# THREE.SkinnedMesh

(extends THREE.Object3D, THREE.Mesh)

  • Properties

    • identityMatrix
    • bones
    • bonesMatrices

  • Methods

    • update
    • addBone
    • pose

# THREE.Scene

(extends THREE.Object3D)

  • Properties

    • objects
    • lights
    • fog
    • matrixAutoUpdate

  • Methods

    • add (We've also seen addObject() and addChild(). What is the difference? From looking at Scene.js, addObject() is an alias for addChild() ... and add() no longer exists? "addLight()" is also an alias for "addChild()".)
    • remove

# THREE.Fog

  • Properties

    • color
    • near
    • far

# THREE.FogExp2

  • Properties

    • color
    • density

# THREE.Projector

  • Methods

    • projectObjects ( vector, camera )
    • projectScene ( scene, camera, sort )
    • unprojectVector ( vector, camera )

# THREE.CanvasRenderer

  • Properties

    • domElement
    • autoClear
    • sortObjects
    • sortElements

  • Methods

    • setSize ( width, height )
    • setClearColor ( color, opacity )
    • setClearColorHex ( hex, opacity )
    • clear ()
    • render ( scene, camera )

# THREE.DOMRenderer

  • Properties

    • domElement

  • Methods

    • setSize
    • render

# THREE.SVGRenderer

  • Properties

    • domElement
    • autoClear
    • sortObjects
    • sortElements

  • Methods

    • setQuality
    • setSize
    • clear
    • render

# THREE.WebGLRenderer

  • Constructor

    • ( parameters <Object> )

  • Properties

    • domElement <HTMLElement>
    • autoClear <Boolean>
    • autoClearColor <Boolean>
    • autoClearDepth <Boolean>
    • autoClearStencil <Boolean>
    • sortObjects <Boolean>
    • context <WebGLContext>

  • Methods

    • clear ( color <Boolean>, depth <Boolean>, stencil <Boolean> )
    • render ( scene <THREE.Scene>, camera <THREE.Camera>, renderTarget <THREE.RenderTarget>, forceClear <Boolean> )
    • setSize ( width <Number>, height <Number> )
    • setScissor ( x <Number>, y <Number>, width <Number>, height <Number> )
    • setViewport ( x <Number>, y <Number>, width <Number>, height <Number> )
    • setClearColorHex ( hexColor <Number>, opacity <Number> )
    • setClearColor ( color <THREE.Color>, opacity <Number> )
    • setFaceCulling ( cullFace [ "front" / "back" ], frontFace [ "cw" / "ccw" ] )
    • initMaterial ( material <THREE.Material>, lights <Array>, fog <THREE.Fog> )
    • initWebGLObjects ( scene <THREE.Scene> )
    • enableScissorTest ( enable <Boolean> )
    • enableDepthBufferWrite ( enable <Boolean> )
    • supportsVertexTextures
    • deallocateObject ( object <Object3D> )
    • deallocateTexture ( texture <Texture> )

# THREE.WebGLRenderTarget

  • Properties

    • depthBuffer <Boolean>
    • format <Number>
    • height <Number>
    • magFilter <Number>
    • minFilter <Number>
    • offset: <THREE.Vector2>
    • repeat: <THREE.Vector2>
    • stencilBuffer <Boolean>
    • type <Number>
    • width <Number>
    • wrapS <Number>
    • wrapT <Number>

Extras

# THREE.Animation

  • Constructor

    • ( root, data, interpolationType, JITCompile )

  • Methods

    • play ( loop <Boolean>, startTimeMS <Number> )
    • pause ()
    • stop ()
    • update ( deltaTimeMS <Number> )

# THREE.AnimationHandler

  • Methods

    • update ( deltaTimeMS <Number> )
    • addToUpdate ( animation )
    • removeFromUpdate ( animation )
    • add ( data )
    • get ( name )
    • parse ( root )

# THREE.CubeGeometry

(extends THREE.Geometry)

  • Constructor

    • ( width <Number>, height <Number>, depth <Number>, segmentsWidth <Number>, segmentsHeight <Number>, segmentsDepth <Number>, materials <Array>, sides <Object> )

# THREE.CylinderGeometry

(extends THREE.Geometry)

  • Constructor

    • ( radiusTop <Number>, radiusBottom <Number>, height <Number>, segmentsRadius <Number>, segmentsHeight <Number>, openEnded <Boolean> )

# THREE.ExtrudeGeometry

(extends THREE.Geometry)

  • Constructor

    • ( shapes <Array>, options <Object> )

# THREE.IcosahedronGeometry

(extends THREE.Geometry)

  • Constructor

    • ( subdivisions <Number> )

# THREE.LatheGeometry

(extends THREE.Geometry)

  • Constructor

    • ( points <Array>, steps <Number>, angle <Number> )

# THREE.OctahedronGeometry

(extends THREE.Geometry)

  • Constructor

    • ( radius <Number>, detail <Number> )

# THREE.PlaneGeometry

(extends THREE.Geometry)

  • Constructor

    • ( width <Number>, height <Number>, segmentsWidth <Number>, segmentsHeight <Number> )

# THREE.SphereGeometry

(extends THREE.Geometry)

  • Constructor

    • ( radius <Number>, segmentsWidth <Number>, segmentsHeight <Number> )

# THREE.TextGeometry

(extends THREE.Geometry)

  • Constructor

    • ( text <String>, parameters <Object> )

# THREE.TorusGeometry

(extends THREE.Geometry)

  • Constructor

    • ( radius <Number>, tube <Number>, segmentsR <Number>, segmentsT <Number, arc <Number> )

# THREE.TorusKnotGeometry

(extends THREE.Geometry)

  • Constructor

    • ( radius <Number>, tube <Number>, segmentsR <Number>, segmentsT <Number, p <Number>, q <Number>, heightScale <Number> )
Add a custom footer
Add a custom sidebar

Clone this wiki locally