Skip to content
Lukas Sägesser edited this page Jun 22, 2015 · 12 revisions

Camera

####Inherits: Spatial ####Category: Core

Brief Description

Camera node, displays from a point of view.

Member Functions

Numeric Constants

  • PROJECTION_PERSPECTIVE = 0 - Perspective Projection (object's size on the screen becomes smaller when far away).
  • PROJECTION_ORTHOGONAL = 1 - Orthogonal Projection (objects remain the same size on the screen no matter how far away they are).
  • KEEP_WIDTH = 0
  • KEEP_HEIGHT = 1

Description

Camera is a special node that displays what is visible from its current location. Cameras register themselves in the nearest Viewport node (when ascending the tree). Only one camera can be active per viewport. If no viewport is available ascending the tree, the Camera will register in the global viewport. In other words, a Camera just provides 3D display capabilities to a Viewport, and, without one, a [Scene] registered in that Viewport (or higher viewports) can't be displayed.

Member Function Description

Return a normal vector 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.

Return 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.

Return how a 3D point in worldpsace maps to a 2D coordinate in the Viewport rectangle.

Set the camera projection to perspective mode, by specifying a FOV Y angle in degrees (FOV means Field of View), and the near and far clip planes in worldspace units.

Set the camera projection to orthogonal mode, by specifying a"#10;"#9;"#9;"#9;width and the near and far clip planes in worldspace units. (As a hint, 2D games often use this projection, with values specified in pixels)

  • void make_current ( )

Make this camera the current Camera for the Viewport (see class description). If the Camera Node is outside the scene tree, it will attempt to become current once it"apos;s added.

  • bool is_current ( ) const

Return wether the Camera is the current one in the Viewport, or plans to become current (if outside the scene tree).

Get the camera transform. Subclassed cameras (such as CharacterCamera) may provide different transforms than the Node transform.

Clone this wiki locally