Unigine.Player Class
Inherits from: | Node |
This class is used to create cameras that view the world. When you create a new player, it creates a camera and specifies controls, masks, postprocess materials for this camera.
Players' viewing frustum is defined by a near clipping plane, far clipping plane and the field of view. Note that if you set up a custom projection matrix and after that call any of these functions:
your custom matrices will be overwritten.Players cannot have a parent node; they always use the world coordinates for their transformations. The only exception is PlayerDummy.
Player Masks#
Objects, decals and lights can be selectively displayed in the player viewport. To be displayed, their viewport mask should be matching with the player's viewport mask (one matching bit is enough):
- Object surface viewport mask or decal viewport mask
- Light viewport mask to light the object/decal
- Material viewport mask to render the object/decal material
Reflections can also be selectively rendered into the viewport: an object can be rendered without reflection or reflection without an object. For that, the player's reflection viewport mask should match:
- Reflection mask of the reflecting material
- Viewport mask of the reflecting material
- Object surface viewport mask
- Material viewport mask of the reflected material
- Light viewport mask
To render an object without reflection, simply either its material viewport mask or object surface viewport mask should not match the player's reflection viewport mask.
Players also can have sound source and sound reverberation masks. As well as for viewports, corresponding masks of the Player object should match with SoundReverb and SoundSource masks.
Perspective and Orthographic Projection#
Depending on your project's requirements you can set your player to use perspective or orthographic projection. This can be done via the setProjection() method.
For example, you can use the following code to set up orthographic projection or perspective projection for your current game player depending on a flag value:
// AppWorldLogic.cs
namespace UnigineApp
{
class AppWorldLogic : WorldLogic
{
Player player;
/* ... */
// ortho flag - change this value to switch projection type
int ortho = 0;
public override bool Init()
{
/* ... */
// getting the current player
player = Game.Player;
// 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
player.Projection = MathLib.Ortho(-1.0f, 1.0f, -1.0f, 1.0f, znear, zfar);
}
else
{
// setting up perspective projection
player.Projection = MathLib.Perspective(60.0f, aspect, znear, zfar);
}
return true;
}
}
}
Getting Euler Angles for an Active Camera
Sometimes it might be necessary to get current rotation of the active camera as a set of Euler angles. When we talk about axes in UNIGINE we assume that:
|
Object Direction Vectors
|
To get the Euler angles we should use decomposeRotationZXY() also known as Cardan angles (yaw is independent, then we get pitch and in the end, roll). But, there is one thing to be taken into account - cameras have a different system:
|
Camera Direction Vectors
|
#if UNIGINE_DOUBLE
using Mat4 = Unigine.dmat4;
#else
using Mat4 = Unigine.mat4;
#endif
// getting the current view matrix of the current camera
Mat4 currentModelview = Game.Player.Camera.IModelview;
// decomposing rotation matrix of the camera (with compensation)
vec3 euler = MathLib.DecomposeRotationZXY(new mat3(currentModelview * new Mat4(MathLib.RotateX(-90.0f))));
euler.x += 90.0f;
// perform correction for negative angle values
if (euler.x < 0) euler.x += 360.0f;
if (euler.y < 0) euler.y += 360.0f;
if (euler.z < 0) euler.z += 360.0f;
// Euler angles for the camera
float pitch = euler.x;
float roll = euler.y;
float yaw = euler.z;
Usage Example
In this example a PlayerSpectator class instance (which inherited from Player class) created and added to the current scene. Here is a code from the AppWorldLogic.cs file.
namespace UnigineApp
{
class AppWorldLogic : WorldLogic
{
PlayerSpectator playerSpectator;
/* ... */
public override bool Init()
{
/* ... */
playerSpectator = new PlayerSpectator();
// specify the necessary parameters: FOV, ZNear, ZFar, view direction vector and PlayerSpectator position.
playerSpectator.Fov = 90.0f;
playerSpectator.ZNear = 0.1f;
playerSpectator.ZFar = 10000.0f;
playerSpectator.ViewDirection = new vec3(0.0f, 1.0f, 0.0f);
playerSpectator.WorldPosition = new dvec3(-1.6f, -1.7f, 1.7f);
// set the Player to the Game singleton instance
Game.Player = playerSpectator;
return true;
}
}
}
Player Class
Properties
Camera Camera#
int NumScriptableMaterials#
bool MainPlayer#
Controls Controls#
bool Controlled#
vec3 Velocity#
vec3 ViewDirection#
string PostMaterials#
int ReverbMask#
int SourceMask#
int ReflectionViewportMask#
int ViewportMask#
bool ObliqueFrustum#
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 bool Update()
{
float time = Game.Time;
// 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 player
Player player = Game.Player;
if (player != null)
{
// enabling oblique frustum
player.ObliqueFrustum = true;
// setting our plane as an oblique near clipping plane
player.setObliqueFrustumPlane(plane);
}
return true;
}
/* .. */
}
}
vec3 Up#
float ZFar#
float ZNear#
float FocalLength#
float FilmGate#
float Fov#
Current vertical field of view of the player.
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)).
Sets a vertical field of view of the player.
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)).
int FovFixed#
int FovMode#
- For the standard player, the vertical FOV should be set. In this case, FOV is directly set in degrees.
- For the physically-based player, the horizontal FOV should be set. In this case, FOV is calculated depending on the film gate and focal length of the player.
mat4 Projection#
bool Listener#
Members
void GetDirectionFromScreen ( out Vec3 p0, out Vec3 p1, int x = -1, int y = -1, int width = -1, int height = -1 ) #
Casts the ray to a certain position on the screen and returns coordinates of the start (p0) and end (p1) points of the ray.// get the current player (camera)
Player player = Game.Player;
if (player == null)
return 0;
// get width and height of the current application window
int width = App.getWidth();
int height = App.getHeight();
// get the current X and Y coordinates of the mouse pointer
int mouse_x = App.getMouseX();
int mouse_y = App.getMouseY();
// get the mouse direction from the player's position (p0) to the mouse cursor pointer (p1)
player.getDirectionFromScreen(out p0, out p1, mouse_x, mouse_y, width, height);
Arguments
- out Vec3 p0 - Start coordinates of the ray.
- out Vec3 p1 - End coordinates of the ray.
- int x - X-coordinate of the screen position. If the value is less than 0, the getMouseX() value will be used.
- int y - Y-coordinate of the screen position. If the value is less than 0, the getMouseY() value will be used.
- int width - Screen width. If the width is less than 0, the getWidth() value will be used.
- int height - Screen height. If the height is less than 0, the getHeight() value will be used.
vec3 GetDirectionFromScreen ( int x = -1, int y = -1, int width = -1, int height = -1 ) #
Casts the ray to a certain position on the screen and returns a vector in the direction of this position.// initializing points of the ray from player's position in the direction pointed by the mouse cursor
Vec3 p0 = player.getWorldPosition();
Vec3 p1 = p0 + Vec3(player.getDirectionFromScreen(App.getMouseX(), App.getMouseY())) * 100;
Arguments
- int x - X-coordinate of the screen position. If the value is less than 0, the getMouseX() value will be used.
- int y - Y-coordinate of the screen position. If the value is less than 0, the getMouseY() value will be used.
- int width - Screen width. If the width is less than 0, the getWidth() value will be used.
- int height - Screen height. If the height is less than 0, the getHeight() value will be used.
Return value
Vector coordinates.mat4 GetProjectionFromScreen ( int x0, int y0, int x1, int y1, int width = -1, int height = -1 ) #
Creates a projection matrix out of 2 screen positions. This is required for the frame selection.Arguments
- int x0 - X-coordinate of the first screen position.
- int y0 - Y-coordinate of the first screen position.
- int x1 - X-coordinate of the second screen position.
- int y1 - Y-coordinate of the second screen position.
- int width - Screen width. If the width is less than 0, the getWidth() value will be used.
- int height - Screen height. If the height is less than 0, the getHeight() value will be used.
Return value
Projection matrix.int GetScreenPosition ( out int x, out int y, vec3 point, int width = -1, int height = -1 ) #
Projects the point in world coordinates to the screen. Screen coordinates are written into the first 2 variables passed to the method.Arguments
- out int x - X-coordinate of the screen position.
- out int y - Y-coordinate of the screen position.
- vec3 point - Point coordinates.
- int width - Screen width. If the width is less than 0, the getWidth() value will be used.
- int height - Screen height. If the height is less than 0, the getHeight() value will be used.
Return value
1 if the point has been projected successfully; otherwise, 0.void FlushTransform ( ) #
Forces to immediately set transformations to the player. This function should be called manually after user input has been updated via updateControls().void UpdateControls ( float ifps ) #
Gets the current player's parameters (impulse, direction, velocity etc) according to user input. After the input has been updated, flushTransform() should be called manually to apply it to the player.Arguments
- float ifps - Frame duration in seconds.
mat4 GetAspectCorrectedProjection ( int width = -1, int height = -1 ) #
Returns projection matrix after correction for the specified aspect ratio (screen width / screen height). Currently fixed FOV component is taken into account.Arguments
- int width - Screen width.
- int height - Screen height.
Return value
Projection matrix after correction for the specified aspect ratio (screen width / screen height).void AddScriptableMaterial ( Material material ) #
Attaches a new scriptable material to the player. To apply a scriptable material globally, use the addScriptableMaterial() method of the Render class. The order of execution for scripts assigned to scriptable materials is defined by material's number in the list of the player.Arguments
- Material material - Scriptable material to be attached to the player.
void InsertScriptableMaterial ( int num, Material material ) #
Inserts a new scriptable material into the list of the ones assigned to the player. To apply a scriptable material globally, use the insertScriptableMaterial() method of the Render class. The order of execution for scripts assigned to scriptable materials is defined by material's number in the player's list.Arguments
- int num - Position at which a new scriptable material is to be inserted.
- Material material - Scriptable material to be inserted.
void RemoveScriptableMaterial ( int num ) #
Removes the scriptable material with the specified number from the player.Arguments
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
int FindScriptableMaterial ( Material material ) #
Returns the number of the specified scriptable material for the player. This number is player-specific (valid for this player only) and determines the order in which the assigned expressions are executed.Arguments
- Material material - Scriptable material for which a number is to be found.
Return value
Scriptable material number in the range from 0 to the total number of scriptable materials, or -1 if the specified material was not found.void SetScriptableMaterial ( int num, Material material ) #
Replaces the scriptable material with the specified number with the new scriptable material specified. The number of material determines the order in which the expressions assigned to it are executed. This number is player-specific (valid for this player only).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 ) #
Returns a scriptable material attached to the player by its number.Arguments
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
Return value
Scriptable material attached to the player with the specified number.void SetScriptableMaterialEnabled ( int num, bool enabled ) #
Enables or disables the scriptable material with the specified number. When a material is disabled (inactive), the scripts attached to it are not executed.Arguments
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
- bool enabled - true to enable the scriptable material with the specified number, false to disable it.
bool GetScriptableMaterialEnabled ( int num ) #
Returns a value indicating if the scriptable material with the specified number attached to the player is enabled (active). When a material is disabled (inactive), the scripts attached to it are not executed.Arguments
- int num - Scriptable material number in the range from 0 to the total number of scriptable materials.
Return value
true if the scriptable material with the specified number is enabled; otherwise, false.void SwapScriptableMaterials ( int num_0, int num_1 ) #
Swaps two scriptable materials with specified numbers. The number of material determines the order in which the expressions assigned to it are executed.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 ( ) #
Clears all scriptable materials attached to the player.void SetListener ( bool listener ) #
Sets the player as the listener.Arguments
- bool listener - true to set the player as the listener, false to unset it.