SandBox.View.Map.MapCameraView Class Reference

Inherits SandBox.View.Map.MapView.

Classes
struct	InputInformation

Public Types
enum	CameraFollowMode {   Free ,   FollowParty ,   MoveToPosition }

Public Member Functions
	MapCameraView ()
virtual void	OnActivate (bool leftButtonDraggingMode, Vec3 clickedPosition)
virtual void	Initialize ()
virtual void	SetCameraMode (CameraFollowMode cameraMode)
virtual void	ResetCamera (bool resetDistance, bool teleportToMainParty)
virtual void	TeleportCameraToMainParty ()
virtual void	FastMoveCameraToMainParty ()
virtual void	FastMoveCameraToPosition (Vec2 target, bool isInMenu)
virtual bool	IsCameraLockedToPlayerParty ()
virtual void	StartCameraAnimation (Vec2 targetPosition, float animationStopDuration)
virtual void	SiegeEngineClick (MatrixFrame siegeEngineFrame)
virtual void	OnExit ()
virtual void	OnEscapeMenuToggled (bool isOpened)
virtual void	HandleMouse (bool rightMouseButtonPressed, float verticalCameraInput, float mouseMoveY, float dt)
virtual void	HandleLeftMouseButtonClick (bool isMouseActive)
virtual void	OnSetMapSiegeOverlayState (bool isActive, bool isMapSiegeOverlayViewNull)
virtual void	OnRefreshMapSiegeOverlayRequired (bool isMapSiegeOverlayViewNull)
virtual void	OnBeforeTick (in InputInformation inputInformation)

Protected Member Functions
virtual void	UpdateMapCamera (bool _leftButtonDraggingMode, Vec3 _clickedPosition)
virtual Vec3	GetCameraTargetForPosition (Vec2 targetPosition)
virtual Vec3	GetCameraTargetForParty (PartyBase party)
virtual bool	GetMapCameraInput (InputInformation inputInformation)
virtual MatrixFrame	ComputeMapCamera (ref Vec3 cameraTarget, float cameraBearing, float cameraElevation, float cameraDistance, ref Vec2 lastUsedIdealCameraTarget)
virtual float	CalculateCameraElevation (float cameraDistance)

Static Protected Member Functions
static string	SetCustomMaximumHeight (List< String > strings)

Protected Attributes
float	_customMaximumCameraHeight = 0f

Properties
virtual CameraFollowMode	CurrentCameraFollowMode [get, set]
virtual float	CameraFastMoveMultiplier [get, protected set]
virtual float	CameraBearing [get, set]
virtual float	MaximumCameraHeight [get]
virtual float	CameraBearingVelocity [get, set]
virtual float	CameraDistance [get, protected set]
virtual float	TargetCameraDistance [get, set]
virtual float	AdditionalElevation [get, set]
virtual bool	CameraAnimationInProgress [get, protected set]
virtual bool	ProcessCameraInput [get, protected set]
virtual Camera	Camera [get, protected set]
virtual MatrixFrame	CameraFrame [get, protected set]
virtual Vec3	IdealCameraTarget [get, set]
Properties inherited from SandBox.View.Map.MapView
MapScreen	MapScreen [get]
MapState	MapState [get]
Properties inherited from SandBox.View.SandboxView
bool	IsFinalized [get, protected set]
ScreenLayer	Layer [get, protected set]

Additional Inherited Members
Static Protected Attributes inherited from SandBox.View.Map.MapView
const float	ContextAlphaModifier = 8.5f

Member Enumeration Documentation

CameraFollowMode

enum SandBox.View.Map.MapCameraView.CameraFollowMode

Enumerator
Free
FollowParty
MoveToPosition

Constructor & Destructor Documentation

MapCameraView()

SandBox.View.Map.MapCameraView.MapCameraView

(

)

Member Function Documentation

OnActivate()

virtual void SandBox.View.Map.MapCameraView.OnActivate ( bool  leftButtonDraggingMode, Vec3  clickedPosition  )

virtual

Initialize()

virtual void SandBox.View.Map.MapCameraView.Initialize ( )

virtual

SetCameraMode()

virtual void SandBox.View.Map.MapCameraView.SetCameraMode ( CameraFollowMode  cameraMode )

virtual

ResetCamera()

virtual void SandBox.View.Map.MapCameraView.ResetCamera ( bool  resetDistance, bool  teleportToMainParty  )

virtual

TeleportCameraToMainParty()

virtual void SandBox.View.Map.MapCameraView.TeleportCameraToMainParty ( )

virtual

FastMoveCameraToMainParty()

virtual void SandBox.View.Map.MapCameraView.FastMoveCameraToMainParty ( )

virtual

FastMoveCameraToPosition()

virtual void SandBox.View.Map.MapCameraView.FastMoveCameraToPosition ( Vec2  target, bool  isInMenu  )

