Unigine::Camera Class

Header:

#include <UnigineCamera.h>

Sort by:

List of functions:

List of Variables:

FOV_MODE_PHYSICALLY_BASED_CAMERA
FOV_MODE_VERTICAL
FOV_FIXED_HORIZONTAL
FOV_FIXED_VERTICAL

The Camera class is used to create a new camera, set it up (set all the required matrices, field of view, masks and so on) and then pass it to an instance of the Viewport class to render an image from this camera.

Notice

An instance of this class is not a node.

A camera instance can have the following masks:

Sound Source mask
Sound Reverberation mask
Viewport mask
Reflection mask

Camera settings can be set up in the Camera Settings in UnigineEditor.

Usage Example

In this example we create a Camera instance and PlayerSpectator player, specify camera parameters, set camera to the PlayerSpectator and set it as current game player.

In the AppWorldLogic.h header file include the UniginePlayers.h header and declare a PlayerSpectator and Camera smart pointers.

Source code (C++)

#include <UnigineLogic.h>
#include <UnigineStreams.h>
#include <UniginePlayers.h>

class AppWorldLogic : public Unigine::WorldLogic {

public:

	/* public methods */

private:
	Unigine::PlayerSpectatorPtr playerSpectator;
	Unigine::CameraPtr camera;
};

In the AppWorldLogic.cpp implementation file do the following:

Include the UnigineGame.h header to set a new player by using setPlayer() method.
Use using namespace Unigine directive: names of the Unigine namespace will be injected into global namespace.
Specify the necessary parameters of the created Camera instance and set it to PlayerSpectator.
Set PlayerSpectator as a current game player.
Clear the pointer to the PlayerSpectator to avoid memory leaks.

Here are the necessary parts of code:

Source code (C++)

#include "AppWorldLogic.h"
#include "UnigineGame.h"

// inject Unigine namespace names to global namespace
using namespace Unigine;

/* ... */

int AppWorldLogic::init() {

	// create a new PlayerSpectator and camera instance
	playerSpectator = PlayerSpectator::create();
	camera = Camera::create();

	// specify the necessary camera parameters: FOV, ZNear, ZFar.
	// add the post_sensor_red post-effect to camera
	camera->setFov(110.0f);
	camera->setZNear(0.1f);
	camera->setZFar(10000.0f);
	camera->setPostMaterials("post_sensor_red");

	// set camera to the player
	playerSpectator->setCamera(camera);

	// specify the position and view direction of playerSpectator
	playerSpectator->setViewDirection(Math::vec3(0.0f, 1.0f, 0.0f));
	playerSpectator->setWorldPosition(Math::dvec3(-1.6f, -1.7f, 1.7f));

	// cast PlayerSpectator to Player
	PlayerPtr player = playerSpectator->getPlayer();
	// set the Player to the Game singleton instance
	Game::get()->setPlayer(player);

	return 1;
}

/* ... */

int AppWorldLogic::shutdown() {

	// clear the pointer to Player
	playerSpectator.clear();

	return 1;
}

Camera Class

Members

static CameraPtr create()

Constructor. Creates a new camera with default settings:

Modelview, inverse modelview and offset matrices are 4×4 identity matrices.
FOV is 60 degrees.
Distance to the near clipping plane is 0.1 unit.
Distance to the far clipping plane is 10000 units.
Up direction vector is (0,0,1).
Viewport, reflection, source and reverb masks are set to 00000001.

void getDirectionFromScreen(Math::Vec3 & p0, Math::Vec3 & p1, float screen_x, float screen_y, float aspect)

Casts the ray from a certain position on the screen.

Arguments

Math::Vec3 & p0 - Start coordinate of the ray.
Math::Vec3 & p1 - End coordinate of the ray.
float screen_x - X-coordinate of screen, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float screen_y - Y-coordinate of screen, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float aspect - Screen's aspect ratio (height to width).

Math::vec3 getDirectionFromScreen(float screen_x, float screen_y, float aspect)

Casts the ray from a certain position on the screen.

Arguments

float screen_x - X-coordinate of screen, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float screen_y - Y-coordinate of screen, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float aspect - Screen's aspect ratio (height to width).

Return value

Point coordinate.

void setFov(float fov)

Sets a vertical field of view of the camera and updates the projection matrix.

NoticeHorizontal FOV cannot be used since it varies depending on the viewport's aspect ratio.

