PerspectiveCamera.html 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:Object3D] &rarr; [page:Camera] &rarr;
  12. <h1>[name]</h1>
  13. <div class="desc">
  14. Camera that uses [link:https://en.wikipedia.org/wiki/Perspective_(graphical) perspective projection].<br /><br />
  15. This projection mode is designed to mimic the way the human eye sees. It is the most
  16. common projection mode used for rendering a 3D scene.
  17. </div>
  18. <h2>Example</h2>
  19. <div>[example:canvas_geometry_birds geometry / birds ]</div>
  20. <div>[example:canvas_geometry_cube geometry / cube ]</div>
  21. <div>[example:webgl_animation_skinning_blending animation / skinning / blending ]</div>
  22. <div>[example:webgl_animation_skinning_morph animation / skinning / blending ]</div>
  23. <div>[example:webgl_effects_stereo effects / stereo ]</div>
  24. <div>[example:webgl_interactive_cubes interactive / cubes ]</div>
  25. <div>[example:webgl_loader_collada_skinning loader / collada / skinning ]</div>
  26. <code>var camera = new THREE.PerspectiveCamera( 45, width / height, 1, 1000 );
  27. scene.add( camera );</code>
  28. <h2>Constructor</h2>
  29. <h3>[name]( [page:Number fov], [page:Number aspect], [page:Number near], [page:Number far] )</h3>
  30. <div>
  31. fov — Camera frustum vertical field of view.<br />
  32. aspect — Camera frustum aspect ratio.<br />
  33. near — Camera frustum near plane.<br />
  34. far — Camera frustum far plane.<br /><br />
  35. Together these define the camera's [link:https://en.wikipedia.org/wiki/Viewing_frustum viewing frustum].
  36. </div>
  37. <h2>Properties</h2>
  38. <div>See the base [page:Camera] class for common properties.</div>
  39. <h3>[property:Float aspect]</h3>
  40. <div>Camera frustum aspect ratio, usually the canvas width / canvas height. Default is *1* (square canvas).</div>
  41. <h3>[property:Float far]</h3>
  42. <div>Camera frustum far plane. Default is *2000*.</div>
  43. <h3>[property:Float filmGauge]</h3>
  44. <div>Film size used for the larger axis. Default is 35 (millimeters). This parameter does not influence the projection matrix unless .filmOffset is set to a nonzero value.</div>
  45. <h3>[property:Float filmOffset]</h3>
  46. <div>Horizontal off-center offset in the same unit as .filmGauge. Default is *0*.</div>
  47. <h3>[property:Float focus]</h3>
  48. <div>Object distance used for stereoscopy and depth-of-field effects.
  49. This parameter does not influence the projection matrix unless a [page:StereoCamera] is being used.
  50. Default is *10*.
  51. </div>
  52. <h3>[property:Float fov]</h3>
  53. <div>Camera frustum vertical field of view, from bottom to top of view, in degrees. Default is *50*.</div>
  54. <h3>[property:Boolean isPerspectiveCamera]</h3>
  55. <div>
  56. Used to test whether this or derived classes are PerspectiveCameras. Default is *true*.<br /><br />
  57. This should not be changed as it is used internally by the renderer for optimisation.
  58. </div>
  59. <h3>[property:Float near]</h3>
  60. <div>Camera frustum near plane. Default is *0.1*.</div>
  61. <h3>[property:Object view]</h3>
  62. <div>
  63. Frustum window specification or null.
  64. This is set using the [page:PerspectiveCamera.setViewOffset .setViewOffset] method
  65. and cleared using [page:PerspectiveCamera.clearViewOffset .clearViewOffset].
  66. </div>
  67. <h3>[property:number zoom]</h3>
  68. <div>Gets or sets the zoom factor of the camera. Default is *1*.</div>
  69. <h2>Methods</h2>
  70. <div>See the base [page:Camera] class for common methods.</div>
  71. <h3>[method:null clearViewOffset]()</h3>
  72. <div>Removes any offset set by the [page:PerspectiveCamera.setViewOffset .setViewOffset] method.</div>
  73. <h3>[method:Float getEffectiveFOV]()</h3>
  74. <div>Returns the current vertical field of view angle in degrees considering .zoom.</div>
  75. <h3>[method:Float getFilmHeight]()</h3>
  76. <div>
  77. Returns the height of the image on the film. If .aspect is less than or equal to one
  78. (portrait format), the result equals .filmGauge.
  79. </div>
  80. <h3>[method:Float getFilmWidth]()</h3>
  81. <div>
  82. Returns the width of the image on the film. If .aspect is greater than or equal to one
  83. (landscape format), the result equals .filmGauge.
  84. </div>
  85. <h3>[method:Float getFocalLength]()</h3>
  86. <div>Returns the focal length of the current .fov in respect to .filmGauge.</div>
  87. <h3>[method:null setFocalLength]( [page:Float focalLength] )</h3>
  88. <div>
  89. Sets the FOV by focal length in respect to the current [page:PerspectiveCamera.filmGauge .filmGauge].<br /><br />
  90. By default, the focal length is specified for a 35mm (full frame) camera.
  91. </div>
  92. <h3>[method:null setViewOffset]( [page:Float fullWidth], [page:Float fullHeight], [page:Float x], [page:Float y], [page:Float width], [page:Float height] )</h3>
  93. <div>
  94. fullWidth — full width of multiview setup<br />
  95. fullHeight — full height of multiview setup<br />
  96. x — horizontal offset of subcamera<br />
  97. y — vertical offset of subcamera<br />
  98. width — width of subcamera<br />
  99. height — height of subcamera
  100. </div>
  101. <div>
  102. Sets an offset in a larger frustum. This is useful for multi-window or multi-monitor/multi-machine setups.
  103. </div>
  104. <div>
  105. For example, if you have 3x2 monitors and each monitor is 1920x1080 and the monitors are in grid like this:<br />
  106. <pre>
  107. +---+---+---+
  108. | A | B | C |
  109. +---+---+---+
  110. | D | E | F |
  111. +---+---+---+
  112. </pre>
  113. then for each monitor you would call it like this:<br />
  114. <code>var w = 1920;
  115. var h = 1080;
  116. var fullWidth = w * 3;
  117. var fullHeight = h * 2;
  118. // A
  119. camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
  120. // B
  121. camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
  122. // C
  123. camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
  124. // D
  125. camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
  126. // E
  127. camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
  128. // F
  129. camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
  130. </code>
  131. Note there is no reason monitors have to be the same size or in a grid.
  132. </div>
  133. <h3>[method:null updateProjectionMatrix]()</h3>
  134. <div>
  135. Updates the camera projection matrix. Must be called after any change of parameters.
  136. </div>
  137. <h3>[method:JSON toJSON]()</h3>
  138. <div>
  139. Return camera data in JSON format.
  140. </div>
  141. <h2>Source</h2>
  142. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  143. </body>
  144. </html>