IAutonavigateAdaptor Struct Reference

Inheritance diagram for IAutonavigateAdaptor:

Public Member Functions
virtual signed int	GetNudgeable (signed int *pVal)=0
virtual signed int	GetSpeed (double *pVal)=0
virtual signed int	SetNudgeable (const signed int val)=0
virtual signed int	SetSpeed (const double val)=0
Public Member Functions inherited from IMouseAdaptor
virtual signed int	AskInterface (const BGUID *piid, IRoot **ppr)=0
virtual signed int	DecRef ()=0
virtual signed int	IncRef ()=0
virtual signed int	MouseClicked (signed int x, signed int y)=0
virtual signed int	MouseDragged (signed int x, signed int y)=0
virtual signed int	MouseEntered (signed int x, signed int y)=0
virtual signed int	MouseExited (signed int x, signed int y)=0
virtual signed int	MouseManuallyMoved (signed int offsetX, signed int offsetY)=0
virtual signed int	MouseMoved (signed int x, signed int y)=0
virtual signed int	MousePressed (signed int x, signed int y)=0
virtual signed int	MouseReleased (signed int x, signed int y)=0
virtual signed int	SetRenderParamsReciever (IRenderParamsReceiver *pReceiver)=0
Public Member Functions inherited from IRoot
template<class T >
signed int	AskInterface (T **pp)

Detailed Description

Adaptor for autonavigating via mouse interaction. When the mouse button is pressed, the adaptor will autonaviate at the specified speed until the mouse button is released. Use ILibrary::CreateObject() to create this object.

Listens to: MousePressed(), MouseDragged(), MouseReleased()

Member Function Documentation

virtual signed int IAutonavigateAdaptor::GetNudgeable ( signed int *  pVal )

pure virtual

Gets the state of the autonavigation adaptor's nudgeable feature. As the camera moves along a vessel during autonavigation it may encounter branches in the vessel, making the direction of further of navigation ambiguous. If the Nudgeable value is set to H_TRUE the user can 'nudge' the autonavigation towards the desired direction by offsetting the mouse towards the channel the user desires to navigate into. If the Nudgable value is set to H_FALSE the autonavigation algorithm will determine on its own which direction to go.

Parameters

pVal	A pointer to a h_boolean value that will store the state of the nudgeable feature.

virtual signed int IAutonavigateAdaptor::GetSpeed ( double *  pVal )

pure virtual

Returns the current speed value into pVal.

virtual signed int IAutonavigateAdaptor::SetNudgeable ( const signed int  val )

pure virtual

Sets whether the camera is 'nudgable'. As the camera moves along a vessel during autonavigation it may encounter branches in the vessel, making the direction of further of navigation ambiguous. If the Nudgeable value is set to H_TRUE the user can 'nudge' the autonavigation towards the desired direction by offsetting the mouse towards the channel the user desires to navigate into. If the Nudgable value is set to H_FALSE the autonavigation algorithm will determine on its own which direction to go.

Parameters

val	Set to either H_TRUE or H_FALSE to turn the nudgeable feature on or off.

virtual signed int IAutonavigateAdaptor::SetSpeed ( const double  val )

pure virtual

Sets the current speed value. The default is 1.0 and it is a simple multiplier coefficient for speed. However, it should be noted that the speed will automatically adjust based upon the size of the tunnel you are travelling down. For example, a small vessel will be autonavigated at a slower overall speed than the large intestine.

Parameters

val	The speed of autonavigation (default = 1.0)