You can use the following formula to calculate horizontal FOV from the vertical one for the given aspect ratio (width/height): FOV_h = 2 × atan ( (width / height) × tan(FOV_v / 2)).

Arguments

float fov - New vertical field of view in degrees. The provided value will be saturated in the range [0;180].

float getFov()

Returns the current vertical field of view of the camera.

NoticeHorizontal FOV cannot be used since it varies depending on the viewport's aspect ratio.

You can use the following formula to calculate horizontal FOV from the vertical one for the given aspect ratio (width/height): FOV_h = 2 × atan ( (width / height) × tan(FOV_v / 2)).

Return value

Vertical field of view in degrees.

Math::Mat4 getIModelview()

Returns the inverted view matrix of the camera.

Return value

Inverse view matrix.

void setModelview(const Math::Mat4 & modelview)

Updates a modelview and inverse modelview matrices for the camera.

Arguments

const Math::Mat4 & modelview - New view matrix.

Math::Mat4 getModelview()

Returns the current view matrix of the camera.

Return value

Current view matrix.

void setObliqueFrustum(int enabled)

Enables or disables obliqueness of the viewing frustum.

Notice

It is recommended to set oblique viewing frustum using this method, as it doesn't affect the projection matrix. To specify the near clipping plane use the setObliqueFrustumPlane() method.

Arguments

int enabled - 1 to enable oblique viewing frustum; 0 to disable it.

int isObliqueFrustum()

Returns a value indicating if the viewing frustum is oblique.

Return value

1 if the viewing frustum is oblique; otherwise, 0.

void setObliqueFrustumPlane(const Math::Vec4 & clipping_plane)

Sets the oblique near clipping plane of the viewing frustum.

Notice

This method does not affect the projection matrix. To enable the oblique frustum use the setObliqueFrustum() method.

Source code (C++)

// AppWorldLogic.cpp
#include <UnigineGame.h>
using namespace Unigine;

/* .. */
		
int AppWorldLogic::update() {
	// Write here code to be called before updating each render frame: specify all graphics-related functions you want to be called every frame while your application executes.
	float time = Game::get()->getTime();

	// initializing a plane to be set as a near clipping plane
	Math::Vec4 plane = Math::Vec4(1.0f, 1.0f, 1.0f, 1.0f + Math::sin(time) * 4.0f);

	// getting a camera
	CameraPtr camera = Game::get()->getPlayer()->getCamera();
	if (camera)
	{
		// enabling oblique frustum
		camera->setObliqueFrustum(1);

		// setting our plane as an oblique near clipping plane
		camera->setObliqueFrustumPlane(plane);
	}
	
	return 1;
}
		
/* .. */

Arguments

const Math::Vec4 & clipping_plane - World coordinates of the oblique near clipping plane to set (Nx, Ny, Nz, D), where Nx, Ny, Nz - coordinates of the plane normal, D - distance from the origin to the plane.

Math::Vec4 getObliqueFrustumPlane()

Returns the oblique near clipping plane of the viewing frustum.

Return value

World coordinates of the oblique near clipping plane to set (Nx, Ny, Nz, D), where Nx, Ny, Nz - coordinates of the plane normal, D - distance from the origin to the plane.

void setOffset(const Math::mat4 & offset)

Sets an additional transformation (an offset matrix) for the camera. This transformation is applied after the modelview transformation. The offset matrix does not affect the view matrix or the position of the camera. For example, the offset matrix can be used to simulate camera shaking from an explosion.

Arguments

const Math::mat4 & offset - Offset matrix.

Math::mat4 getOffset()

Returns an additional transformation (an offset matrix) set for the camera. This transformation is applied after modelview transformation. The offset matrix does not affect the view matrix or the position of the camera. For example, it can be used to simulate camera shake from an explosion.

Return value

Offset matrix.

void setPosition(const Math::Vec3 & position)

Sets a new position of the camera and updates the modelview and inverse modelview (its 3rd column) matrices.

Arguments

const Math::Vec3 & position - Camera position in the world space.

Math::Vec3 getPosition()

Returns the current position of the camera. The position vector is stored in the 3rd column of the inverse view matrix.

Return value

Camera position in the world space.

void setPostMaterials(const char * materials)

Sets post postprocess materials that are applied after all other postprocess are rendered. They are used after engine.render.setPostMaterials(), if any.

Arguments

const char * materials - Comma-separated names of postprocess materials.

const char * getPostMaterials()

