NL3D::U3dMouseListener Class Reference

#include <u_3d_mouse_listener.h>

Inheritance diagram for NL3D::U3dMouseListener:

NL3D::CEvent3dMouseListener

Detailed Description

3d mouse listener

Author:
Cyril 'Hulud' Corvazier

Nevrax France

Date:
2001

Definition at line 43 of file u_3d_mouse_listener.h.

Public Types

enum  TMouseMode { nelStyle, edit3d, firstPerson }

Public Member Functions

Get
virtual CVector getHotSpot () const=0
virtual const NLMISC::CMatrixgetViewMatrix ()=0
Setup
virtual void setFrustrum (const CFrustum &frustrum)=0
virtual void setHotSpot (const CVector &hotSpot)=0
virtual void setMatrix (const NLMISC::CMatrix &matrix)=0
virtual void setMouseMode (TMouseMode mouseMode)=0
virtual void setSpeed (float speed)=0
virtual void setViewport (const NL3D::CViewport &viewport)=0


Member Enumeration Documentation

enum NL3D::U3dMouseListener::TMouseMode
 

Mouse mode. There is two move modes: 3d editor style and NeL style. Default mode is NeL style.

(nelStyle) NeL style is: MouseRotateHotSpot: CTRL + RIGHTMOUSE MouseTranslateXYHotSpot: CTRL + LEFTMOUSE MouseTranslateZHotSpot: CTRL + SHIFT + LEFTMOUSE MouseZoomHotSpot: ALT + LEFTMOUSE

(edit3dStyle) 3d editor style is: MouseRotateHotSpot: ALT + MIDDLEMOUSE MouseTranslateXYHotSpot: MIDDLEMOUSE MouseTranslateZHotSpot: CTRL + MIDDLEMOUSE

(firstPerson) First person shoorter style is: MouseRotateView: MOUSE MOVE KeyUp: MOVE FORWARD KeyDown: MOVE BACKWARD Left: STRAF LEFT Right: STRAF RIGHT PageUp: MOVE UP PageDown: MOVE DOWN

Enumeration values:
nelStyle 
edit3d 
firstPerson 

Definition at line 70 of file u_3d_mouse_listener.h.


Member Function Documentation

virtual CVector NL3D::U3dMouseListener::getHotSpot  )  const [pure virtual]
 

Get the current hot spot.

Returns:
the target used when the mouse move. It can be for exemple the center. of the selected object. The hotspot is not modified by mouse events.
See also:
getViewMatrix()

Implemented in NL3D::CEvent3dMouseListener.

virtual const NLMISC::CMatrix& NL3D::U3dMouseListener::getViewMatrix  )  [pure virtual]
 

Get the current view matrix. This matrix is updated with mouse events.

Returns:
The current view matrix.
See also:
setMatrix()

Implemented in NL3D::CEvent3dMouseListener.

virtual void NL3D::U3dMouseListener::setFrustrum const CFrustum frustrum  )  [pure virtual]
 

Set the current frustrum to use.

Parameters:
frustrum is the frustrum.

Implemented in NL3D::CEvent3dMouseListener.

virtual void NL3D::U3dMouseListener::setHotSpot const CVector hotSpot  )  [pure virtual]
 

Set the current hot spot.

Parameters:
hotSpot is the target to use when the mouse move. It can be for exemple the center. of the selected object. The hotspot is not modified by mouse events.
See also:
getViewMatrix()

Implemented in NL3D::CEvent3dMouseListener.

virtual void NL3D::U3dMouseListener::setMatrix const NLMISC::CMatrix matrix  )  [pure virtual]
 

Set the current view matrix to use.

Parameters:
matrix is the matrix to set.
See also:
getViewMatrix()

Implemented in NL3D::CEvent3dMouseListener.

virtual void NL3D::U3dMouseListener::setMouseMode TMouseMode  mouseMode  )  [pure virtual]
 

Set the mouse mode.

Parameters:
mouseMode is the mode you want to use.
See also:
TMouseMode

Implemented in NL3D::CEvent3dMouseListener.

virtual void NL3D::U3dMouseListener::setSpeed float  speed  )  [pure virtual]
 

Set the speed for first person mode. Default 10.f;

Parameters:
speed is in unit per second.
See also:
TMouseMode

Implemented in NL3D::CEvent3dMouseListener.

virtual void NL3D::U3dMouseListener::setViewport const NL3D::CViewport viewport  )  [pure virtual]
 

Set the viewport in use in the window. By default, the viewport is fullwindow.

Parameters:
viewport is the viewport to use. All events outside the viewport are ignored.

Implemented in NL3D::CEvent3dMouseListener.


The documentation for this class was generated from the following file:
Generated on Tue Mar 16 08:42:16 2004 for NeL by doxygen 1.3.6