VRUT::Navigation Class Reference

Module processing input events and applying them to camera. More...

#include <navigation.h>

Inheritance diagram for VRUT::Navigation:

List of all members.

Public Member Functions
	Navigation (const MODULE_ID &_id, const wxString &_name, EventHandler *msgSink)
	Class constructor.
virtual	~Navigation ()
	Class destructor.
virtual wxString	GetDesc () const
	Get module description - Module overload.
Protected Types
enum	NavigationStyle {   CAMERA_MANIPULATOR = 0, CATIA = 1, ICEMSURF = 2, DELTAGEN = 3,   VD2 = 4, CORTONA = 5, CINEMA4D = 6, MAYA = 7 }
	Enums of the supported navigation styles. More...
enum	ViewName { FRONT, SIDE, TOP, REAR }
typedef std::vector < NavigationStyleInterface * >	NavigationStyleVector
	Vector of supported navigation styles typedef.
typedef std::vector< const SceneNode * >	SceneNodeVector
	Vector of scene node pointers.
typedef std::list < NavigationOperationPair >	ParameterIdentificatorList
	List of ParameterIdentificator.
Protected Member Functions
wxString	buildCurrentCameraString (const SceneNode *node)
	Creates a string for the camera selection combobox.
void	lowMouseEventTimeout ()
	Sets the mouse event timeout low.
void	highMouseEventTimeout ()
	Sets the mouse event timeout high.
void	registerGUI ()
	Convenience method for registering all gui elements.
void	refreshGUI ()
	Called whenever the gui elements are changed.
void	registerCommonGUIControls ()
	Register the gui controls which arent specific for any emulation.
void	registerTextControl (Parameter::ParameterIdentificator &paramID, const wxString &value)
	Convenience method for registering a text field. Macro can not be used because it does not work when used inside the embedded class (eg. NavigationStyleCATIASpecific).
void	registerButton (Parameter::ParameterIdentificator &paramID)
	Convenience method for registering single button. Macro can not be used because it does not work when used inside the embedded class (eg. NavigationStyleCATIASpecific).
void	registerButtonList (ParameterIdentificatorList &buttonList)
	Convenience method for registering a whole List of buttons.
bool	isAnyButtonSelected (const ParameterIdentificatorList &buttonList) const
	Returns true if any button was selected, false oterwise.
bool	getAndFixButtonValues (const wxCommandEvent &evt, ParameterIdentificatorList &buttonList)
	Determines which button was pressed last. Returns true if any button changed its value.
void	clearButtonValues (ParameterIdentificatorList &buttonList)
	Sets that no button is pressed.
void	clearButtonValuesConditional (const wxCommandEvent &evt, ParameterIdentificatorList &buttonList)
	Sets that no button is pressed if the passed event is generated by one of the buttons.
NavigationStyleInterface *	resolveStyleFromString (const wxString &string) const
	Returns corresponding enum associated with the style string.
void	select (Scene *scene, Camera *camera, wxMouseEvent &evt)
	Convenience method for selecting an object in a scene.
void	pickScenePivot (Scene *scene, Camera *camera, const NODE_ID &cameraID, wxMouseEvent &evt)
	Method for setting the scenePivot to a selected surface.
void	translateCameraCenterToSelection (Scene *scene, Camera *camera, const NODE_ID &cameraID, wxMouseEvent &evt)
	Convenience method for translating a camera center to a selected surface.
void	pan (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speed)
	Convenience method for panning a camera in a scene.
void	rotate (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseAbsolute, const wxPoint &mouseDelta, bool rollControl, bool yAlignedUpVector, bool rotateAroundScenePivot)
	Convenience method for rotating a camera around a point in a scene.
void	turnHead (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, bool yAlignedUpVector)
	Convenience method for rotating a camera around the camera origin.
void	fly (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta)
	Convenience method for a camera fly-through.
void	zoom (Scene *scene, Camera *camera, const NODE_ID &cameraID, int mouseDelta, float speed)
	Convenience method for zooming a camera in a scene.
void	roll (Scene *scene, Camera *camera, const NODE_ID &cameraID, int mouseDelta, float speed, bool rotateAroundScenePivot)
	Convenience method for rolling a camera in a scene.
void	turnHeadLeftRightWithYAlignedUpVector (Scene *scene, Camera *camera, const NODE_ID &cameraID, int mouseXDelta, float speed)
	Convenience method for turning camera left or right around the 0,1,0 vector.
void	moveWithCollisionTesting (Scene *scene, Camera *camera, const NODE_ID &cameraID, const VECTOR3 &walkDirection, float speedModifier, float maxStepHeight, float avatarHeight)
	Moving around with the collision detection enabled.
void	planWalk (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier, float maxStepHeight, float avatarHeight)
	Convenience method for the Cortona plan walk.
void	panWalk (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier, float maxStepHeight, float avatarHeight)
	Convenience method for the Cortona pan walk.