virtual

IsCameraLockedToPlayerParty()

virtual bool SandBox.View.Map.MapCameraView.IsCameraLockedToPlayerParty ( )

virtual

StartCameraAnimation()

virtual void SandBox.View.Map.MapCameraView.StartCameraAnimation ( Vec2  targetPosition, float  animationStopDuration  )

virtual

SiegeEngineClick()

virtual void SandBox.View.Map.MapCameraView.SiegeEngineClick ( MatrixFrame  siegeEngineFrame )

virtual

OnExit()

virtual void SandBox.View.Map.MapCameraView.OnExit ( )

virtual

OnEscapeMenuToggled()

virtual void SandBox.View.Map.MapCameraView.OnEscapeMenuToggled ( bool  isOpened )

virtual

HandleMouse()

virtual void SandBox.View.Map.MapCameraView.HandleMouse ( bool  rightMouseButtonPressed, float  verticalCameraInput, float  mouseMoveY, float  dt  )

virtual

HandleLeftMouseButtonClick()

virtual void SandBox.View.Map.MapCameraView.HandleLeftMouseButtonClick ( bool  isMouseActive )

virtual

OnSetMapSiegeOverlayState()

virtual void SandBox.View.Map.MapCameraView.OnSetMapSiegeOverlayState ( bool  isActive, bool  isMapSiegeOverlayViewNull  )

virtual

OnRefreshMapSiegeOverlayRequired()

virtual void SandBox.View.Map.MapCameraView.OnRefreshMapSiegeOverlayRequired ( bool  isMapSiegeOverlayViewNull )

virtual

OnBeforeTick()

virtual void SandBox.View.Map.MapCameraView.OnBeforeTick ( in InputInformation  inputInformation )

virtual

UpdateMapCamera()

virtual void SandBox.View.Map.MapCameraView.UpdateMapCamera ( bool  _leftButtonDraggingMode, Vec3  _clickedPosition  )

protectedvirtual

GetCameraTargetForPosition()

virtual Vec3 SandBox.View.Map.MapCameraView.GetCameraTargetForPosition ( Vec2  targetPosition )

protectedvirtual

GetCameraTargetForParty()

virtual Vec3 SandBox.View.Map.MapCameraView.GetCameraTargetForParty ( PartyBase  party )

protectedvirtual

GetMapCameraInput()

virtual bool SandBox.View.Map.MapCameraView.GetMapCameraInput ( InputInformation  inputInformation )

protectedvirtual

ComputeMapCamera()

virtual MatrixFrame SandBox.View.Map.MapCameraView.ComputeMapCamera ( ref Vec3  cameraTarget, float  cameraBearing, float  cameraElevation, float  cameraDistance, ref Vec2  lastUsedIdealCameraTarget  )

protectedvirtual

CalculateCameraElevation()

virtual float SandBox.View.Map.MapCameraView.CalculateCameraElevation ( float  cameraDistance )

protectedvirtual

SetCustomMaximumHeight()

static string SandBox.View.Map.MapCameraView.SetCustomMaximumHeight ( List< String >  strings )

staticprotected

Member Data Documentation

_customMaximumCameraHeight

float SandBox.View.Map.MapCameraView._customMaximumCameraHeight = 0f

protected

Property Documentation

CurrentCameraFollowMode

virtual CameraFollowMode SandBox.View.Map.MapCameraView.CurrentCameraFollowMode

getsetprotected

CameraFastMoveMultiplier

virtual float SandBox.View.Map.MapCameraView.CameraFastMoveMultiplier

getprotected set

CameraBearing

virtual float SandBox.View.Map.MapCameraView.CameraBearing

getsetprotected

MaximumCameraHeight

virtual float SandBox.View.Map.MapCameraView.MaximumCameraHeight

getprotected

CameraBearingVelocity

virtual float SandBox.View.Map.MapCameraView.CameraBearingVelocity

getsetprotected

CameraDistance

virtual float SandBox.View.Map.MapCameraView.CameraDistance

getprotected set

TargetCameraDistance

virtual float SandBox.View.Map.MapCameraView.TargetCameraDistance

getsetprotected

AdditionalElevation

virtual float SandBox.View.Map.MapCameraView.AdditionalElevation

getsetprotected

CameraAnimationInProgress

virtual bool SandBox.View.Map.MapCameraView.CameraAnimationInProgress

getprotected set

ProcessCameraInput

virtual bool SandBox.View.Map.MapCameraView.ProcessCameraInput

getprotected set

Camera

virtual Camera SandBox.View.Map.MapCameraView.Camera

getprotected set

CameraFrame

virtual MatrixFrame SandBox.View.Map.MapCameraView.CameraFrame

getprotected set

IdealCameraTarget

virtual Vec3 SandBox.View.Map.MapCameraView.IdealCameraTarget

getsetprotected