Fovia's C++ Client/Server API
Public Member Functions | List of all members
ICPRotateAdaptor Struct Referenceabstract
Inheritance diagram for ICPRotateAdaptor:
IMouseAdaptor IRoot

Public Member Functions

virtual signed int GetCenterPoint (VECTOR3D *pVal)=0
 
virtual signed int GetInvertInPerspective (signed int *pVal)=0
 
virtual signed int GetMoveOffsetInPerspective (signed int *pVal)=0
 
virtual signed int GetSensitivity (double *pVal)=0
 
virtual signed int SetCenterPoint (const VECTOR3D val)=0
 
virtual signed int SetInvertInPerspective (const signed int val)=0
 
virtual signed int SetMoveOffsetInPerspective (const signed int val)=0
 
virtual signed int SetSensitivity (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 rotating around a volume point in the volume via mouse interaction. Use ILibrary::CreateObject() to create this object.

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

Member Function Documentation

virtual signed int ICPRotateAdaptor::GetCenterPoint ( VECTOR3D pVal)
pure virtual

Gets the current center point for rotation and puts it in the variable stored at address pVal. The default value for the center point is (0,0,0) or the center of the dataset.

Parameters
pValThe address of the variable to get the center point.
virtual signed int ICPRotateAdaptor::GetInvertInPerspective ( signed int *  pVal)
pure virtual

Gets whether or not up/down should be inverted in perspective rendering and puts it in the variable stored at address pVal. The default value for this field is H_FALSE.

Parameters
pValThe address of the variable to get whether or not up/down should be inverted in perspective rendering.
virtual signed int ICPRotateAdaptor::GetMoveOffsetInPerspective ( signed int *  pVal)
pure virtual

Gets the MoveOffsetInPerspective field and puts it in the variable at address pVal. If the field is H_TRUE, just the orientation affected rather than moving the eye point in perspective rendering. Otherwise, the eyepoint is affected as well. The default value is H_FALSE.

Parameters
pValThe address of the variable to get the field's value.
virtual signed int ICPRotateAdaptor::GetSensitivity ( double *  pVal)
pure virtual

Gets the Sensitivity field and puts it in the variable at address pVal. The default value is 1.0 and will affect the rotation speed linearly.

Parameters
pValThe address of the variable to get the field's value.
virtual signed int ICPRotateAdaptor::SetCenterPoint ( const VECTOR3D  val)
pure virtual

Sets the center point for rotation to the location val. The default value for the center point is (0,0,0) or the center of the dataset.

Parameters
valThe new center point for rotation.
virtual signed int ICPRotateAdaptor::SetInvertInPerspective ( const signed int  val)
pure virtual

Sets whether or not up/down should be inverted in perspective rendering to the value val. The default value for this field is H_FALSE.

Parameters
valH_TRUE if up/down should be inverted in perspective, H_FALSE otherwise.
virtual signed int ICPRotateAdaptor::SetMoveOffsetInPerspective ( const signed int  val)
pure virtual

Sets the MoveOffsetInPerspective field to val. If the field is H_TRUE, just the orientation affected rather than moving the eye point in perspective rendering. Otherwise, the eyepoint is affected as well. The default value is H_FALSE.

Parameters
valThe new MoveOffsetInPerspective value.
virtual signed int ICPRotateAdaptor::SetSensitivity ( const double  val)
pure virtual

Sets the Sensitivity field to val. The default value is 1.0 and will affect the rotation speed linearly. The mathematical relationship between the number of radians to rotate per pixel and the sensitivity is as follows:

sensitivity = radiansPerPixel * 300.0;
Parameters
valThe new Sensitivity value.