void	turnWalk (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona turn walk.
void	planFly (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona plan fly.
void	panFly (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona pan fly.
void	turnFly (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona turn fly.
void	rollFly (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona roll fly.
void	planStudy (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona plan study.
void	panStudy (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona pan study.
void	turnStudy (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona turn study.
void	rollStudy (Scene *scene, Camera *camera, const NODE_ID &cameraID, const wxPoint &mouseDelta, float speedModifier)
	Convenience method for the Cortona roll study.
void	processNavigationOperationButtonEvent ()
	Executes actions of some navigation buttons which require immediate reaction (like zoom in, zoom out).
void	findCameras (SceneNodeVector &cameras)
	Finds all cameras in the scene.
void	setInitialScenePivot ()
	Sets the scene pivot as the center of the root BVH.
void	removePitch ()
	Rotates the camera so that its pitch is zero.
void	alignView (ViewName name)
	Aligns the camera to the world axis.
virtual void	processEvent (wxCommandEvent &evt)
	Process event - CameraModule overload.
virtual void	processKeyEvent (wxKeyEvent &evt)
	Process key event - CameraModule overload.
virtual void	processMouseEvent (wxMouseEvent &evt)
	Process mouse event - CameraModule overload.
virtual void	run ()
	The run method for this module. Used for the fly-throughs.
Protected Attributes
NavigationStyleVector	navigationStyleDefinition
	Vector of supported navigation styles.
SceneNodeVector	cameras
	Vector of scene cameras.
wxArrayString	navigationStyleString
	Navigation style strings.
wxArrayString	cameraString
	Scene camera names.
Parameter::ParameterIdentificator	navigationStyleParamID
	navigationStyle param identificator
Parameter::ParameterIdentificator	selectedCameraParamID
	selectedCamera param identificator
wxPoint	lastPos
	Last mouse position.
wxPoint	mouseDelta
	Mouse coordinate difference between the current frame and the last frame.
VECTOR3	scenePivot
	Scene pivot.
bool	scenePivotWasSet
	Scene pivot was set.
NODE_ID	selectedObject
NavigationStyleInterface *	activeNavigationStyle
	Pointer to the active navigation style.
NavigationStyleCameraManipulatorSpecific	navigationStyleCameraManipulatorSpecific
	CameraManipulator specific variables needed for a proper emulation.
NavigationStyleCATIASpecific	navigationStyleCATIASpecific
	CATIA specific variables needed for a proper emulation.
NavigationStyleCortonaSpecific	navigationStyleCortonaSpecific
	Cortona specific variables needed for a proper emulation.
NavigationStyleCinema4DSpecific	navigationStyleCinema4DSpecific
	Cinema4D specific variables needed for a proper emulation.
NavigationStyleMayaSpecific	navigationStyleMayaSpecific
	Maya specific variables needed for a proper emulation.
NavigationStyleDeltaViewSpecific	navigationStyleDeltaViewSpecific
	DeltaView specific variables needed for a proper emulation.
NavigationStyleICEMSurfSpecific	navigationStyleICEMSurfSpecific
	Icem Surf specific variables needed for a proper emulation.
NavigationStyleVD2Specific	navigationStyleVD2Specific
	Virtual Design 2 specific variables needed for a proper emulation.
Parameter::ParameterIdentificator	cameraCenterDistanceParamID
	Camera center distance param identificator
bool	fovChangeOperationStarted
	We set the fov param id only when the user releases the mouse button. This variable helps us know when this happens.
float	nearPlane
	Camera near plane.
float	farPlane
	Camera far plane.
float	fov
	Field of view.
Parameter::ParameterIdentificator	fovParamID
	fov param identificator
Parameter::ParameterIdentificator	farPlaneParamID
	farPlane param identificator
Parameter::ParameterIdentificator	nearPlaneParamID
	nearPlane param identificator
float	rotspeed
	Rotate sensitivity coef.
float	zoomStep
	Zoom step.
float	flySpeedStep
	Fly speed step.
Parameter::ParameterIdentificator	rotspeedParamID
	rotspeed param identificator
float	zoomspeed
	Zoom sensitivity coef.
Parameter::ParameterIdentificator	zoomspeedParamID
	zoomspeed param identificator
float	cruisespeed
	Cruise sensitivity coef.
Parameter::ParameterIdentificator	cruisespeedParamID
	cruisespeed param identificator
float	panspeed
	Navigation speed coef for pan.
Parameter::ParameterIdentificator	panspeedParamID
	panspeed param identificator
Private Attributes
wxString	defaultMouseEventTimeout
Classes
struct	NavigationOperationPair
	Navigation operation pair. More...
class	NavigationStyleCameraManipulatorSpecific
	Type for CameraManipulator specific variables needed for a proper emulation. More...
class	NavigationStyleCATIASpecific
	Type for CATIA specific variables needed for a proper emulation. More...
class	NavigationStyleCinema4DSpecific
	Type for Cinema4D specific variables needed for a proper emulation. More...
class	NavigationStyleCortonaSpecific
	Type for Cortona specific variables needed for a proper emulation. More...
class	NavigationStyleDeltaViewSpecific
	Type for DeltaView specific variables needed for a proper emulation. More...
class	NavigationStyleICEMSurfSpecific
	Type for ICEMSurf specific variables needed for a proper emulation. More...
class	NavigationStyleMayaSpecific
	Type for Maya specific variables needed for a proper emulation. More...
class	NavigationStyleVD2Specific
	Type for VD2 specific variables needed for a proper emulation. More...

---

Detailed Description

Module processing input events and applying them to camera.

Definition at line 27 of file navigation.h.

---

Member Typedef Documentation

typedef std::vector<NavigationStyleInterface*> VRUT::Navigation::NavigationStyleVector [protected]

Vector of supported navigation styles typedef.

Definition at line 61 of file navigation.h.

typedef std::vector<const SceneNode*> VRUT::Navigation::SceneNodeVector [protected]

Vector of scene node pointers.

Definition at line 63 of file navigation.h.

typedef std::list<NavigationOperationPair> VRUT::Navigation::ParameterIdentificatorList [protected]

List of ParameterIdentificator.

Definition at line 81 of file navigation.h.

---

Member Enumeration Documentation

enum VRUT::Navigation::NavigationStyle [protected]

Enums of the supported navigation styles.

Enumerator:

CAMERA_MANIPULATOR
CATIA
ICEMSURF
DELTAGEN
VD2
CORTONA
CINEMA4D
MAYA

Definition at line 32 of file navigation.h.

              {
                     CAMERA_MANIPULATOR = 0,
                     CATIA = 1,
                     ICEMSURF = 2,
                     DELTAGEN = 3,
                     VD2 = 4,
                     CORTONA = 5,
                     CINEMA4D = 6,
                     MAYA = 7
              };

enum VRUT::Navigation::ViewName [protected]

Enumerator:

FRONT
SIDE
TOP
REAR

Definition at line 43 of file navigation.h.

              {
                     FRONT,
                     SIDE,
                     TOP,
                     REAR
              };

---

Constructor & Destructor Documentation

Navigation::Navigation	(	const MODULE_ID &	_id,
		const wxString &	_name,
		EventHandler *	msgSink
	)

Class constructor.

Definition at line 20 of file navigation.cpp.

              : CameraModule(_id, _name, 0, msgSink),
              navigationStyleCameraManipulatorSpecific(_id, _name, this),
              navigationStyleCATIASpecific(_id, _name, this),
              navigationStyleCortonaSpecific(_id, _name, this),
              navigationStyleCinema4DSpecific(_id, _name, this),
              navigationStyleMayaSpecific(_id, _name, this),
              navigationStyleDeltaViewSpecific(_id, _name, this),
              navigationStyleICEMSurfSpecific(_id, _name, this),
              navigationStyleVD2Specific(_id, _name, this)
{
       //navigationStyleDefinition.push_back(&navigationStyleCameraManipulatorSpecific);
       navigationStyleDefinition.push_back(&navigationStyleCATIASpecific);
       navigationStyleDefinition.push_back(&navigationStyleCortonaSpecific);
       navigationStyleDefinition.push_back(&navigationStyleCinema4DSpecific);
       navigationStyleDefinition.push_back(&navigationStyleMayaSpecific);
       navigationStyleDefinition.push_back(&navigationStyleDeltaViewSpecific);
       navigationStyleDefinition.push_back(&navigationStyleICEMSurfSpecific);
       navigationStyleDefinition.push_back(&navigationStyleVD2Specific);

       for (NavigationStyleVector::iterator i = navigationStyleDefinition.begin(); i != navigationStyleDefinition.end(); i++)
       {
              navigationStyleString.Add((*i)->getStyleName());
       }

       //activeNavigationStyle = &navigationStyleCameraManipulatorSpecific;
       activeNavigationStyle = &navigationStyleVD2Specific;

       SET_DEFAULT_PARAM(eventTimeoutParamID, wxT("0"));
       SET_DEFAULT_PARAM(keyEventTimeoutParamID, wxT("0"));
       defaultMouseEventTimeout = wxT("50");
       SET_DEFAULT_PARAM(msEventTimeoutParamID, defaultMouseEventTimeout);

       fov = 0.0f;
       nearPlane = 0.0f;
       farPlane = 0.0f;
       rotspeed = 5e-3f;
       zoomspeed = 2e-1f;
       cruisespeed = 6e-2f;
       panspeed = 0.06f;
       zoomStep = 10.0f;
       flySpeedStep = 0.05f;

       selectedObject = NODE_ID_NONE;

       scenePivotWasSet = false;
       fovChangeOperationStarted = false;

       registerGUI();

       REGISTER_LISTENER(Event::EVT_SCENE_CAM_PROJECTION_CHANGED);
       //REGISTER_LISTENER(Event::EVT_SCENE_NODE_TRANSFORMED);
}

Navigation::~Navigation

(

)

[virtual]

Class destructor.

Definition at line 162 of file navigation.cpp.

{
}

---

Member Function Documentation

wxString Navigation::buildCurrentCameraString

(

const SceneNode *

node

)

[protected]

Creates a string for the camera selection combobox.

Definition at line 89 of file navigation.cpp.

{
       wxString id;
       if (node && node->IsOfType(SceneNode::CAMERA))
       {
              id << node->GetName() << wxT(" [id = ") << node->GetID() << wxT("]");
       }
       return id;
}

void Navigation::lowMouseEventTimeout

(

)

[protected]

Sets the mouse event timeout low.

Definition at line 1111 of file navigation.cpp.

{
       wxCommandEvent paramEvt = Event::GET_EVT_PARAM_SET_DO(msEventTimeoutParamID, wxT("0"), false);
       PostToKernel(paramEvt);
}

void Navigation::highMouseEventTimeout

(

)

[protected]

Sets the mouse event timeout high.

Definition at line 1117 of file navigation.cpp.

{
       wxCommandEvent paramEvt = Event::GET_EVT_PARAM_SET_DO(msEventTimeoutParamID, defaultMouseEventTimeout, false);
       PostToKernel(paramEvt);
}

void Navigation::registerGUI

(

)

[protected]

Convenience method for registering all gui elements.

Definition at line 74 of file navigation.cpp.

{
       registerCommonGUIControls();
       activeNavigationStyle->registerButtons();
}

void Navigation::refreshGUI

(

)

[protected]

Called whenever the gui elements are changed.

Definition at line 80 of file navigation.cpp.

{
       Parameter::ParameterIdentificator param = eventTimeoutParamID; //Any parameter ID can be here as long it is from this module. All I need it for is the module name and instance number.
       param.paramName = wxT("*");
       wxCommandEvent paramGuiEvt = Event::GET_EVT_PARAM_GUIUNREGISTER(param);
       PostToKernel(paramGuiEvt);
       registerGUI();
}

void Navigation::registerCommonGUIControls

(

)

[protected]

Register the gui controls which arent specific for any emulation.

Definition at line 99 of file navigation.cpp.

{
       wxString paramValue;
       REGISTER_PARAM_GUI_TEXTCONTROL(sceneIDParamID, wxT("sceneID"), wxString::Format(wxT("%i"), sceneID), wxT("ID of scene to handle."));
       REGISTER_PARAM_GUI_TEXTCONTROL(windowIDParamID, wxT("windowID"), wxString::Format(wxT("%i"), windowID), wxT("ID of renderer window."));
       REGISTER_PARAM_GUI_COMBOBOX(navigationStyleParamID, wxT("navigationStyle"), activeNavigationStyle->getStyleName(), navigationStyleString, wxT("Style of navigation."));

       wxString cameraCenterDistanceValue, fovValue, nearPlaneValue, farPlaneValue, zero(wxT("0.0"));

       wxString currentCameraName;

       if (sceneMgr)
       {
              const Scene * scene = GetSceneMgr()->GetScene(getSceneID());
              if (scene)
              {
                     const SceneNode * camNode = scene->GetNode(getCameraID());
                     if (camNode && camNode->IsOfType(SceneNode::CAMERA))
                     {
                            ReadLocker rLock(*camNode);
                            cameraCenterDistanceValue = wxString::Format(wxT("%g"), ((Camera *)camNode)->GetCenterDist());
                            fovValue = wxString::Format(wxT("%g"), ((Camera *)camNode)->GetFOV());
                            nearPlaneValue = wxString::Format(wxT("%g"), ((Camera *)camNode)->GetNearPlane());
                            farPlaneValue = wxString::Format(wxT("%g"), ((Camera *)camNode)->GetFarPlane());
                            currentCameraName = buildCurrentCameraString(scene->GetNode(getCameraID()));
                     }
              }
       }
       else
       {
              cameraCenterDistanceValue = zero;
              fovValue = zero;
              nearPlaneValue = zero;
              farPlaneValue = zero;
       }

       findCameras(cameras);
       cameraString.clear();
       for (SceneNodeVector::iterator i = cameras.begin(); i != cameras.end(); i++)
       {
              LOGDEBUG(wxT("Navigation found a camera named: ")+buildCurrentCameraString((*i)));
              cameraString.Add(buildCurrentCameraString((*i)));
       }
       REGISTER_PARAM_GUI_COMBOBOX(selectedCameraParamID, wxT("selectedCamera"), currentCameraName, cameraString, wxT("Camera node used to view."));

       REGISTER_PARAM_GUI_TEXTCONTROL(cameraCenterDistanceParamID, wxT("cameraCenterDistance"), cameraCenterDistanceValue, wxT("cameraCenterDistance"));
       REGISTER_PARAM_GUI_TEXTCONTROL(fovParamID, wxT("FOV"), fovValue, wxT("Field of view."));
       REGISTER_PARAM_GUI_TEXTCONTROL(nearPlaneParamID, wxT("nearPlane"), nearPlaneValue, wxT("Near clipping plane."));
       REGISTER_PARAM_GUI_TEXTCONTROL(farPlaneParamID, wxT("farPlane"), farPlaneValue, wxT("Far clipping plane."));

       paramValue << rotspeed;
       REGISTER_PARAM_GUI_TEXTCONTROL(rotspeedParamID, wxT("rotspeed"), paramValue, wxT("Speed of rotation."));
       paramValue.clear();
       paramValue << zoomspeed;
       REGISTER_PARAM_GUI_TEXTCONTROL(zoomspeedParamID, wxT("zoomspeed"), paramValue, wxT("Speed of zoom."));
       paramValue.clear();
       paramValue << cruisespeed;
       REGISTER_PARAM_GUI_TEXTCONTROL(cruisespeedParamID, wxT("cruisespeed"), paramValue, wxT("cruisespeed"));
       paramValue.clear();
       paramValue << panspeed;
       REGISTER_PARAM_GUI_TEXTCONTROL(panspeedParamID, wxT("panspeed"), paramValue, wxT("Speed of pannign."));
}

void Navigation::registerTextControl	(	Parameter::ParameterIdentificator &	paramID,
		const wxString &	value
	)			[protected]

Convenience method for registering a text field. Macro can not be used because it does not work when used inside the embedded class (eg. NavigationStyleCATIASpecific).

Definition at line 222 of file navigation.cpp.

{
       REGISTER_PARAM_GUI_TEXTCONTROL(paramID, paramID.paramName, value, paramID.description);
}

void Navigation::registerButton

(

Parameter::ParameterIdentificator &

paramID

)

[protected]

Convenience method for registering single button. Macro can not be used because it does not work when used inside the embedded class (eg. NavigationStyleCATIASpecific).

Definition at line 227 of file navigation.cpp.

{
       wxCommandEvent paramEvt = Event::GET_EVT_PARAM_REGISTER(paramID, wxT("0"));
       PostToKernel(paramEvt);
       GUIEnvironment::GUIParamInfo guiPI(paramID, GUIEnvironment::GUIParamInfo::GUI_TYPE_BUTTON);
       wxCommandEvent paramGuiEvt = Event::GET_EVT_PARAM_GUIREGISTER(guiPI, wxT("0"));
       PostToKernel(paramGuiEvt);
}

void Navigation::registerButtonList

(

ParameterIdentificatorList &

buttonList

)

[protected]

Convenience method for registering a whole List of buttons.

Definition at line 200 of file navigation.cpp.

{
       for (ParameterIdentificatorList::iterator i = buttonList.begin(); i != buttonList.end(); i++)
       {
              REGISTER_PARAM_GUI_BUTTON(i->paramId, i->paramId.paramName, i->paramId.description);
       }
}

bool Navigation::isAnyButtonSelected

(

const ParameterIdentificatorList &

buttonList

)

const [protected]

Returns true if any button was selected, false oterwise.

Definition at line 360 of file navigation.cpp.

{
       for (ParameterIdentificatorList::const_iterator i = buttonList.begin(); i != buttonList.end(); i++)
       {
              if (i->paramValue)
              {
                     return true;
              }
       }
       return false;
}

bool Navigation::getAndFixButtonValues	(	const wxCommandEvent &	evt,
		ParameterIdentificatorList &	buttonList
	)			[protected]

Determines which button was pressed last. Returns true if any button changed its value.

Definition at line 208 of file navigation.cpp.

{
       bool changed = false;
       for (ParameterIdentificatorList::iterator i = buttonList.begin(); i != buttonList.end(); i++)
       {
              if (Parameter::ParameterIdentificator::FromEvent(evt) == i->paramId)
              {
                     i->paramValue = !i->paramValue;
                     changed = true;
              }
       }
       return changed;
}

void Navigation::clearButtonValues

(

ParameterIdentificatorList &

buttonList

)

[protected]

Sets that no button is pressed.

Definition at line 384 of file navigation.cpp.

{
       for (ParameterIdentificatorList::iterator i = buttonList.begin(); i != buttonList.end(); i++)
       {
              i->paramValue = 0;
       }
}

void Navigation::clearButtonValuesConditional	(	const wxCommandEvent &	evt,
		ParameterIdentificatorList &	buttonList
	)			[protected]

Sets that no button is pressed if the passed event is generated by one of the buttons.

Definition at line 392 of file navigation.cpp.

{
       bool clear = false;
       for (ParameterIdentificatorList::iterator i = buttonList.begin(); i != buttonList.end(); i++)
       {
              if (Parameter::ParameterIdentificator::FromEvent(evt) == i->paramId)
              {
                     clear = true;
                     break;
              }
       }
       if (clear)
       {
              for (ParameterIdentificatorList::iterator i = buttonList.begin(); i != buttonList.end(); i++)
              {
                     i->paramValue = 0;
              }
       }
}

NavigationStyleInterface * Navigation::resolveStyleFromString

(

const wxString &

string

)

const [protected]

Returns corresponding enum associated with the style string.

Definition at line 188 of file navigation.cpp.

{
       for (NavigationStyleVector::const_iterator i = navigationStyleDefinition.begin(); i != navigationStyleDefinition.end(); i++)
       {
              if ( (*i)->getStyleName() == string )
              {
                     return *i;
              }
       }
       return 0;
}

void Navigation::select	(	Scene *	scene,
		Camera *	camera,
		wxMouseEvent &	evt
	)			[protected]

Convenience method for selecting an object in a scene.

Definition at line 732 of file navigation.cpp.

{
       unsigned width, height;
       camera->GetWidthHeight(&width, &height);

       float px = ((( 2.0f * evt.GetPosition().x) / width) - 1.0f) / camera->GetProjectionMatrix()->_m11;
       float py = (((-2.0f * evt.GetPosition().y) / height) + 1.0f) / camera->GetProjectionMatrix()->_m22;

       VECTOR3 origin(0, 0, 0);
       VECTOR3 direction(px, py, -1.0f);

       origin = camera->GetWorldTransMatrix()->TransformCoord(origin);
       direction = camera->GetWorldTransMatrix()->TransformNormal(direction).Normalize();
       Ray ray(origin, direction);

       BVH::IntersectionInfo info;

       if (scene->GetBVH())
       {
              if (scene->GetBVH()->BoundProbe(ray, &info))
              {
                     const SceneNode * node = scene->GetNode(info.nodeID);
                     if (node)
                     {
                            selectedObject = node->GetID();
                            LOGDEBUG(wxString::Format(wxT("Selected object ID=%i, Name=%s"), info.nodeID, node->GetName().c_str()));
                     }
              }
              else
              {
                     selectedObject = NODE_ID_NONE;
                     LOGDEBUG(wxT("No object selected"));
              }
       }
}

void Navigation::pickScenePivot	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		wxMouseEvent &	evt
	)			[protected]

Method for setting the scenePivot to a selected surface.

Definition at line 768 of file navigation.cpp.

{
       unsigned width, height;
       camera->GetWidthHeight(&width, &height);

       float px = ((( 2.0f * evt.GetPosition().x) / width) - 1.0f) / camera->GetProjectionMatrix()->_m11;
       float py = (((-2.0f * evt.GetPosition().y) / height) + 1.0f) / camera->GetProjectionMatrix()->_m22;

       VECTOR3 origin(0, 0, 0);
       VECTOR3 direction(px, py, -1.0f);

       origin = camera->GetWorldTransMatrix()->TransformCoord(origin);
       direction = camera->GetWorldTransMatrix()->TransformNormal(direction).Normalize();
       Ray ray(origin, direction);

       RayIntersectionInfo info;
       if (scene->GetBVH() && scene->GetBVH()->CastRay(ray, info))
       {
              const SceneNode * node = scene->GetNode(info.nodeID);
              if (node)
              {
                     scenePivot = origin + direction * info.dist;
                     LOGDEBUG(wxT("scenePivot was set"));
              }
       }
}

void Navigation::translateCameraCenterToSelection	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		wxMouseEvent &	evt
	)			[protected]

Convenience method for translating a camera center to a selected surface.

Definition at line 795 of file navigation.cpp.

{
       unsigned width, height;
       camera->GetWidthHeight(&width, &height);

       float px = ((( 2.0f * evt.GetPosition().x) / width) - 1.0f) / camera->GetProjectionMatrix()->_m11;
       float py = (((-2.0f * evt.GetPosition().y) / height) + 1.0f) / camera->GetProjectionMatrix()->_m22;

       VECTOR3 origin(0, 0, 0);
       VECTOR3 direction(px, py, -1.0f);

       origin = camera->GetWorldTransMatrix()->TransformCoord(origin);
       direction = camera->GetWorldTransMatrix()->TransformNormal(direction).Normalize();
       Ray ray(origin, direction);

       RayIntersectionInfo info;
       if (scene->GetBVH() && scene->GetBVH()->CastRay(ray, info))
       {
              const SceneNode * node = scene->GetNode(info.nodeID);
              if (node)
              {
                     scene->Transform(cameraID, MATRIX::Translation((origin + direction * info.dist) - camera->GetCenterPoint()));
                     scene->UpdateTransformation(cameraID);
              }
       }
}

void Navigation::pan	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speed
	)			[protected]

Convenience method for panning a camera in a scene.

Definition at line 412 of file navigation.cpp.

{
       VECTOR3 camUp = camera->GetUp().Normalize();
       VECTOR3 move = mouseDelta.x * camUp.Cross(camera->GetView()).Normalize();
       move += mouseDelta.y * camUp;
       move *= speed;
       scene->Transform(cameraID, MATRIX::Translation(move));
       scene->UpdateTransformation(cameraID);
       if (!KERNEL)
       {
              wxCommandEvent ev = Event::GET_EVT_RENDER_UPDATE(scene->GetID());
              PostToKernel(ev, true);
       }
}

void Navigation::rotate	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseAbsolute,
		const wxPoint &	mouseDelta,
		bool	rollControl,
		bool	yAlignedUpVector,
		bool	rotateAroundScenePivot
	)			[protected]

Convenience method for rotating a camera around a point in a scene.

Definition at line 427 of file navigation.cpp.

{
       //unsigned int windowWidth, windowHeight;
       //camera->GetWidthHeight(&windowWidth, &windowHeight);
       //VECTOR3 mouse(mouseAbsolute.x-(int)windowWidth/2, mouseAbsolute.y-(int)windowHeight/2, 0); //I am using a 3d vector because the 2d equivalent has no length() method.
       //unsigned int trackballRadius = windowHeight / 3;

       //if (mouse.Length()<trackballRadius || !rollControl) //yaw and pitch
       //{
       float angleX = mouseDelta.x * rotspeed;
       float angleY = -mouseDelta.y * rotspeed;
       VECTOR3 camUp = camera->GetUp().Normalize();
       VECTOR3 center = camera->GetCenterPoint();
       MATRIX m;

       if (rotateAroundScenePivot)
              m *= MATRIX::Translation(-scenePivot);

       if (angleX)
       {
              m *= MATRIX::RotationAxis(yAlignedUpVector ? VECTOR3(0.0f, 1.0f, 0.0f) : camUp, angleX);
       }
       if (angleY)
       {
              m *= MATRIX::RotationAxis(camUp.Cross(camera->GetView()).Normalize(), angleY);
       }

       if (rotateAroundScenePivot)
              m *= MATRIX::Translation(scenePivot);

       if (angleX || angleY)
       {
              scene->Transform(cameraID, m);
              scene->UpdateTransformation(cameraID);
       }

       if (!rotateAroundScenePivot)
       {
              scene->TranslateAbs(cameraID, center - camera->GetView().Normalize()*camera->GetCenterDist());
              scene->UpdateTransformation(cameraID);
       }
       //}

       //Deprecated. But the code still might come in handy while coding the navigation emulation of 3DS Max in the future

       //else //roll
       //     //TODO: draw a circle to show where the roll area starts
       //{
       //     VECTOR3 prevMouseCoord(mouse);
       //     prevMouseCoord -= VECTOR3(mouseDelta.x, mouseDelta.y, 0);
       //     //Assume a 2D space divided by a prevMouseCoord vector into two half spaces.
       //     //We have to check in which half space the current mouse coordinate lies in, to determine the rotation direction.

       //     //First, we compute the prevMouseCoord vector normal so that we can insert the current mouse coord into the line equation ax+by=0
       //     //The c parameter is 0 because the line goes through the origin.
       //     VECTOR3 prevMouseCoordNormal(-prevMouseCoord.y, prevMouseCoord.x);
       //     prevMouseCoordNormal = prevMouseCoordNormal.Normalize();
       //     //This dot product is the insertion of values into the equation. Result is the signed distance from the prevMouseCoord vector.
       //     float distance = prevMouseCoordNormal.x*mouse.x+prevMouseCoordNormal.y*mouse.y;

       //     roll(scene, camera, cameraID, wxPoint(1, 0), rotspeed * distance);
       //}

       if (!KERNEL)
       {
              wxCommandEvent ev = Event::GET_EVT_RENDER_UPDATE(scene->GetID());
              PostToKernel(ev, true);
       }
}

void Navigation::turnHead	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		bool	yAlignedUpVector
	)			[protected]

Convenience method for rotating a camera around the camera origin.

Definition at line 497 of file navigation.cpp.

{
       float angleX = mouseDelta.x * rotspeed;
       float angleY = -mouseDelta.y * rotspeed;
       VECTOR3 camUp = camera->GetUp().Normalize();

       VECTOR3 position = camera->GetWorldTransMatrix()->ExtractTranslation();

       if (angleX)
       {
              scene->Transform(cameraID, MATRIX::RotationAxis(yAlignedUpVector ? VECTOR3(0.0f, 1.0f, 0.0f) : camUp, angleX));
              scene->UpdateTransformation(cameraID);
       }
       if (angleY)
       {
              scene->Transform(cameraID, MATRIX::RotationAxis(camUp.Cross(camera->GetView()).Normalize(), angleY));
              scene->UpdateTransformation(cameraID);
       }

       scene->TranslateAbs(cameraID, position);
       scene->UpdateTransformation(cameraID);

       if (!KERNEL)
       {
              wxCommandEvent ev = Event::GET_EVT_RENDER_UPDATE(scene->GetID());
              PostToKernel(ev, true);
       }
}

void Navigation::fly	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta
	)			[protected]

Convenience method for a camera fly-through.

Definition at line 526 of file navigation.cpp.

{
       turnHead(scene, camera, cameraID, mouseDelta, false);
       zoom(scene, camera, cameraID, 1, -cruisespeed);
}

void Navigation::zoom	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		int	mouseDelta,
		float	speed
	)			[protected]

Convenience method for zooming a camera in a scene.

Definition at line 822 of file navigation.cpp.

{
       float moveY = -mouseDelta * speed;
       if (moveY)
       {
              VECTOR3 camView = camera->GetView().Normalize();
              float dist = camera->GetCenterDist();
              camera->SetCenterDist(dist - moveY);
              scene->Transform(cameraID, MATRIX::Translation(camera->GetView().Normalize() * moveY));
              scene->UpdateTransformation(cameraID);
              if (!KERNEL)
              {
                     wxCommandEvent ev = Event::GET_EVT_RENDER_UPDATE(scene->GetID());
                     PostToKernel(ev, true);
              }
       }
}

void Navigation::roll	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		int	mouseDelta,
		float	speed,
		bool	rotateAroundScenePivot
	)			[protected]

