PerspectiveCamera.html 6.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  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. <p 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. </p>
  18. <h2>Example</h2>
  19. <p>[example:webgl_animation_skinning_blending animation / skinning / blending ]</p>
  20. <p>[example:webgl_animation_skinning_morph animation / skinning / blending ]</p>
  21. <p>[example:webgl_effects_stereo effects / stereo ]</p>
  22. <p>[example:webgl_interactive_cubes interactive / cubes ]</p>
  23. <p>[example:webgl_loader_collada_skinning loader / collada / skinning ]</p>
  24. <code>var camera = new THREE.PerspectiveCamera( 45, width / height, 1, 1000 );
  25. scene.add( camera );</code>
  26. <h2>Constructor</h2>
  27. <h3>[name]( [param:Number fov], [param:Number aspect], [param:Number near], [param:Number far] )</h3>
  28. <p>
  29. fov — Camera frustum vertical field of view.<br />
  30. aspect — Camera frustum aspect ratio.<br />
  31. near — Camera frustum near plane.<br />
  32. far — Camera frustum far plane.<br /><br />
  33. Together these define the camera's [link:https://en.wikipedia.org/wiki/Viewing_frustum viewing frustum].
  34. </p>
  35. <h2>Properties</h2>
  36. <p>
  37. See the base [page:Camera] class for common properties.<br>
  38. Note that after making changes to most of these properties you will have to call
  39. [page:PerspectiveCamera.updateProjectionMatrix .updateProjectionMatrix] for the changes to take effect.
  40. </p>
  41. <h3>[property:Float aspect]</h3>
  42. <p>Camera frustum aspect ratio, usually the canvas width / canvas height. Default is *1* (square canvas).</p>
  43. <h3>[property:Float far]</h3>
  44. <p>
  45. Camera frustum far plane. Default is *2000*.<br /><br />
  46. The valid range is between the current value of the [page:.near near] plane and infinity.
  47. </p>
  48. <h3>[property:Float filmGauge]</h3>
  49. <p>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.</p>
  50. <h3>[property:Float filmOffset]</h3>
  51. <p>Horizontal off-center offset in the same unit as .filmGauge. Default is *0*.</p>
  52. <h3>[property:Float focus]</h3>
  53. <p>Object distance used for stereoscopy and depth-of-field effects.
  54. This parameter does not influence the projection matrix unless a [page:StereoCamera] is being used.
  55. Default is *10*.
  56. </p>
  57. <h3>[property:Float fov]</h3>
  58. <p>Camera frustum vertical field of view, from bottom to top of view, in degrees. Default is *50*.</p>
  59. <h3>[property:Float near]</h3>
  60. <p>
  61. Camera frustum near plane. Default is *0.1*.<br /><br />
  62. The valid range is greater than 0 and less than the current value of the [page:.far far] plane.
  63. Note that, unlike for the [page:OrthographicCamera], *0* is <em>not</em> a valid value
  64. for a PerspectiveCamera's near plane.
  65. </p>
  66. <h3>[property:Object view]</h3>
  67. <p>
  68. Frustum window specification or null.
  69. This is set using the [page:PerspectiveCamera.setViewOffset .setViewOffset] method
  70. and cleared using [page:PerspectiveCamera.clearViewOffset .clearViewOffset].
  71. </p>
  72. <h3>[property:number zoom]</h3>
  73. <p>Gets or sets the zoom factor of the camera. Default is *1*.</p>
  74. <h2>Methods</h2>
  75. <p>See the base [page:Camera] class for common methods.</p>
  76. <h3>[method:null clearViewOffset]()</h3>
  77. <p>Removes any offset set by the [page:PerspectiveCamera.setViewOffset .setViewOffset] method.</p>
  78. <h3>[method:Float getEffectiveFOV]()</h3>
  79. <p>Returns the current vertical field of view angle in degrees considering .zoom.</p>
  80. <h3>[method:Float getFilmHeight]()</h3>
  81. <p>
  82. Returns the height of the image on the film. If .aspect is less than or equal to one
  83. (portrait format), the result equals .filmGauge.
  84. </p>
  85. <h3>[method:Float getFilmWidth]()</h3>
  86. <p>
  87. Returns the width of the image on the film. If .aspect is greater than or equal to one
  88. (landscape format), the result equals .filmGauge.
  89. </p>
  90. <h3>[method:Float getFocalLength]()</h3>
  91. <p>Returns the focal length of the current .fov in respect to .filmGauge.</p>
  92. <h3>[method:null setFocalLength]( [param:Float focalLength] )</h3>
  93. <p>
  94. Sets the FOV by focal length in respect to the current [page:PerspectiveCamera.filmGauge .filmGauge].<br /><br />
  95. By default, the focal length is specified for a 35mm (full frame) camera.
  96. </p>
  97. <h3>[method:null setViewOffset]( [param:Float fullWidth], [param:Float fullHeight], [param:Float x], [param:Float y], [param:Float width], [param:Float height] )</h3>
  98. <p>
  99. fullWidth — full width of multiview setup<br />
  100. fullHeight — full height of multiview setup<br />
  101. x — horizontal offset of subcamera<br />
  102. y — vertical offset of subcamera<br />
  103. width — width of subcamera<br />
  104. height — height of subcamera
  105. </p>
  106. <p>
  107. Sets an offset in a larger frustum. This is useful for multi-window or multi-monitor/multi-machine setups.
  108. </p>
  109. <p>
  110. For example, if you have 3x2 monitors and each monitor is 1920x1080 and the monitors are in grid like this:<br />
  111. <pre>
  112. +---+---+---+
  113. | A | B | C |
  114. +---+---+---+
  115. | D | E | F |
  116. +---+---+---+
  117. </pre>
  118. then for each monitor you would call it like this:<br />
  119. <code>var w = 1920;
  120. var h = 1080;
  121. var fullWidth = w * 3;
  122. var fullHeight = h * 2;
  123. // A
  124. camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 0, w, h );
  125. // B
  126. camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 0, w, h );
  127. // C
  128. camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 0, w, h );
  129. // D
  130. camera.setViewOffset( fullWidth, fullHeight, w * 0, h * 1, w, h );
  131. // E
  132. camera.setViewOffset( fullWidth, fullHeight, w * 1, h * 1, w, h );
  133. // F
  134. camera.setViewOffset( fullWidth, fullHeight, w * 2, h * 1, w, h );
  135. </code>
  136. Note there is no reason monitors have to be the same size or in a grid.
  137. </p>
  138. <h3>[method:null updateProjectionMatrix]()</h3>
  139. <p>
  140. Updates the camera projection matrix. Must be called after any change of parameters.
  141. </p>
  142. <h3>[method:Object toJSON]([param:object meta])</h3>
  143. <p>
  144. meta -- object containing metadata such as textures or images in objects' descendants.<br />
  145. Convert the camera to three.js [link:https://github.com/mrdoob/three.js/wiki/JSON-Object-Scene-format-4 JSON Object/Scene format].
  146. </p>
  147. <h2>Source</h2>
  148. <p>
  149. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  150. </p>
  151. </body>
  152. </html>