Highroad Engine v1.3
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
MoreMountains.HighroadEngine.IsometricCameraController Class Reference

Camera controller following a target or a group of targets with an orthographic view. More...

Inheritance diagram for MoreMountains.HighroadEngine.IsometricCameraController:
MoreMountains.HighroadEngine.CameraController

Public Member Functions

override void RefreshTargets ()
 Never called More...
 

Public Attributes

bool FollowBotPlayers
 If set to true, camera will follow humans and bot players on the track. More...
 
float DampTime = 0.2f
 the time (in seconds) before the camera starts to focus on the targets. Allows a smooth follow effect More...
 
float SingleDampTime = 1f
 the time (in seconds) it takes the camera to focus when the target is a single vehicle More...
 
float ScreenEdgeSize = 4f
 the space added around the rectangle made by two most distant cars More...
 
float CameraMinimalSize = 6.5f
 the maximal zoom value More...
 
float CameraMaximalSingleSize = 6.5f
 Minimal zoom size. More...
 
float OffsetSingleCar = 1f
 Acceleration offset.The bigger the value, the more ahead the camera will be when car is racing. More...
 
float ZoomSingleCar = 2f
 Multiplied by vehicle speed to change zoom of the camera. More...
 
- Public Attributes inherited from MoreMountains.HighroadEngine.CameraController
UpdateType UpdateMode
 
Transform[] HumanPlayers
 List of human players. More...
 
Transform[] BotPlayers
 List of bot players. More...
 

Protected Member Functions

virtual float CorrectDampTime ()
 Return Damp Time depending on a single target or more More...
 
override void CameraUpdate ()
 Camera position update More...
 
virtual void EvaluatePosition ()
 Moves the camera More...
 
virtual void EvaluateAveragePosition ()
 Finds the average position. More...
 
virtual void EvaluateSize ()
 Zoom the camera More...
 
virtual float EvaluateNewSize ()
 Finds the required size of the zoom. More...
 
- Protected Member Functions inherited from MoreMountains.HighroadEngine.CameraController
virtual void Awake ()
 Initializes the camera gameobject More...
 
virtual void Update ()
 Unity Update More...
 
virtual void LateUpdate ()
 Unity LateUpdate More...
 
virtual void FixedUpdate ()
 Unity FixedUpdate More...
 

Protected Attributes

float _zoomDampSpeed
 
Vector3 _moveVelocityReference
 
Vector3 _cameraTargetPosition
 
GameObject _singleTarget
 
- Protected Attributes inherited from MoreMountains.HighroadEngine.CameraController
Camera _camera
 

Properties

override bool IsSinglePlayerCamera [get]
 Determines if this camera can be used with multiple targets or a single one More...
 
- Properties inherited from MoreMountains.HighroadEngine.CameraController
abstract bool IsSinglePlayerCamera [get]
 
bool GameHasStarted [getset]
 Gets or sets a value indicating whether this game has started. More...
 

Additional Inherited Members

- Public Types inherited from MoreMountains.HighroadEngine.CameraController
enum  UpdateType { FixedUpdate , LateUpdate , Update }
 Define when camera movement is done. More...
 

Detailed Description

Camera controller following a target or a group of targets with an orthographic view.

Member Function Documentation

◆ CameraUpdate()

override void MoreMountains.HighroadEngine.IsometricCameraController.CameraUpdate ( )
protectedvirtual

Camera position update

Implements MoreMountains.HighroadEngine.CameraController.

◆ CorrectDampTime()

virtual float MoreMountains.HighroadEngine.IsometricCameraController.CorrectDampTime ( )
protectedvirtual

Return Damp Time depending on a single target or more

Returns
The damp time value.

◆ EvaluateAveragePosition()

virtual void MoreMountains.HighroadEngine.IsometricCameraController.EvaluateAveragePosition ( )
protectedvirtual

Finds the average position.

◆ EvaluateNewSize()

virtual float MoreMountains.HighroadEngine.IsometricCameraController.EvaluateNewSize ( )
protectedvirtual

Finds the required size of the zoom.

Returns
The required size.

◆ EvaluatePosition()

virtual void MoreMountains.HighroadEngine.IsometricCameraController.EvaluatePosition ( )
protectedvirtual

Moves the camera

◆ EvaluateSize()

virtual void MoreMountains.HighroadEngine.IsometricCameraController.EvaluateSize ( )
protectedvirtual

Zoom the camera

◆ RefreshTargets()

override void MoreMountains.HighroadEngine.IsometricCameraController.RefreshTargets ( )
virtual

Member Data Documentation

◆ _cameraTargetPosition

Vector3 MoreMountains.HighroadEngine.IsometricCameraController._cameraTargetPosition
protected

◆ _moveVelocityReference

Vector3 MoreMountains.HighroadEngine.IsometricCameraController._moveVelocityReference
protected

◆ _singleTarget

GameObject MoreMountains.HighroadEngine.IsometricCameraController._singleTarget
protected

◆ _zoomDampSpeed

float MoreMountains.HighroadEngine.IsometricCameraController._zoomDampSpeed
protected

◆ CameraMaximalSingleSize

float MoreMountains.HighroadEngine.IsometricCameraController.CameraMaximalSingleSize = 6.5f

Minimal zoom size.

◆ CameraMinimalSize

float MoreMountains.HighroadEngine.IsometricCameraController.CameraMinimalSize = 6.5f

the maximal zoom value

◆ DampTime

float MoreMountains.HighroadEngine.IsometricCameraController.DampTime = 0.2f

the time (in seconds) before the camera starts to focus on the targets. Allows a smooth follow effect

◆ FollowBotPlayers

bool MoreMountains.HighroadEngine.IsometricCameraController.FollowBotPlayers

If set to true, camera will follow humans and bot players on the track.

◆ OffsetSingleCar

float MoreMountains.HighroadEngine.IsometricCameraController.OffsetSingleCar = 1f

Acceleration offset.The bigger the value, the more ahead the camera will be when car is racing.

◆ ScreenEdgeSize

float MoreMountains.HighroadEngine.IsometricCameraController.ScreenEdgeSize = 4f

the space added around the rectangle made by two most distant cars

◆ SingleDampTime

float MoreMountains.HighroadEngine.IsometricCameraController.SingleDampTime = 1f

the time (in seconds) it takes the camera to focus when the target is a single vehicle

◆ ZoomSingleCar

float MoreMountains.HighroadEngine.IsometricCameraController.ZoomSingleCar = 2f

Multiplied by vehicle speed to change zoom of the camera.

Property Documentation

◆ IsSinglePlayerCamera

override bool MoreMountains.HighroadEngine.IsometricCameraController.IsSinglePlayerCamera
get

Determines if this camera can be used with multiple targets or a single one

true if this instance is a single player camera; otherwise, false.


The documentation for this class was generated from the following file: