Class SdkBaseCamera

Simple base camera class that moves and rotates. The base class records mouse and keyboard input for use by a derived class, and keeps common state.

Inheritance
object
SdkBaseCamera
SdkFirstPersonCamera
SdkModelViewerCamera
Inherited Members
Namespace: JeremyAnsel.DirectX.SdkCamera
Assembly: JeremyAnsel.DirectX.SdkCamera.dll
Syntax
public abstract class SdkBaseCamera

Constructors

| Edit this page View Source

SdkBaseCamera()

Declaration
public SdkBaseCamera()

Fields

| Edit this page View Source

m_aKeys

Declaration
protected readonly SdkCameraKeyStates[] m_aKeys
Field Value
Type Description
SdkCameraKeyStates[]
| Edit this page View Source

m_bClipToBoundary

Declaration
protected bool m_bClipToBoundary
Field Value
Type Description
bool
| Edit this page View Source

m_bEnablePositionMovement

Declaration
protected bool m_bEnablePositionMovement
Field Value
Type Description
bool
| Edit this page View Source

m_bEnableYAxisMovement

Declaration
protected bool m_bEnableYAxisMovement
Field Value
Type Description
bool
| Edit this page View Source

m_bInvertPitch

Declaration
protected bool m_bInvertPitch
Field Value
Type Description
bool
| Edit this page View Source

m_bMouseLButtonDown

Declaration
protected bool m_bMouseLButtonDown
Field Value
Type Description
bool
| Edit this page View Source

m_bMouseMButtonDown

Declaration
protected bool m_bMouseMButtonDown
Field Value
Type Description
bool
| Edit this page View Source

m_bMouseRButtonDown

Declaration
protected bool m_bMouseRButtonDown
Field Value
Type Description
bool
| Edit this page View Source

m_bMovementDrag

Declaration
protected bool m_bMovementDrag
Field Value
Type Description
bool
| Edit this page View Source

m_bResetCursorAfterMove

Declaration
protected bool m_bResetCursorAfterMove
Field Value
Type Description
bool
| Edit this page View Source

m_cKeysDown

Declaration
protected int m_cKeysDown
Field Value
Type Description
int
| Edit this page View Source

m_fAspect

Declaration
protected float m_fAspect
Field Value
Type Description
float
| Edit this page View Source

m_fCameraPitchAngle

Declaration
protected float m_fCameraPitchAngle
Field Value
Type Description
float
| Edit this page View Source

m_fCameraYawAngle

Declaration
protected float m_fCameraYawAngle
Field Value
Type Description
float
| Edit this page View Source

m_fDragTimer

Declaration
protected double m_fDragTimer
Field Value
Type Description
double
| Edit this page View Source

m_fFOV

Declaration
protected float m_fFOV
Field Value
Type Description
float
| Edit this page View Source

m_fFarPlane

Declaration
protected float m_fFarPlane
Field Value
Type Description
float
| Edit this page View Source

m_fFramesToSmoothMouseData

Declaration
protected float m_fFramesToSmoothMouseData
Field Value
Type Description
float
| Edit this page View Source

m_fMoveScaler

Declaration
protected float m_fMoveScaler
Field Value
Type Description
float
| Edit this page View Source

m_fNearPlane

Declaration
protected float m_fNearPlane
Field Value
Type Description
float
| Edit this page View Source

m_fRotationScaler

Declaration
protected float m_fRotationScaler
Field Value
Type Description
float
| Edit this page View Source

m_fTotalDragTimeToZero

Declaration
protected double m_fTotalDragTimeToZero
Field Value
Type Description
double
| Edit this page View Source

m_isActive

Declaration
protected bool m_isActive
Field Value
Type Description
bool
| Edit this page View Source

m_mProj

Declaration
protected XMMatrix m_mProj
Field Value
Type Description
XMMatrix
| Edit this page View Source

m_mView

Declaration
protected XMMatrix m_mView
Field Value
Type Description
XMMatrix
| Edit this page View Source

m_nCurrentButtonMask