Convenience method for rolling a camera in a scene.

Definition at line 840 of file navigation.cpp.

{
       VECTOR3 position = camera->GetWorldTransMatrix()->ExtractTranslation();

       MATRIX m;

       if (rotateAroundScenePivot)
              m *= MATRIX::Translation(-scenePivot);

       m *= MATRIX::RotationAxis(camera->GetView().Normalize(), mouseDelta * speed);

       if (rotateAroundScenePivot)
              m *= MATRIX::Translation(scenePivot);

       scene->Transform(cameraID, m);
       scene->UpdateTransformation(cameraID);

       if (!rotateAroundScenePivot)
       {
              scene->TranslateAbs(cameraID, position);
              scene->UpdateTransformation(cameraID);
       }
}

void Navigation::turnHeadLeftRightWithYAlignedUpVector	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		int	mouseXDelta,
		float	speed
	)			[protected]

Convenience method for turning camera left or right around the 0,1,0 vector.

Definition at line 532 of file navigation.cpp.

{
       float angleX = mouseXDelta * rotspeed * speed;
       VECTOR3 camUp = camera->GetUp().Normalize();

       VECTOR3 position = camera->GetWorldTransMatrix()->ExtractTranslation();
       scene->TranslateAbs(cameraID, VECTOR3());
       scene->UpdateTransformation(cameraID);

       if (angleX)
       {
              scene->Transform(cameraID, MATRIX::RotationAxis(VECTOR3(0.0f, 1.0f, 0.0f), angleX));
              scene->UpdateTransformation(cameraID);
       }

       scene->TranslateAbs(cameraID, position);
       scene->UpdateTransformation(cameraID);
}

