API Reference

Wiki ▸ API Reference

API Reference

Contents

• React3: require('react-three-renderer') - Module Entry Point
• Internal Components:
  • Views:
    • viewport: See THREE.WebGLRenderer.setViewport
  • Objects: Entities that can be added into a scene
    • scene: Creates a THREE.Scene
    • object3D: Creates a THREE.Object3D
    • group: Creates a THREE.Group
    • Cameras:
      • orthographicCamera: Creates a THREE.OrthographicCamera
      • perspectiveCamera: Creates a THREE.PerspectiveCamera
      • cubeCamera: Creates a THREE.CubeCamera
    • Meshes:
      • mesh: Creates a THREE.Mesh
      • line: Creates a THREE.Line
      • points: Creates a THREE.Points
      • TODO:
        • Bone
        • LensFlare
        • LineSegments
        • LOD
        • MorphAnimMesh
        • SkinnedMesh
        • Skeleton
        • Sprite
    • Lights:
      • ambientLight: Creates a THREE.AmbientLight
      • directionalLight: Creates a THREE.DirectionalLight
      • spotLight: Creates a THREE.SpotLight
      • pointLight: Creates a THREE.PointLight
      • TODO:
        • HemisphereLight
        • Light
    • Helpers:
      • cameraHelper: Creates a THREE.CameraHelper
      • axisHelper: Creates a THREE.AxisHelper
      • arrowHelper: Creates a THREE.ArrowHelper
      • TODO:
        • BoundingBoxHelper
        • BoxHelper
        • DirectionalLightHelper
        • EdgesHelper
        • FaceNormalsHelper
        • GridHelper
        • HemisphereLightHelper
        • PointLightHelper
        • SpotLightHelper
        • VertexNormalsHelper
        • WireframeHelper
  • Materials:
    • meshBasicMaterial: Creates a THREE.MeshBasicMaterial
    • meshPhongMaterial: Creates a THREE.MeshPhongMaterial
    • meshLambertMaterial: Creates a THREE.MeshLambertMaterial
    • meshDepthMaterial: Creates a THREE.MeshDepthMaterial
    • meshNormalMaterial: Creates a THREE.MeshNormalMaterial
    • pointsMaterial: Creates a THREE.PointsMaterial
    • lineBasicMaterial: Creates a THREE.LineBasicMaterial
    • lineDashedMaterial: Creates a THREE.LineDashedMaterial
    • spriteMaterial: Creates a THREE.SpriteMaterial
    • shaderMaterial: Creates a THREE.ShaderMaterial
      • uniforms: A container for THREE.ShaderMaterial#uniforms.
        • uniform: A single uniform value for a shader material.
    • TODO:
      • Material
      • MeshFaceMaterial
      • RawShaderMaterial
      • SpriteCanvasMaterial
      • SpriteMaterial
  • Textures:
    • texture: Creates a THREE.Texture
    • TODO:
      • CubeTexture
      • CompressedTexture
      • DataTexture
  • Geometries:
    • geometry: Creates a THREE.Geometry
    • boxGeometry: Creates a THREE.BoxGeometry
    • sphereGeometry: Creates a THREE.SphereGeometry
    • parametricGeometry: Creates a THREE.ParametricGeometry
    • planeBufferGeometry: Creates a THREE.PlaneBufferGeometry
    • polyhedronGeometry: Creates a THREE.PolyhedronGeometry
    • icosahedronGeometry: Creates a THREE.IcosahedronGeometry
    • octahedronGeometry: Creates a THREE.OctahedronGeometry
    • tetrahedronGeometry: Creates a THREE.TetrahedronGeometry
    • circleGeometry: Creates a THREE.CircleGeometry
    • circleBufferGeometry: Creates a THREE.CircleBufferGeometry
    • ringGeometry: Creates a THREE.RingGeometry
    • cylinderGeometry: Creates a THREE.CylinderGeometry
    • latheGeometry: Creates a THREE.LatheGeometry
    • torusGeometry: Creates a THREE.TorusGeometry
    • torusKnotGeometry: Creates a THREE.TorusKnotGeometry
    • extrudeGeometry: Creates a THREE.ExtrudeGeometry
    • TODO:
      • CubeGeometry
      • DodecahedronGeometry
      • PlaneGeometry
      • ShapeGeometry
      • TextGeometry
      • TubeGeometry
  • Shapes:
    • shape: Creates a THREE.Shape
      • moveTo: Calls THREE.Path#moveTo on the parent shape
      • lineTo: Calls THREE.Path#lineTo on the parent shape
      • bezierCurveTo: Calls THREE.Path#bezierCurveTo on the parent shape
      • quadraticCurveTo: Calls THREE.Path#quadraticCurveTo on the parent shape
      • absArc: Calls THREE.Path#absArc on the parent shape
      • absEllipse: Calls THREE.Path#absEllipse on the parent shape
      • splineThru: Calls THREE.Path#splineThru on the parent shape
      • hole: Adds a hole into a parent shape, see THREE.Shape#holes
    • TODO:
      • Curve
      • CurvePath
      • Gyroscope
      • Path
  • Resource Types: Allows you to reuse entities, these help save a lot of memory
    • resources: Resource Container
    • materialResource: Reference to a material resource
    • textureResource: Reference to a texture resource
    • geometryResource: Reference to a geometry resource.
    • shapeResource: Reference to a shape resource
    • shapeGeometryResource: Reference to a material created from a shape resource
  • Advanced: If you feel like having custom experiences, this one is for you
    • react3: See React3. Handles renderer and canvas configuration.
    • module: experimental Can inject a system that needs to perform actions every frame, e.g. input or physics.
• React3Renderer: Equivalent to react-dom.