This class defines if and how the camera of the associated window is currently being controlled with the mouse. More...

Public Types
enum	StateT { NOT_ACTIVE, ACTIVE_NORMAL, ACTIVE_ORBIT }

Public Member Functions
	MouseControlT (Generic3DWindowT &Win)

void	Activate (StateT NewState, const wxPoint &RefPt=wxDefaultPosition)
	Activates the mouse control in the given state. More...

void	Deactivate ()
	Deactivates the mouse control. More...

StateT	GetState () const
	Returns the state that the mouse control is currently in. More...

bool	IsActive () const
	Returns whether the mouse control is active; a shortcut for GetState()!=NOT_ACTIVE. More...

const wxPoint &	GetRefPtWin () const
	Return the position of the reference point in window coordinates as set when the mouse control was activated. More...

const Vector3fT &	GetRefPtWorld () const
	Return the position of the reference point in world coordinates as set when the mouse control was activated. More...

Detailed Description

This class defines if and how the camera of the associated window is currently being controlled with the mouse.

Member Function Documentation

void Generic3DWindowT::MouseControlT::Activate	(	StateT	NewState,
		const wxPoint &	RefPt = `wxDefaultPosition`
	)

Activates the mouse control in the given state.

Parameters

NewState	The state in which the mouse control should be activated.
RefPt	The position of the reference point in window coordinates. Note that if the mouse control is already active, it can not be reactivated in a different ACTIVE_* state but must be deactivated first.

void Generic3DWindowT::MouseControlT::Deactivate ( )

Deactivates the mouse control.

const wxPoint& Generic3DWindowT::MouseControlT::GetRefPtWin ( ) const

inline

Return the position of the reference point in window coordinates as set when the mouse control was activated.

const Vector3fT& Generic3DWindowT::MouseControlT::GetRefPtWorld ( ) const

inline

Return the position of the reference point in world coordinates as set when the mouse control was activated.

StateT Generic3DWindowT::MouseControlT::GetState ( ) const

inline

Returns the state that the mouse control is currently in.

bool Generic3DWindowT::MouseControlT::IsActive ( ) const

inline

Returns whether the mouse control is active; a shortcut for GetState()!=NOT_ACTIVE.

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