void Navigation::moveWithCollisionTesting	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const VECTOR3 &	walkDirection,
		float	speedModifier,
		float	maxStepHeight,
		float	avatarHeight
	)			[protected]

Moving around with the collision detection enabled.

Definition at line 551 of file navigation.cpp.

{
       VECTOR3 direction = walkDirection * cruisespeed * speedModifier;
       VECTOR3 directionNormalized = direction.Normalize();
       VECTOR3 cameraOrigin = camera->GetWorldTransMatrix()->ExtractTranslation();

       RayIntersectionInfo info;
       if (scene->GetBVH())
       {
              Ray forwardRay(cameraOrigin, directionNormalized);
              wxString ss;
              forwardRay.origin.y += maxStepHeight;
              if (scene->GetBVH() && scene->GetBVH()->CastRay(forwardRay, info))
              {
                     //wall in front of us
                     if (info.dist < direction.Length())
                     {
                            //we ll hit it
                            direction = directionNormalized * (info.dist - 0.001f);
                     }
              }
              vector3 tmp1(cameraOrigin + direction);
              vector3 tmp2(0.0f, -1.0f, 0.0f);
              Ray gravityRay(tmp1, tmp2);
              gravityRay.origin.y += maxStepHeight;
              if (scene->GetBVH()->CastRay(gravityRay, info))
              {
                     //there will be ground under our feet
                     const SceneNode * node = scene->GetNode(info.nodeID);
                     if (node)
                     {
                            VECTOR3 collisionPosition = gravityRay.origin + gravityRay.direction * info.dist;
                            collisionPosition.y += avatarHeight;
                            scene->TranslateAbs(cameraID, collisionPosition);
                            scene->UpdateTransformation(cameraID);
                     }
              }
              else
              {
                     //we are above an infinite void space - so we ll just float above it
                     scene->Transform(cameraID, MATRIX::Translation(direction));
                     scene->UpdateTransformation(cameraID);
              }
       }

       if (!KERNEL)
       {
              wxCommandEvent ev = Event::GET_EVT_RENDER_UPDATE(scene->GetID());
              PostToKernel(ev, true);
       }
}

