Unigine.Camera Class

Camera Class

Properties

int NumScriptableMaterials#

string PostMaterials#

int ReverbMask#

int SourceMask#

int ReflectionViewportMask#

int ViewportMask#

bool IsObliqueFrustum#

Vec4 ObliqueFrustumPlane#

// AppWorldLogic.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
		/* .. */
		
		public override int update()
		{

            float time = Game.get().getTime();
			
				// initializing a plane to be set as a near clipping plane
                dvec4 plane = new dvec4(1.0f, 1.0f, 1.0f, 1.0f + MathLib.sin(time) * 4.0f);
				
				// getting a camera
                Camera camera = Game.get().getPlayer().getCamera();
                if (camera != null)
                {
					// enabling oblique frustum
                    camera.setObliqueFrustum(1);

					// setting our plane as an oblique near clipping plane
                    camera.setObliqueFrustumPlane(plane);
                }

            return 1;
		}
		
		/* .. */
	}
}

vec3 Up#

float ZFar#

float ZNear#

float FocalLength#

float FilmGate#

float Fov#

int FovFixed#

int FovMode#

mat4 Projection#

// AppWorldLogic.cs

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
		Camera camera;
		Player player;
		/* ... */
		
		// ortho flag - change this value to switch projection type
		int ortho = 0;
		public override int init()
		{
			/* ... */
			
			// getting the camera of the current player
			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(MathLib.ortho(-1.0f, 1.0f, -1.0f, 1.0f, znear, zfar));
			}
			else
			{
				// setting up perspective projection
				camera.setProjection(MathLib.perspective(60.0f, aspect, znear, zfar));
			}
			// setting player's camera
			Player player = Game.get().getPlayer();
			player.setCamera(camera);
			
			return 1;
		}
	}
}

mat4 Offset#

Vec3 Position#

Mat4 IModelview#

Mat4 Modelview#

Members

static Camera ( ) #

• 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 ( out Vec3 p0, out Vec3 p1, float screen_x, float screen_y, float aspect ) #

Arguments

• out Vec3 p0 - Start coordinate of the ray.
• out 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).

vec3 GetDirectionFromScreen ( float screen_x, float screen_y, float aspect ) #

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

mat4 GetProjectionFromScreen ( float screen_x0, float screen_y0, float screen_x1, float screen_y1, float aspect ) #

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

int GetScreenPosition ( out float screen_x, out float screen_y, Vec3 point, float aspect ) #

Arguments

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

Return value

Camera Clone ( ) #

Return value

mat4 GetAspectCorrectedProjection ( float aspect ) #

Arguments

• float aspect - Aspect ratio.

Return value

void AddScriptableMaterial ( Material material ) #

Arguments

• Material material - Scriptable material to be attached to the camera.

void RemoveScriptableMaterial ( int num ) #

Arguments

• int num - Scriptable material number in the range from 0 to the total number of scriptable materials.

int FindScriptableMaterial ( Material material ) #

Arguments

• Material material - Scriptable material for which a number is to be found.

Return value

void SetScriptableMaterial ( int num, Material material ) #

Arguments

• int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
• Material material - New scriptable material to replace the one with the specified number.

Material GetScriptableMaterial ( int num ) #

Arguments

• int num - Scriptable material number in the range from 0 to the total number of scriptable materials.

Return value

void SetScriptableMaterialEnabled ( int num, bool enabled ) #

Arguments

• int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
• bool enabled - 1 to enable the scriptable material with the specified number, 0 to disable it.

bool GetScriptableMaterialEnabled ( int num ) #

Arguments

• int num - Scriptable material number in the range from 0 to the total number of scriptable materials.

Return value

void SwapScriptableMaterials ( int num_0, int num_1 ) #

Arguments

• int num_0 - Number of the first scriptable material in the range from 0 to the total number of scriptable materials.
• int num_1 - Number of the second scriptable material in the range from 0 to the total number of scriptable materials.

void ClearScriptableMaterials ( ) #