Declaration
protected MouseKeys m_nCurrentButtonMask
Field Value
Type Description
MouseKeys
| Edit this page View Source

m_nMouseWheelDelta

Declaration
protected int m_nMouseWheelDelta
Field Value
Type Description
int
| Edit this page View Source

m_ptLastMousePosition

Declaration
protected XMInt2 m_ptLastMousePosition
Field Value
Type Description
XMInt2
| Edit this page View Source

m_rcDrag

Declaration
protected XMInt4 m_rcDrag
Field Value
Type Description
XMInt4
| Edit this page View Source

m_vDefaultEye

Declaration
protected XMFloat3 m_vDefaultEye
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vDefaultLookAt

Declaration
protected XMFloat3 m_vDefaultLookAt
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vEye

Declaration
protected XMFloat3 m_vEye
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vKeyboardDirection

Declaration
protected XMFloat3 m_vKeyboardDirection
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vLookAt

Declaration
protected XMFloat3 m_vLookAt
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vMaxBoundary

Declaration
protected XMFloat3 m_vMaxBoundary
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vMinBoundary

Declaration
protected XMFloat3 m_vMinBoundary
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vMouseDelta

Declaration
protected XMFloat2 m_vMouseDelta
Field Value
Type Description
XMFloat2
| Edit this page View Source

m_vRotVelocity

Declaration
protected XMFloat2 m_vRotVelocity
Field Value
Type Description
XMFloat2
| Edit this page View Source

m_vVelocity

Declaration
protected XMFloat3 m_vVelocity
Field Value
Type Description
XMFloat3
| Edit this page View Source

m_vVelocityDrag

Declaration
protected XMFloat3 m_vVelocityDrag
Field Value
Type Description
XMFloat3

Methods

| Edit this page View Source

ConstrainToBoundary(XMVector)

Declaration
protected XMVector ConstrainToBoundary(XMVector v)
Parameters
Type Name Description
XMVector v
Returns
Type Description
XMVector
| Edit this page View Source

FrameMove(double)

Declaration
public abstract void FrameMove(double fElapsedTime)
Parameters
Type Name Description
double fElapsedTime
| Edit this page View Source

GetEyePt()

Declaration
public XMVector GetEyePt()
Returns
Type Description
XMVector
| Edit this page View Source

GetFarClip()

Declaration
public float GetFarClip()
Returns
Type Description
float
| Edit this page View Source

GetInput(bool, bool)

Declaration
protected void GetInput(bool bGetKeyboardInput, bool bGetMouseInput)
Parameters
Type Name Description
bool bGetKeyboardInput
bool bGetMouseInput
| Edit this page View Source

GetLookAtPt()

Declaration
public XMVector GetLookAtPt()
Returns
Type Description
XMVector
| Edit this page View Source

GetNearClip()

Declaration
public float GetNearClip()
Returns
Type Description
float
| Edit this page View Source

GetProjMatrix()

Declaration
public XMMatrix GetProjMatrix()
Returns
Type Description
XMMatrix
| Edit this page View Source

GetViewMatrix()

Declaration
public XMMatrix GetViewMatrix()
Returns
Type Description
XMMatrix
| Edit this page View Source

HandleMessages(nint, WindowMessageType, nint, nint)

Declaration
public virtual void HandleMessages(nint hWnd, WindowMessageType msg, nint wParam, nint lParam)
Parameters
Type Name Description
nint hWnd
WindowMessageType msg
nint wParam
nint lParam
| Edit this page View Source

IsBeingDragged()

Declaration
public bool IsBeingDragged()
Returns
Type Description
bool
| Edit this page View Source

IsKeyDown(SdkCameraKeyStates)

Declaration
protected static bool IsKeyDown(SdkCameraKeyStates key)
Parameters
Type Name Description
SdkCameraKeyStates key
Returns
Type Description
bool
| Edit this page View Source

IsMouseLButtonDown()

Declaration
public bool IsMouseLButtonDown()
Returns
Type Description
bool
| Edit this page View Source

IsMouseMButtonDown()

Declaration
public bool IsMouseMButtonDown()
Returns
Type Description
bool
| Edit this page View Source