void Navigation::planWalk	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier,
		float	maxStepHeight,
		float	avatarHeight
	)			[protected]

Convenience method for the Cortona plan walk.

Definition at line 603 of file navigation.cpp.

{
       //LOGDEBUG(wxT("planWalk"));

       turnHeadLeftRightWithYAlignedUpVector(scene, camera, cameraID, mouseDelta.x, speedModifier);

       VECTOR3 camUp = camera->GetUp().Normalize();
       VECTOR3 normalizedView = camera->GetView().Normalize();
       VECTOR3 pitchAxis = camUp.Cross(normalizedView);
       VECTOR3 walkDirection = VECTOR3(0.0f, 1.0f, 0.0f).Cross(pitchAxis) * mouseDelta.y;

       moveWithCollisionTesting(scene, camera, cameraID, walkDirection, speedModifier, maxStepHeight, avatarHeight);
       
}

void Navigation::panWalk	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier,
		float	maxStepHeight,
		float	avatarHeight
	)			[protected]

Convenience method for the Cortona pan walk.

Definition at line 618 of file navigation.cpp.

{
       VECTOR3 up(0.0f, 1.0f, 0.0f);
       VECTOR3 camUp = camera->GetUp().Normalize();
       VECTOR3 normalizedView = camera->GetView().Normalize();
       VECTOR3 pitchAxis = camUp.Cross(normalizedView);
       VECTOR3 walkDirection = up.Cross(pitchAxis) * mouseDelta.y;

       VECTOR3 viewAxis = normalizedView.Cross(up) * mouseDelta.x;
       walkDirection += viewAxis;

       moveWithCollisionTesting(scene, camera, cameraID, walkDirection, speedModifier, maxStepHeight, avatarHeight);
       
}

void Navigation::turnWalk	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona turn walk.

Definition at line 633 of file navigation.cpp.

{
       float angleX = mouseDelta.x * rotspeed * speedModifier;
       float angleY = -mouseDelta.y * rotspeed * speedModifier;
       VECTOR3 camUp = camera->GetUp().Normalize();
       VECTOR3 center = camera->GetCenterPoint();

       VECTOR3 position = camera->GetWorldTransMatrix()->ExtractTranslation();
       scene->TranslateAbs(cameraID, VECTOR3());
       scene->UpdateTransformation(cameraID);

       if (angleX)
       {
              scene->Transform(cameraID, MATRIX::RotationAxis(VECTOR3(0.0f, 1.0f, 0.0f), angleX));
              scene->UpdateTransformation(cameraID);
       }
       if (angleY)
       {
              scene->Transform(cameraID, MATRIX::RotationAxis(camUp.Cross(camera->GetView()).Normalize(), angleY));
              scene->UpdateTransformation(cameraID);
       }

       scene->TranslateAbs(cameraID, position);
       scene->UpdateTransformation(cameraID);

       if (!KERNEL)
       {
              wxCommandEvent ev = Event::GET_EVT_RENDER_UPDATE(scene->GetID());
              PostToKernel(ev, true);
       }
}

void Navigation::planFly	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona plan fly.

Definition at line 665 of file navigation.cpp.

{
       turnHeadLeftRightWithYAlignedUpVector(scene, camera, cameraID, mouseDelta.x, speedModifier);
       zoom(scene, camera, cameraID, mouseDelta.y, cruisespeed * speedModifier);
}

void Navigation::panFly	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona pan fly.

Definition at line 671 of file navigation.cpp.

{
       float panspeedTemp = panspeed;
       panspeed *= speedModifier;
       pan(scene, camera, cameraID, wxPoint(-mouseDelta.x, -mouseDelta.y), panspeed);
       panspeed = panspeedTemp;
}

void Navigation::turnFly	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona turn fly.

Definition at line 679 of file navigation.cpp.

