CWarp Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CWarp class handles

The structure used for this class is CWarp

Quick Reference¶

Quick Ref

void CWarp::CWarp()

virtual void CWarp::~CWarp()

virtual int CWarp::CheckMouseLButton()

virtual int CWarp::CheckMouseMButton()

virtual int CWarp::CheckMouseMove()

virtual int CWarp::CheckMouseRButton()

virtual int CWarp::CheckMouseWheel()

virtual int CWarp::CheckSystemKeyCapsLock()

virtual int CWarp::CheckSystemKeyCtrl()

virtual int CWarp::CheckSystemKeyMenu()

virtual int CWarp::CheckSystemKeyShift()

virtual void CWarp::DisableEditKeys()

virtual void CWarp::EnableEditKeys(short __formal)

virtual void CWarp::EngineActivated()

virtual void CWarp::EngineDeactivated()

virtual void CWarp::EngineDestroyed()

virtual void CWarp::EngineGameInit()

virtual void CWarp::EngineGameUninit()

virtual void CWarp::EngineInitialized()

virtual int CWarp::GetCapsLockKey()

virtual int CWarp::GetCtrlKey()

virtual int CWarp::GetEngineState()

virtual int CWarp::GetMenuKey()

virtual short CWarp::GetNumVirtualKeys()

virtual int CWarp::GetShiftKey()

virtual CKeyInfo* CWarp::GetVirtualKeys()

virtual int* CWarp::GetVirtualKeysFlags()

virtual void CWarp::InvalidateCursorRect(CRect& rPointer)

virtual void CWarp::NormalizePanelRect(unsigned long id, CRect& rRect)

virtual bool CWarp::OnEvent(SDL_Event* e)

virtual void CWarp::OnKeyDown(int __formal)

virtual void CWarp::OnKeyUp(int __formal)

virtual void CWarp::OnLButtonDblClk(CPoint __formal)

virtual void CWarp::OnLButtonDown(CPoint __formal)

virtual void CWarp::OnLButtonUp(CPoint __formal)

virtual void CWarp::OnLowMemory()

virtual void CWarp::OnMButtonDblClk(CPoint __formal)

virtual void CWarp::OnMButtonDown(CPoint __formal)

virtual void CWarp::OnMButtonUp(CPoint __formal)

virtual void CWarp::OnMouseMove(CPoint __formal)

virtual void CWarp::OnMouseWheel(int bForward, long nTicks, unsigned long nLines, unsigned short wFlags)

virtual void CWarp::OnRButtonDblClk(CPoint __formal)

virtual void CWarp::OnRButtonDown(CPoint __formal)

virtual void CWarp::OnRButtonUp(CPoint __formal)

virtual void CWarp::OnTextInput(const char* text)

virtual void CWarp::RenderUI()

virtual void CWarp::RequestPause()

virtual void CWarp::ResetControls()

virtual void CWarp::SelectEngine(CWarp* pWarp)

virtual void CWarp::SetSystemKeyCapsLock(int __formal)

virtual void CWarp::SetSystemKeyCtrl(unsigned char __formal)

virtual void CWarp::SetSystemKeyMenu(int __formal)

virtual void CWarp::SetSystemKeyShift(int __formal)

virtual void CWarp::TimerAsynchronousUpdate()

virtual void CWarp::TimerSynchronousUpdate()

virtual void CWarp::TimerUpdate()

virtual void CWarp::WindowResized(int w, int h)

Constructors¶

Name	Description
CWarp::CWarp	Constructs a `CWarp` object
CWarp::CWarp	Destroys a `CWarp` object

CWarp::CWarp¶

Constructs a CWarp object

void CWarp::CWarp();

Remarks

Constructs a CWarp object

CWarp::~CWarp¶

Destroys the CWarp object

virtual void CWarp::~CWarp();

Remarks

Destroys the CWarp object

Methods¶