Returns names of the current post postprocess materials that are applied after all other postprocess are rendered. They are used after engine.render.getPostMaterials(), if any.

Return value

Name of the current post postprocess materials.

void setProjection(const Math::mat4 & projection)

Updates the current projection matrix.

Notice

It is not recommended to use this method for setting obliqueness of the near clipping plane of the frustum, as in this case a number of features (such as clouds, shadows, TAA, a number of engine optimizations, etc.) will not function properly. Please, use the setObliqueFrustum() method instead.

This method allows you to set your camera to use perspective or orthographic projection, depending on your project's requirements.

For example, you can use the following code to set up orthographic projection or perspective projection for your camera depending on a flag value:

Source code (C++)

// AppWorldLogic.cpp

/* ... */
#include <UnigineCamera.h>
#include <UnigineGame.h>

// inject Unigine namespace names to global namespace
using namespace Unigine;

/* ... */

// ortho flag - change this value to switch projection type
int ortho = 0;

int AppWorldLogic::init() {

	// getting the camera of the current player
	CameraPtr camera = Game::get()->getPlayer()->getCamera();
	
	// setting up near and far clipping planes and aspect ratio
	float znear = 0.001f;
	float zfar = 10000.0f;
	float aspect = 16.0f / 9.0f;

	if (ortho)
	{
		// setting up orthographic projection
		camera->setProjection(Math::ortho(-1.0f, 1.0f, -1.0f, 1.0f, znear, zfar));
	}
	else
	{
		// setting up perspective projection
		camera->setProjection(Math::perspective(60.0f, aspect, znear, zfar));
	}
	
	// setting player's camera
	Game::get()->getPlayer()->setCamera(camera);
			
	return 1;
}

/* ... */

Arguments

const Math::mat4 & projection - Projection matrix.

Math::mat4 getProjection()

Returns the current projection matrix with unit (1.0) aspect ratio.

Return value

Projection matrix.

Math::mat4 getProjectionFromScreen(float screen_x0, float screen_y0, float screen_x1, float screen_y1, float aspect)

Creates a projection matrix out of 2 screen positions. This is required for the frame selection.

Arguments

float screen_x0 - X-coordinate of the first screen position, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float screen_y0 - Y-coordinate of the first screen position, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float screen_x1 - X-coordinate of the second screen position, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float screen_y1 - Y-coordinate of the second screen position, in the [0;1] range, where 0 is the left upper point, 1 is the right lower point.
float aspect - Screen's aspect ratio (height to width).

Return value

Projection matrix.

void setReflectionMask(int mask)

Sets a bit mask for rendering reflections into the viewport. Reflections are rendered in the viewport if masks of reflective materials match this one.

Arguments

int mask - Integer, each bit of which is used to set a mask.

int getReflectionMask()

Returns the current bit mask for rendering reflections into the camera viewport. Reflections are rendered in the camera viewport if masks of reflective materials match this one.

Return value

Integer, each bit of which is used to set a mask.

void setReverbMask(int mask)

Updates a bit mask that determines what reverberation zones can be heard. For sound to reverberate, at least one bit of this mask should match a reverb mask of the sound source and a reverb mask of the reverberation zone. Masks of a sound source and reverberation zone can match the camera's one in several bits, not necessarily one.

Arguments

int mask - Integer, each bit of which is a mask for reverberating sound sources and reverberation zones.

int getReverbMask()

Returns the current bit mask that determines what reverberation zones can be heard. For sound to reverberate, at least one bit of this mask should match a reverb mask of the sound source and a reverb mask of the reverberation zone. Masks of a sound source and reverberation zone can match with the camera's one in several bits, not necessarily one.

Return value

Integer, each bit of which is used to set a mask for reverberating sound sources and reverberation zones.

int getScreenPosition(float & screen_x, float & screen_y, const Math::Vec3 & point, float aspect)

Projects the point in world coordinates to the screen. Screen coordinates are written into the first 2 variables passed to the method.

Arguments

float & screen_x - X-coordinate of the screen position.
float & screen_y - Y-coordinate of the screen position.
const Math::Vec3 & point - Point coordinates.
float aspect - Aspect ratio (screen height to width).

Return value

1 if the point has been projected successfully; otherwise, 0.

void setSourceMask(int mask)

Updates a bit mask that determines what sound sources can be heard. For a sound source to be heard, its mask should match this one in at least one bit. Plus, the volume of sound channel in which the sound plays (its number also depends on this mask) should not be equal to 0.