{
       float rotspeedTemp = rotspeed;
       rotspeed *= speedModifier;
       turnHead(scene, camera, cameraID, mouseDelta, false);
       rotspeed = rotspeedTemp;
}

void Navigation::rollFly	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona roll fly.

Definition at line 687 of file navigation.cpp.

{
       float rotspeedTemp = rotspeed;
       rotspeed *= speedModifier;
       turnHead(scene, camera, cameraID, wxPoint(0, mouseDelta.y), false);
       rotspeed = rotspeedTemp;

       roll(scene, camera, cameraID, -mouseDelta.x, rotspeed * speedModifier, false);
}

void Navigation::planStudy	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona plan study.

Definition at line 697 of file navigation.cpp.

{
       float rotspeedTemp = rotspeed;
       rotspeed *= speedModifier;
       rotate(scene, camera, cameraID, wxPoint(), wxPoint(mouseDelta.x, 0), false, false, false);
       rotspeed = rotspeedTemp;
       zoom(scene, camera, cameraID, mouseDelta.y, cruisespeed * speedModifier);
}

void Navigation::panStudy	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona pan study.

Definition at line 706 of file navigation.cpp.

{
       float panspeedTemp = panspeed;
       panspeed *= speedModifier;
       pan(scene, camera, cameraID, wxPoint(-mouseDelta.x, -mouseDelta.y), panspeed);
       panspeed = panspeedTemp;
}

void Navigation::turnStudy	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona turn study.

Definition at line 714 of file navigation.cpp.

{
       float rotspeedTemp = rotspeed;
       rotspeed *= speedModifier;
       rotate(scene, camera, cameraID, wxPoint(), mouseDelta, false, false, false);
       rotspeed = rotspeedTemp;
}

void Navigation::rollStudy	(	Scene *	scene,
		Camera *	camera,
		const NODE_ID &	cameraID,
		const wxPoint &	mouseDelta,
		float	speedModifier
	)			[protected]

Convenience method for the Cortona roll study.

Definition at line 722 of file navigation.cpp.

{
       float rotspeedTemp = rotspeed;
       rotspeed *= speedModifier;
       rotate(scene, camera, cameraID, wxPoint(), wxPoint(0, mouseDelta.y), false, false, false);
       rotspeed = rotspeedTemp;

       roll(scene, camera, cameraID, -mouseDelta.x, rotspeed * speedModifier, false);
}

void Navigation::processNavigationOperationButtonEvent

(

)

[protected]

Executes actions of some navigation buttons which require immediate reaction (like zoom in, zoom out).

Definition at line 355 of file navigation.cpp.

{
       activeNavigationStyle->buttonEvent();
}

void Navigation::findCameras

(

SceneNodeVector &

cameras

)

[protected]

Finds all cameras in the scene.

Definition at line 166 of file navigation.cpp.

{
       if (sceneMgr)
       {
              const Scene * scene = GetSceneMgr()->GetScene(getSceneID());
              if (scene)
              {
                     std::vector<NODE_ID> nodes;
                     scene->GetNodeIDs(&nodes);
                     cameras.clear();
                     for (std::vector<NODE_ID>::iterator i = nodes.begin(); i != nodes.end(); i++)
                     {
                            const SceneNode * camNode = scene->GetNode(*i);
                            if (camNode && camNode->IsOfType(SceneNode::CAMERA))
                            {
                                   cameras.push_back(camNode);
                            }
                     }
              }
       }
}

void Navigation::setInitialScenePivot

(

)

[protected]

Sets the scene pivot as the center of the root BVH.

Definition at line 1033 of file navigation.cpp.

{
       if (sceneMgr && (getSceneID() != SCENE_ID_NONE))
       {
              const Scene * scene = GetSceneMgr()->GetScene(getSceneID());
              if (scene && scene->GetBVH())
              {
                     scenePivot = scene->GetBVH()->GetRoot()->GetBSphere()->Center;
              }
       }
}

void Navigation::removePitch

(

)

[protected]

Rotates the camera so that its pitch is zero.

This dot product can not tell us the orientation. To get it, we ll check on which side of plane (with the camView normal and d=0 ) the 0,1,0 point lies

Definition at line 1045 of file navigation.cpp.

{
       NODE_ID cameraID = getCameraID();
       Scene * scene = GetSceneMgr()->GetScene(getSceneID());
       const SceneNode * camNode = scene->GetNode(cameraID);
       Camera * camera = (Camera *)(const_cast<SceneNode *>(camNode));
       VECTOR3 camView = camera->GetView().Normalize();
       VECTOR3 camUp = camera->GetUp().Normalize();
       VECTOR3 camPosition = camera->GetWorldTransMatrix()->ExtractTranslation();
       float angle = camUp.Dot(VECTOR3(0.0f, 1.0f, 0.0f));
       if (angle<-1.0f)
              angle = -1.0f;
       if (angle>1.0f)
              angle = 1.0f;
       angle = acos(angle);
       angle = camView.Dot(VECTOR3(0.0f, 1.0f, 0.0f))>0 ? -angle : angle;
       scene->Transform(cameraID, MATRIX::RotationAxis(camUp.Cross(camView), angle));
       scene->UpdateTransformation(cameraID);
       scene->TranslateAbs(cameraID, camPosition);
       scene->UpdateTransformation(cameraID);
}

void Navigation::alignView

(

ViewName

name

)

[protected]

Aligns the camera to the world axis.

Definition at line 1070 of file navigation.cpp.

{
       NODE_ID cameraID = getCameraID();
       Scene * scene = GetSceneMgr()->GetScene(getSceneID());
       if (!scene)
              return;

       const SceneNode * camNode = scene->GetNode(cameraID);
       if (!camNode || !camNode->IsOfType(SceneNode::CAMERA))
              return;

       Camera * camera = (Camera *)(const_cast<SceneNode *>(camNode));
       WriteLocker camLock(*camera);

       MATRIX m;

       switch(name)
       {
       case SIDE:
              m *= MATRIX::RotationY(M_PI_2);
              break;
       case TOP:
              m *= MATRIX::RotationX(M_PI_2);
              break;
       case REAR:
              m *= MATRIX::RotationY(M_PI);
              break;
       };

       scene->SetTransformation(cameraID, m);
       scene->UpdateTransformation(cameraID);
       scene->Fit(cameraID);
}

void Navigation::processEvent

(

wxCommandEvent &

evt

)

[protected, virtual]

Process event - CameraModule overload.

Try to sync with kernel so no redundant param updates occur

Reimplemented from VRUT::CameraModule.

Definition at line 236 of file navigation.cpp.

