From d9cb00151bd662a25016ecab69433b2d4c146f6e Mon Sep 17 00:00:00 2001 From: Will Nations Date: Thu, 7 Dec 2017 00:31:03 -0600 Subject: [DOCS] Camera property changes --- doc/classes/Camera.xml | 182 ++++++++++++------------------------------------- 1 file changed, 44 insertions(+), 138 deletions(-) (limited to 'doc/classes') diff --git a/doc/classes/Camera.xml b/doc/classes/Camera.xml index 5d6c13498c..91c9ecc774 100644 --- a/doc/classes/Camera.xml +++ b/doc/classes/Camera.xml @@ -25,88 +25,6 @@ Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the [Node] transform. - - - - - Returns the culling mask, describing which 3D render layers are rendered by this Camera. - - - - - - - - - - - - - Returns the [Environment] used by this Camera. - - - - - - - Returns the [i]FOV[/i] Y angle in degrees (FOV means Field of View). - - - - - - - Returns the horizontal (X) offset of the Camera viewport. - - - - - - - Returns the current mode for keeping the aspect ratio. See [code]KEEP_*[/code] constants. - - - - - - - Returns the Camera's projection. See PROJECTION_* constants. - - - - - - - - - - - - - Returns the vertical (Y) offset of the Camera viewport. - - - - - - - Returns the far clip plane in world space units. - - - - - - - Returns the near clip plane in world space units. - - - - - - - Returns [code]true[/code] if the Camera is the current one in the [Viewport], or plans to become current (if outside the scene tree). - - @@ -129,6 +47,7 @@ + Returns a normal vector from the screen point location directed along the camera. Orthogonal cameras are normalized. Perspective cameras account for perspective, screen width/height, etc. @@ -158,51 +77,6 @@ Returns a 3D position in worldspace, that is the result of projecting a point on the [Viewport] rectangle by the camera projection. This is useful for casting rays in the form of (origin, normal) for object intersection or picking. - - - - - - - Sets the cull mask, describing which 3D render layers are rendered by this Camera. - - - - - - - - - Changes Doppler effect tracking. See [code]DOPPLER_*[/code] constants. - - - - - - - - - Sets the [Environment] to use for this Camera. - - - - - - - - - Sets the horizontal (X) offset of the Camera viewport. - - - - - - - - - Sets the mode for keeping the aspect ratio. See [code]KEEP_*[/code] constants. - - @@ -229,15 +103,6 @@ Set the camera projection to perspective mode, by specifying a [i]FOV[/i] Y angle in degrees (FOV means Field of View), and the [i]near[/i] and [i]far[/i] clip planes in worldspace units. - - - - - - - Sets the vertical (Y) offset of the Camera viewport. - - @@ -248,6 +113,47 @@ + + + The culling mask that describes which 3D render layers are rendered by this camera. + + + If [code]true[/code] the ancestor [Viewport] is currently using this Camera. Default value: [code]false[/code]. + + + If not [code]DOPPLER_TRACKING_DISABLED[/code] this Camera will simulate the Doppler effect for objects changed in particular [code]_process[/code] methods. Default value: [code]DOPPLER_TRACKING_DISABLED[/code]. + + + Set the [Environment] to use for this Camera. + + + The distance to the far culling boundary for this Camera relative to its local z-axis. + + + The camera's field of view angle (in degrees). Only applicable in perspective mode. Since [member keep_aspect] locks one axis, [code]fov[/code] sets the other axis' field of view angle. + + + The horizontal (X) offset of the Camear viewport. + + + The axis to lock during [member fov]/[member size] adjustments. + + + The distance to the near culling boundary for this Camera relative to its local z-axis. + + + The camera's projection mode. In [code]PROJECTION_PERSPECTIVE[/code] mode, objects' z-distance from the camera's local space scales their perceived size. + + + The camera's size measured as 1/2 the width or height. Only applicable in orthogonal mode. Since [member keep_aspect] locks on axis, [code]size[/code] sets the other axis' size length. + + + The horizontal (Y) offset of the Camear viewport. + + + A boolean representation of [member keep_aspect] in which [code]true[/code] is equivalent to [code]KEEP_WIDTH[/code]. + + Perspective Projection (object's size on the screen becomes smaller when far away). @@ -256,10 +162,10 @@ Orthogonal Projection (objects remain the same size on the screen no matter how far away they are). - Try to keep the aspect ratio when scaling the Camera's viewport to the screen. If not possible, preserve the viewport's width by changing the height. Height is [code]sizey[/code] for orthographic projection, [code]fovy[/code] for perspective projection. + Preserves the horizontal aspect ratio. - Try to keep the aspect ratio when scaling the Camera's viewport to the screen. If not possible, preserve the viewport's height by changing the width. Width is [code]sizex[/code] for orthographic projection, [code]fovx[/code] for perspective projection. + Preserves the vertical aspect ratio. Disable Doppler effect simulation (default). -- cgit v1.2.3