Arguments

int mask - Integer, each bit of which specifies a sound channel.

int getSourceMask()

Returns a bit mask that determines what sound channels can be heard. For a sound source to be heard, its mask should match this one in at least one bit. Plus, the volume of sound channel in which the sound plays (its number also depends on this mask) should not be equal to 0.

Return value

Integer, each bit of which specifies a sound channel.

void setUp(const Math::vec3 & up)

Sets an up direction of the camera's viewport (i.e. tilt of the camera's viewport).

Arguments

const Math::vec3 & up - New upward direction vector. The vector is normalized to 1.

Math::vec3 getUp()

Returns the current up direction of the camera's viewport (i.e. tilt of the camera's viewport).

Return value

Upward direction vector.

void setViewportMask(int mask)

Sets a bit mask for rendering into the viewport. Object surfaces, materials, decals, lights and GUI objects will be rendered into the viewport only if their viewport masks match the camera's one (one matching bit is enough).

Arguments

int mask - Integer, each bit of which is used to set a mask.

int getViewportMask()

Returns the current bit mask for rendering into the viewport. Object surfaces, materials, decals, lights and GUI objects will be rendered into the viewport only if their viewport mask matches the camera's one (one matching bit is enough).

Return value

Integer, each bit of which is used to set a mask.

void setZFar(float zfar)

Sets a distance to the far clipping plane of the camera's viewing frustum and updates the projection matrix.

Arguments

float zfar - New distance in units. If a negative value is provided, 0 will be used instead.

float getZFar()

Returns the current distance to the far clipping plane of the camera's viewing frustum.

Return value

Distance in units.

void setZNear(float znear)

Sets a distance to the near clipping plane of the camera's viewing frustum and updates the projection matrix.

Arguments

float znear - New distance in units. If a negative value is provided, 0 will be used instead.

float getZNear()

Returns the current distance to the near clipping plane of the camera's viewing frustum.

Return value

Distance in units.

Ptr<Camera> clone()

Clones the current camera and saves it to the given camera instance.

Return value

Copy of the camera.

void setFovMode(int mode)

Sets the value indicating the type of FOV that is used for the camera:

For the classic camera, the vertical FOV should be set. In this case, FOV is directly set in degrees.
For the physically-based camera, the horizontal FOV should be set. In this case, FOV is calculated depending on the film gate and focal length of the camera.

Arguments

int mode - FOV_MODE_VERTICAL for the camera with the vertical FOV; FOV_MODE_PHYSICALLY_BASED_CAMERA for the physically-based camera with the horizontal FOV.

int getFovMode()

Sets the value indicating the type of FOV that is used for the camera.

Return value

0 if the camera with the vertical FOV is used; 1 if the physically-based camera with the horizontal FOV is used.

void setFilmGate(float gate)

Sets a film gate for the physically-based camera with horizontal FOV.

Arguments

float gate - Film gate.

float getFilmGate()

Returns a film gate for the physically-based camera with horizontal FOV.

Return value

Film gate.

void setFocalLength(float length)

Sets a focal length of the physically-based camera lens.

Arguments

float length - Camera lens focal length.

float getFocalLength()

Returns the focal length of the physically-based camera lens.

Return value

Camera lens focal length.

Math::mat4 getAspectCorrectedProjection(float aspect)

Returns projection matrix after correction for the specified aspect ratio. Currently fixed FOV component is taken into account.

Arguments

float aspect - Aspect ratio.

Return value

Projection matrix after correction for the specified aspect ratio.

int getFovFixed()

Returns a value indicating which FOV component (horizontal or vertical) is currently fixed.

Return value

Current fixed FOV component, one of the FOV_FIXED_* values.

int FOV_MODE_PHYSICALLY_BASED_CAMERA

Description

Physically based mode. Horizontal FOV of the physically-based camera is calculated using the focal length and film gate values according to the following formula:

FOV_h = 2 * atan(film_gate / (2 * focal_length)) * UNIGINE_RAD2DEG

int FOV_MODE_VERTICAL

Description

Vertical FOV mode. Vertical FOV of the camera is determined by the FOV value.

int FOV_FIXED_HORIZONTAL

Description

Horizontal FOV component is fixed.

int FOV_FIXED_VERTICAL

Description

Vertical FOV component is fixed.

Last update: 2018-08-10

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)