{
       CameraModule::processEvent(evt);
       bool updateCamParams = false;
       switch (evt.GetEventType())
       {
       case Event::EVT_SCENE_CAM_PROJECTION_CHANGED:
              updateCamParams = ((evt.GetId() == int(getSceneID())) && (evt.GetInt() == int(getCameraID())) && !fovChangeOperationStarted);
              break;
       case Event::EVT_PARAM_SET:
              {
                     Parameter::ParameterIdentificator fromEventIdentificator = Parameter::ParameterIdentificator::FromEvent(evt);
                     if (fromEventIdentificator == nodeIDParamID)
                     {
                            updateCamParams = true;     
                     }
                     else
                     {
                            wxString selectedNavigationStyleString;
                            UPDATE_PARAM_FROM_EVENT_STRING(navigationStyleParamID, selectedNavigationStyleString, evt);

                            if (fromEventIdentificator == navigationStyleParamID)
                            {
                                   NavigationStyleInterface *newStyle = resolveStyleFromString(selectedNavigationStyleString);
                                   if (newStyle != activeNavigationStyle)
                                   {
                                          activeNavigationStyle = newStyle;
                                          refreshGUI();
                                   }
                            }

                            activeNavigationStyle->getAndFixButtonValues(evt);

                            UPDATE_PARAM_FROM_EVENT_FLOAT(rotspeedParamID, rotspeed, evt);
                            UPDATE_PARAM_FROM_EVENT_FLOAT(zoomspeedParamID, zoomspeed, evt);
                            UPDATE_PARAM_FROM_EVENT_FLOAT(cruisespeedParamID, cruisespeed, evt);
                            UPDATE_PARAM_FROM_EVENT_FLOAT(panspeedParamID, panspeed, evt);
                            float cameraCenterDistance = 0.0f;
                            UPDATE_PARAM_FROM_EVENT_FLOAT(cameraCenterDistanceParamID, cameraCenterDistance, evt);
                            UPDATE_PARAM_FROM_EVENT_FLOAT(fovParamID, fov, evt);
                            UPDATE_PARAM_FROM_EVENT_FLOAT(nearPlaneParamID, nearPlane, evt);
                            UPDATE_PARAM_FROM_EVENT_FLOAT(farPlaneParamID, farPlane, evt);

                            activeNavigationStyle->updateParams(evt);

                            if (fromEventIdentificator == sceneIDParamID) //Scene is assigned
                            {
                                   refreshGUI();
                                   scenePivotWasSet = false;
                            }

                            if (fromEventIdentificator == selectedCameraParamID)
                            {
                                   wxString selectedCamera;
                                   UPDATE_PARAM_FROM_EVENT_STRING(selectedCameraParamID, selectedCamera, evt);
                                   for (SceneNodeVector::iterator i = cameras.begin(); i != cameras.end(); i++)
                                   {
                                          if ((*i)->GetName() == selectedCamera)
                                          {
                                                 wxCommandEvent ev = Event::GET_EVT_PARAM_SET_DO(nodeIDParamID, wxString::Format(wxT("%i"), (*i)->GetID()));
                                                 PostToKernel(ev);
                                          }
                                   }
                            }

                            processNavigationOperationButtonEvent();

                            if ( (fov || nearPlane || farPlane)
                                          && (getSceneID() != SCENE_ID_NONE)
                                          && (getCameraID() != NODE_ID_NONE) )
                            {
                                   wxCommandEvent camEvt = Event::GET_EVT_SCENE_CAM_PROJECTION_SET(getSceneID(), getCameraID(), 0, 0, nearPlane, farPlane, fov);
                                   PostToKernel(camEvt, true);
                                   WaitForEvent(Event::EVT_SCENE_CAM_PROJECTION_CHANGED, 100, int(getSceneID()), int(getCameraID()));
                            }
                            if (fromEventIdentificator == cameraCenterDistanceParamID)
                            {
                                   Scene * scene = GetSceneMgr()->GetScene(getSceneID());
                                   if (scene)
                                   {
                                          NODE_ID cameraID = getCameraID();
                                          const SceneNode * camNode = scene->GetNode(cameraID);
                                          if (camNode && camNode->IsOfType(SceneNode::CAMERA))
                                          {
                                                 Camera * camera = (Camera *)(const_cast<SceneNode *>(camNode));
                                                 WriteLocker camLock(*camera);
                                                 camera->SetCenterDist(cameraCenterDistance);
                                          }
                                   }
                            }
                     }
              }
              break;
       default:
              break;
       }
       if (updateCamParams)
       {
              const Scene * scene = GetSceneMgr()->GetScene(getSceneID());
              if (scene)
              {
                     const SceneNode * camNode = scene->GetNode(getCameraID());
                     if (camNode && camNode->IsOfType(SceneNode::CAMERA))
                     {
                            ReadLocker rLock(*camNode);
                            wxCommandEvent ev1 = Event::GET_EVT_PARAM_SET_DO(fovParamID, wxString::Format(wxT("%g"), ((Camera *)camNode)->GetFOV()));
                            PostToKernel(ev1);
                            wxCommandEvent ev2 = Event::GET_EVT_PARAM_SET_DO(nearPlaneParamID, wxString::Format(wxT("%g"), ((Camera *)camNode)->GetNearPlane()));
                            PostToKernel(ev2);
                            wxCommandEvent ev3 = Event::GET_EVT_PARAM_SET_DO(farPlaneParamID, wxString::Format(wxT("%g"), ((Camera *)camNode)->GetFarPlane()));
                            PostToKernel(ev3);
                            wxCommandEvent ev4 = Event::GET_EVT_PARAM_SET_DO(cameraCenterDistanceParamID, wxString::Format(wxT("%g"), ((Camera *)camNode)->GetCenterDist()));
                            PostToKernel(ev4);
                     }
              }
       }
}

void Navigation::processKeyEvent

(

wxKeyEvent &

evt

)

[protected, virtual]

Process key event - CameraModule overload.

Implements VRUT::ManipulatorModule.

Definition at line 864 of file navigation.cpp.

{
#ifdef EVENT_DEBUG
       LOGERROR(wxT("<Navigation>Received key event"));
#endif
       activeNavigationStyle->keyStyle(evt);
}

void Navigation::processMouseEvent

(

wxMouseEvent &

evt

)

[protected, virtual]

Process mouse event - CameraModule overload.

Implements VRUT::ManipulatorModule.

Definition at line 873 of file navigation.cpp.

{
       if (int(windowID) != evt.GetId())
              return;

       NODE_ID cameraID = getCameraID();
       Scene * scene = GetSceneMgr()->GetScene(getSceneID());
       if (!scene)
              return;

       const SceneNode * camNode = scene->GetNode(cameraID);
       if (!camNode || !camNode->IsOfType(SceneNode::CAMERA))
              return;

       Camera * camera = (Camera *)(const_cast<SceneNode *>(camNode));
       WriteLocker camLock(*camera);

       scene->UpdateTransformation(cameraID);

       activeNavigationStyle->mouseStyle(evt);
}

void Navigation::run

(

)

[protected, virtual]

The run method for this module. Used for the fly-throughs.

Reimplemented from VRUT::Module.

Definition at line 895 of file navigation.cpp.