Name	Description
CWarp::CheckMouseLButton
CWarp::CheckMouseMButton
CWarp::CheckMouseMove
CWarp::CheckMouseRButton
CWarp::CheckMouseWheel
CWarp::CheckSystemKeyCapsLock
CWarp::CheckSystemKeyCtrl
CWarp::CheckSystemKeyMenu
CWarp::CheckSystemKeyShift
CWarp::DisableEditKeys
CWarp::EnableEditKeys
CWarp::EngineActivated
CWarp::EngineDeactivated
CWarp::EngineDestroyed
CWarp::EngineGameInit
CWarp::EngineGameUninit
CWarp::EngineInitialized
CWarp::GetCapsLockKey
CWarp::GetCtrlKey
CWarp::GetEngineState
CWarp::GetMenuKey
CWarp::GetNumVirtualKeys
CWarp::GetShiftKey
CWarp::GetVirtualKeys
CWarp::GetVirtualKeysFlags
CWarp::InvalidateCursorRect
CWarp::NormalizePanelRect
CWarp::OnEvent
CWarp::OnKeyDown
CWarp::OnKeyUp
CWarp::OnLButtonDblClk
CWarp::OnLButtonDown
CWarp::OnLButtonUp
CWarp::OnLowMemory
CWarp::OnMButtonDblClk
CWarp::OnMButtonDown
CWarp::OnMButtonUp
CWarp::OnMouseMove
CWarp::OnMouseWheel
CWarp::OnRButtonDblClk
CWarp::OnRButtonDown
CWarp::OnRButtonUp
CWarp::OnTextInput
CWarp::RenderUI
CWarp::RequestPause
CWarp::ResetControls
CWarp::SelectEngine
CWarp::SetSystemKeyCapsLock
CWarp::SetSystemKeyCtrl
CWarp::SetSystemKeyMenu
CWarp::SetSystemKeyShift
CWarp::TimerAsynchronousUpdate
CWarp::TimerSynchronousUpdate
CWarp::TimerUpdate
CWarp::WindowResized

CWarp::CheckMouseLButton¶

virtual int CWarp::CheckMouseLButton();

Return Value

Returns int

Remarks

CWarp::CheckMouseMButton¶

virtual int CWarp::CheckMouseMButton();

Return Value

Returns int

Remarks

CWarp::CheckMouseMove¶

virtual int CWarp::CheckMouseMove();

Return Value

Returns int

Remarks

CWarp::CheckMouseRButton¶

virtual int CWarp::CheckMouseRButton();

Return Value

Returns int

Remarks

CWarp::CheckMouseWheel¶

virtual int CWarp::CheckMouseWheel();

Return Value

Returns int

Remarks

CWarp::CheckSystemKeyCapsLock¶

virtual int CWarp::CheckSystemKeyCapsLock();

Return Value

Returns int

Remarks

CWarp::CheckSystemKeyCtrl¶

virtual int CWarp::CheckSystemKeyCtrl();

Return Value

Returns int

Remarks

CWarp::CheckSystemKeyMenu¶

virtual int CWarp::CheckSystemKeyMenu();

Return Value

Returns int

Remarks

CWarp::CheckSystemKeyShift¶

virtual int CWarp::CheckSystemKeyShift();

Return Value

Returns int

Remarks

CWarp::DisableEditKeys¶

virtual void CWarp::DisableEditKeys();

Remarks

CWarp::EnableEditKeys¶

virtual void CWarp::EnableEditKeys(short __formal);

Parameters

short __formal -

Remarks

CWarp::EngineActivated¶

virtual void CWarp::EngineActivated();

Remarks

CWarp::EngineDeactivated¶

virtual void CWarp::EngineDeactivated();

Remarks

CWarp::EngineDestroyed¶

virtual void CWarp::EngineDestroyed();

Remarks

CWarp::EngineGameInit¶

virtual void CWarp::EngineGameInit();

Remarks

CWarp::EngineGameUninit¶

virtual void CWarp::EngineGameUninit();

Remarks

CWarp::EngineInitialized¶

virtual void CWarp::EngineInitialized();

Remarks

CWarp::GetCapsLockKey¶

virtual int CWarp::GetCapsLockKey();

Return Value

Returns int

Remarks

CWarp::GetCtrlKey¶

virtual int CWarp::GetCtrlKey();

Return Value

Returns int

Remarks

CWarp::GetEngineState¶

virtual int CWarp::GetEngineState();

Return Value

Returns int

Remarks

CWarp::GetMenuKey¶

virtual int CWarp::GetMenuKey();

Return Value

Returns int

Remarks

CWarp::GetNumVirtualKeys¶

virtual short CWarp::GetNumVirtualKeys();