IsMouseRButtonDown()

Declaration
public bool IsMouseRButtonDown()
Returns
Type Description
bool
| Edit this page View Source

MapKey(VirtualKey)

Declaration
protected virtual SdkCameraKey MapKey(VirtualKey nKey)
Parameters
Type Name Description
VirtualKey nKey
Returns
Type Description
SdkCameraKey
| Edit this page View Source

Reset()

Declaration
public virtual void Reset()
| Edit this page View Source

SetClipToBoundary(bool)

Declaration
public void SetClipToBoundary(bool bClipToBoundary)
Parameters
Type Name Description
bool bClipToBoundary
| Edit this page View Source

SetClipToBoundary(bool, XMFloat3?, XMFloat3?)

Declaration
public void SetClipToBoundary(bool bClipToBoundary, XMFloat3? pvMinBoundary, XMFloat3? pvMaxBoundary)
Parameters
Type Name Description
bool bClipToBoundary
XMFloat3? pvMinBoundary
XMFloat3? pvMaxBoundary
| Edit this page View Source

SetDrag(bool)

Declaration
public void SetDrag(bool bMovementDrag)
Parameters
Type Name Description
bool bMovementDrag
| Edit this page View Source

SetDrag(bool, float)

Declaration
public void SetDrag(bool bMovementDrag, float fTotalDragTimeToZero)
Parameters
Type Name Description
bool bMovementDrag
float fTotalDragTimeToZero
| Edit this page View Source

SetDragRect(XMInt4)

Declaration
public virtual void SetDragRect(XMInt4 rc)
Parameters
Type Name Description
XMInt4 rc
| Edit this page View Source

SetEnablePositionMovement(bool)

Declaration
public void SetEnablePositionMovement(bool bEnablePositionMovement)
Parameters
Type Name Description
bool bEnablePositionMovement
| Edit this page View Source

SetEnableYAxisMovement(bool)

Declaration
public void SetEnableYAxisMovement(bool bEnableYAxisMovement)
Parameters
Type Name Description
bool bEnableYAxisMovement
| Edit this page View Source

SetInvertPitch(bool)

Declaration
public void SetInvertPitch(bool bInvertPitch)
Parameters
Type Name Description
bool bInvertPitch
| Edit this page View Source

SetNumberOfFramesToSmoothMouseData(int)

Declaration
public void SetNumberOfFramesToSmoothMouseData(int nFrames)
Parameters
Type Name Description
int nFrames
| Edit this page View Source

SetProjParams(float, float, float, float)

Declaration
public virtual void SetProjParams(float fFOV, float fAspect, float fNearPlane, float fFarPlane)
Parameters
Type Name Description
float fFOV
float fAspect
float fNearPlane
float fFarPlane
| Edit this page View Source

SetResetCursorAfterMove(bool)

Declaration
public void SetResetCursorAfterMove(bool bResetCursorAfterMove)
Parameters
Type Name Description
bool bResetCursorAfterMove
| Edit this page View Source

SetScalers()

Declaration
public void SetScalers()
| Edit this page View Source

SetScalers(float, float)

Declaration
public void SetScalers(float fRotationScaler, float fMoveScaler)
Parameters
Type Name Description
float fRotationScaler
float fMoveScaler
| Edit this page View Source

SetViewParams(XMVector, XMVector)

Declaration
public virtual void SetViewParams(XMVector vEyePt, XMVector vLookatPt)
Parameters
Type Name Description
XMVector vEyePt
XMVector vLookatPt
| Edit this page View Source

UpdateMouseDelta()

Declaration
protected void UpdateMouseDelta()
| Edit this page View Source

UpdateVelocity(double)

Declaration
protected void UpdateVelocity(double fElapsedTime)
Parameters
Type Name Description
double fElapsedTime
| Edit this page View Source

WasKeyDown(SdkCameraKeyStates)

Declaration
protected static bool WasKeyDown(SdkCameraKeyStates key)
Parameters
Type Name Description
SdkCameraKeyStates key
Returns
Type Description
bool