{
       if (navigationStyleCATIASpecific.fly)
       {
              wxMilliSleep(10);  //10ms is a compromise between an interactive frame rate and a low cpu load

              NODE_ID cameraID = getCameraID();
              Scene * scene = GetSceneMgr()->GetScene(getSceneID());
              if (!scene)
                     return;

              const SceneNode * camNode = scene->GetNode(cameraID);
              if (!camNode || !camNode->IsOfType(SceneNode::CAMERA))
                     return;

              Camera * camera = (Camera *)(const_cast<SceneNode *>(camNode));
              WriteLocker camLock(*camera);
              scene->UpdateTransformation(cameraID);

              fly(scene, camera, cameraID, mouseDelta);
              mouseDelta = wxPoint(0, 0);
       }

       if (navigationStyleCortonaSpecific.operationStarted)
       {
              wxMilliSleep(10);

              NODE_ID cameraID = getCameraID();
              Scene * scene = GetSceneMgr()->GetScene(getSceneID());
              if (!scene)
                     return;

              const SceneNode * camNode = scene->GetNode(cameraID);
              if (!camNode || !camNode->IsOfType(SceneNode::CAMERA))
                     return;

              Camera * camera = (Camera *)(const_cast<SceneNode *>(camNode));
              WriteLocker camLock(*camera);
              scene->UpdateTransformation(cameraID);

              int cortonaWalk = navigationStyleCortonaSpecific.walkButtonIter->paramValue;
              int cortonaFly = navigationStyleCortonaSpecific.flyButtonIter->paramValue;
              int cortonaStudy = navigationStyleCortonaSpecific.studyButtonIter->paramValue;

              if (navigationStyleCortonaSpecific.planWalkButtonIter->paramValue && cortonaWalk)
              {
                     planWalk(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation, navigationStyleCortonaSpecific.maxStepHeight, navigationStyleCortonaSpecific.avatarHeight);
              }
              else if (navigationStyleCortonaSpecific.panWalkButtonIter->paramValue && cortonaWalk)
              {
                     panWalk(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation, navigationStyleCortonaSpecific.maxStepHeight, navigationStyleCortonaSpecific.avatarHeight);
              }
              else if (navigationStyleCortonaSpecific.turnWalkButtonIter->paramValue && cortonaWalk)
              {
                     turnWalk(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              
              if (navigationStyleCortonaSpecific.planFlyButtonIter->paramValue && cortonaFly)
              {
                     planFly(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              else if (navigationStyleCortonaSpecific.panFlyButtonIter->paramValue && cortonaFly)
              {
                     panFly(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              else if (navigationStyleCortonaSpecific.turnFlyButtonIter->paramValue && cortonaFly)
              {
                     turnFly(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              else if (navigationStyleCortonaSpecific.rollFlyButtonIter->paramValue && cortonaFly)
              {
                     rollFly(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }

              if (navigationStyleCortonaSpecific.planStudyButtonIter->paramValue && cortonaStudy)
              {
                     planStudy(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              else if (navigationStyleCortonaSpecific.panStudyButtonIter->paramValue && cortonaStudy)
              {
                     panStudy(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              else if (navigationStyleCortonaSpecific.turnStudyButtonIter->paramValue && cortonaStudy)
              {
                     turnStudy(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
              else if (navigationStyleCortonaSpecific.rollStudyButtonIter->paramValue && cortonaStudy)
              {
                     rollStudy(scene, camera, cameraID, mouseDelta, navigationStyleCortonaSpecific.speedCompensation);
              }
       }

       if (navigationStyleCortonaSpecific.altDown || navigationStyleCortonaSpecific.spaceDown)
       {
              int cortonaWalk = navigationStyleCortonaSpecific.walkButtonIter->paramValue;
              int cortonaFly = navigationStyleCortonaSpecific.flyButtonIter->paramValue;
              int cortonaStudy = navigationStyleCortonaSpecific.studyButtonIter->paramValue;

              if (cortonaWalk)
              {
                     //LOGDEBUG(wxT("walk"));
                     clearButtonValues(navigationStyleCortonaSpecific.walkButtonsInfo);
                     if (navigationStyleCortonaSpecific.altDown && navigationStyleCortonaSpecific.spaceDown)
                            navigationStyleCortonaSpecific.turnWalkButtonIter->paramValue = 1;
                     else if (navigationStyleCortonaSpecific.altDown)
                            navigationStyleCortonaSpecific.panWalkButtonIter->paramValue = 1;
                     else if (navigationStyleCortonaSpecific.spaceDown)
                            //LOGDEBUG(wxT("space"));
                            navigationStyleCortonaSpecific.turnWalkButtonIter->paramValue = 1;
              }
              if (cortonaFly)
              {
                     clearButtonValues(navigationStyleCortonaSpecific.flyButtonsInfo);
                     if (navigationStyleCortonaSpecific.altDown && navigationStyleCortonaSpecific.spaceDown)
                            navigationStyleCortonaSpecific.rollFlyButtonIter->paramValue = 1;
                     else if (navigationStyleCortonaSpecific.altDown)
                            navigationStyleCortonaSpecific.panFlyButtonIter->paramValue = 1;
                     else if (navigationStyleCortonaSpecific.spaceDown)
                            navigationStyleCortonaSpecific.turnFlyButtonIter->paramValue = 1;
              }
              if (cortonaStudy)
              {
                     clearButtonValues(navigationStyleCortonaSpecific.studyButtonsInfo);
                     if (navigationStyleCortonaSpecific.altDown && navigationStyleCortonaSpecific.spaceDown)
                            navigationStyleCortonaSpecific.rollStudyButtonIter->paramValue = 1;
                     else if (navigationStyleCortonaSpecific.altDown)
                            navigationStyleCortonaSpecific.panStudyButtonIter->paramValue = 1;
                     else if (navigationStyleCortonaSpecific.spaceDown)
                            navigationStyleCortonaSpecific.planStudyButtonIter->paramValue = 1;
              }
       }
       if (!scenePivotWasSet) //When the sceneID changes in the processEvent, the BVH does not exist yet, so i keep checking here
       {
              setInitialScenePivot();
              scenePivotWasSet = true;
       }
}

wxString Navigation::GetDesc

(

)

const [virtual]

Get module description - Module overload.

Implements VRUT::Module.

Definition at line 1106 of file navigation.cpp.

{
       return wxT("Process input events and manipulate associated camera");
}

---

Member Data Documentation

wxString VRUT::Navigation::defaultMouseEventTimeout [private]

Definition at line 29 of file navigation.h.

NavigationStyleVector VRUT::Navigation::navigationStyleDefinition [protected]

Vector of supported navigation styles.

Definition at line 65 of file navigation.h.

SceneNodeVector VRUT::Navigation::cameras [protected]

Vector of scene cameras.

Definition at line 67 of file navigation.h.

wxArrayString VRUT::Navigation::navigationStyleString [protected]

Navigation style strings.

Definition at line 69 of file navigation.h.

wxArrayString VRUT::Navigation::cameraString [protected]

Scene camera names.

Definition at line 71 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::navigationStyleParamID [protected]

navigationStyle param identificator

Definition at line 73 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::selectedCameraParamID [protected]

selectedCamera param identificator

Definition at line 75 of file navigation.h.

wxPoint VRUT::Navigation::lastPos [protected]

Last mouse position.

Definition at line 77 of file navigation.h.

wxPoint VRUT::Navigation::mouseDelta [protected]

Mouse coordinate difference between the current frame and the last frame.

Definition at line 79 of file navigation.h.

VECTOR3 VRUT::Navigation::scenePivot [protected]

Scene pivot.

Definition at line 83 of file navigation.h.

bool VRUT::Navigation::scenePivotWasSet [protected]

Scene pivot was set.

Definition at line 85 of file navigation.h.

NODE_ID VRUT::Navigation::selectedObject [protected]

Definition at line 466 of file navigation.h.

NavigationStyleInterface* VRUT::Navigation::activeNavigationStyle [protected]

Pointer to the active navigation style.

Definition at line 468 of file navigation.h.

NavigationStyleCameraManipulatorSpecific VRUT::Navigation::navigationStyleCameraManipulatorSpecific [protected]

CameraManipulator specific variables needed for a proper emulation.

Definition at line 470 of file navigation.h.

NavigationStyleCATIASpecific VRUT::Navigation::navigationStyleCATIASpecific [protected]

CATIA specific variables needed for a proper emulation.

Definition at line 472 of file navigation.h.

NavigationStyleCortonaSpecific VRUT::Navigation::navigationStyleCortonaSpecific [protected]

Cortona specific variables needed for a proper emulation.

Definition at line 474 of file navigation.h.

NavigationStyleCinema4DSpecific VRUT::Navigation::navigationStyleCinema4DSpecific [protected]

Cinema4D specific variables needed for a proper emulation.

Definition at line 476 of file navigation.h.

NavigationStyleMayaSpecific VRUT::Navigation::navigationStyleMayaSpecific [protected]

Maya specific variables needed for a proper emulation.

Definition at line 478 of file navigation.h.

NavigationStyleDeltaViewSpecific VRUT::Navigation::navigationStyleDeltaViewSpecific [protected]

DeltaView specific variables needed for a proper emulation.

Definition at line 480 of file navigation.h.

NavigationStyleICEMSurfSpecific VRUT::Navigation::navigationStyleICEMSurfSpecific [protected]

Icem Surf specific variables needed for a proper emulation.

Definition at line 482 of file navigation.h.

NavigationStyleVD2Specific VRUT::Navigation::navigationStyleVD2Specific [protected]

Virtual Design 2 specific variables needed for a proper emulation.

Definition at line 484 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::cameraCenterDistanceParamID [protected]

Camera center distance param identificator

Definition at line 486 of file navigation.h.

bool VRUT::Navigation::fovChangeOperationStarted [protected]

We set the fov param id only when the user releases the mouse button. This variable helps us know when this happens.

Definition at line 488 of file navigation.h.

float VRUT::Navigation::nearPlane [protected]

Camera near plane.

Definition at line 490 of file navigation.h.

float VRUT::Navigation::farPlane [protected]

Camera far plane.

Definition at line 492 of file navigation.h.

float VRUT::Navigation::fov [protected]

Field of view.

Definition at line 494 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::fovParamID [protected]

fov param identificator

Definition at line 496 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::farPlaneParamID [protected]

farPlane param identificator

Definition at line 498 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::nearPlaneParamID [protected]

nearPlane param identificator

Definition at line 500 of file navigation.h.

float VRUT::Navigation::rotspeed [protected]

Rotate sensitivity coef.

Definition at line 502 of file navigation.h.

float VRUT::Navigation::zoomStep [protected]

Zoom step.

Definition at line 504 of file navigation.h.

float VRUT::Navigation::flySpeedStep [protected]

Fly speed step.

Definition at line 506 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::rotspeedParamID [protected]

rotspeed param identificator

Definition at line 508 of file navigation.h.

float VRUT::Navigation::zoomspeed [protected]

Zoom sensitivity coef.

Definition at line 510 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::zoomspeedParamID [protected]

zoomspeed param identificator

Definition at line 512 of file navigation.h.

float VRUT::Navigation::cruisespeed [protected]

Cruise sensitivity coef.

Definition at line 514 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::cruisespeedParamID [protected]

cruisespeed param identificator

Definition at line 516 of file navigation.h.

float VRUT::Navigation::panspeed [protected]

Navigation speed coef for pan.

Definition at line 518 of file navigation.h.

Parameter::ParameterIdentificator VRUT::Navigation::panspeedParamID [protected]

panspeed param identificator

Definition at line 520 of file navigation.h.

---

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

• /cygdrive/d/src/svn/vrut/trunk/modules/navigation/navigation.h
• /cygdrive/d/src/svn/vrut/trunk/modules/navigation/navigation.cpp