Return Value

Returns short

Remarks

CWarp::GetShiftKey¶

virtual int CWarp::GetShiftKey();

Return Value

Returns int

Remarks

CWarp::GetVirtualKeys¶

virtual :ref:`CKeyInfo<CKeyInfo>`\* CWarp::GetVirtualKeys();

Return Value

Returns CKeyInfo*

Remarks

CWarp::GetVirtualKeysFlags¶

virtual int\* CWarp::GetVirtualKeysFlags();

Return Value

Returns int*

Remarks

CWarp::InvalidateCursorRect¶

virtual void CWarp::InvalidateCursorRect(CRect& rPointer);

Parameters

CRect& rPointer -

Remarks

CWarp::NormalizePanelRect¶

virtual void CWarp::NormalizePanelRect(
   unsigned long id,
   CRect& rRect);

Parameters

unsigned long id -
CRect& rRect -

Remarks

CWarp::OnEvent¶

virtual void CWarp::OnEvent(SDL_Event* e);

Parameters

SDL_Event* e -

Remarks

CWarp::OnKeyDown¶

virtual void CWarp::OnKeyDown(int __formal);

Parameters

int __formal -

Remarks

CWarp::OnKeyUp¶

virtual void CWarp::OnKeyUp(int __formal);

Parameters

int __formal -

Remarks

CWarp::OnLButtonDblClk¶

virtual void CWarp::OnLButtonDblClk(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnLButtonDown¶

virtual void CWarp::OnLButtonDown(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnLButtonUp¶

virtual void CWarp::OnLButtonUp(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnLowMemory¶

virtual void CWarp::OnLowMemory();

Parameters

Return Value

Returns

Remarks

CWarp::OnMButtonDblClk¶

virtual void CWarp::OnMButtonDblClk(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnMButtonDown¶

virtual void CWarp::OnMButtonDown(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnMButtonUp¶

virtual void CWarp::OnMButtonUp(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnMouseMove¶

virtual void CWarp::OnMouseMove(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnMouseWheel¶

virtual void CWarp::OnMouseWheel(
   int bForward,
   long nTicks,
   unsigned long nLines,
   unsigned short wFlags);

Parameters

int bForward -
long nTicks -
unsigned long nLines -
unsigned short wFlags -

Remarks

CWarp::OnRButtonDblClk¶

virtual void CWarp::OnRButtonDblClk(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnRButtonDown¶

virtual void CWarp::OnRButtonDown(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnRButtonUp¶

virtual void CWarp::OnRButtonUp(CPoint __formal);

Parameters

CPoint __formal -

Remarks

CWarp::OnTextInput¶

virtual void CWarp::OnTextInput(const char* text);

Parameters

const char* text -

Remarks

CWarp::RenderUI¶

virtual void CWarp::RenderUI();

Remarks

CWarp::RequestPause¶

virtual void CWarp::RequestPause();

Remarks

CWarp::ResetControls¶

virtual void CWarp::ResetControls();

Remarks

CWarp::SelectEngine¶

virtual void CWarp::SelectEngine(CWarp* pWarp);

Parameters

CWarp* pWarp -

Remarks

CWarp::SetSystemKeyCapsLock¶

virtual void CWarp::SetSystemKeyCapsLock(int __formal);

Parameters

int __formal -

Remarks

CWarp::SetSystemKeyCtrl¶

virtual void CWarp::SetSystemKeyCtrl(unsigned char __formal);

Parameters

unsigned char __formal -

Remarks

CWarp::SetSystemKeyMenu¶

virtual void CWarp::SetSystemKeyMenu(int __formal);

Parameters

int __formal -

Remarks

CWarp::SetSystemKeyShift¶

virtual void CWarp::SetSystemKeyShift(int __formal);

Parameters

int __formal -

Remarks

CWarp::TimerAsynchronousUpdate¶

virtual void CWarp::TimerAsynchronousUpdate();

Remarks

CWarp::TimerSynchronousUpdate¶

virtual void CWarp::TimerSynchronousUpdate();

Remarks

CWarp::TimerUpdate¶

virtual void CWarp::TimerUpdate();

Remarks

CWarp::WindowResized¶

virtual void CWarp::WindowResized(
   int w,
   int h);

Parameters

int w -
int h -

Remarks