Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkInteractorStyleFlight Class Reference

provides flight motion routines. More...

#include <vtkInteractorStyleFlight.h>

Inheritance diagram for vtkInteractorStyleFlight:

Inheritance graph
[legend]
Collaboration diagram for vtkInteractorStyleFlight:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void OnRightButtonDown (int ctrl, int shift, int X, int Y)
virtual void OnRightButtonUp (int ctrl, int shift, int X, int Y)
virtual void OnMiddleButtonDown (int ctrl, int shift, int X, int Y)
virtual void OnMiddleButtonUp (int ctrl, int shift, int X, int Y)
virtual void OnLeftButtonDown (int ctrl, int shift, int X, int Y)
virtual void OnLeftButtonUp (int ctrl, int shift, int X, int Y)
virtual void OnMouseMove (int ctrl, int shift, int X, int Y)
virtual void OnChar (int ctrl, int shift, char keycode, int repeatcount)
virtual void OnKeyDown (int ctrl, int shift, char keycode, int repeatcount)
virtual void OnKeyUp (int ctrl, int shift, char keycode, int repeatcount)
virtual void OnTimer (void)
void JumpTo (double campos[3], double focpos[3])
void PerformAzimuthalScan (int numsteps)
virtual void SetMotionStepSize (double)
virtual double GetMotionStepSize ()
virtual void SetMotionAccelerationFactor (double)
virtual double GetMotionAccelerationFactor ()
virtual void SetAngleStepSize (double)
virtual double GetAngleStepSize ()
virtual void SetAngleAccelerationFactor (double)
virtual double GetAngleAccelerationFactor ()
virtual void SetDisableMotion (int)
virtual int GetDisableMotion ()
virtual void DisableMotionOn ()
virtual void DisableMotionOff ()
virtual void SetFixUpVector (int)
virtual int GetFixUpVector ()
virtual void FixUpVectorOn ()
virtual void FixUpVectorOff ()
virtual double * GetFixedUpVector ()
virtual void GetFixedUpVector (double data[3])
virtual void SetFixedUpVector (double data[])

Static Public Methods

vtkInteractorStyleFlight * New ()
int IsTypeOf (const char *type)
vtkInteractorStyleFlight * SafeDownCast (vtkObject *o)

Protected Methods

 vtkInteractorStyleFlight ()
 ~vtkInteractorStyleFlight ()
 vtkInteractorStyleFlight (const vtkInteractorStyleFlight &)
void operator= (const vtkInteractorStyleFlight &)
void DoTimerStart (void)
void DoTimerStop (void)
void UpdateMouseSteering (int x, int y)
void FlyByMouse (void)
void FlyByKey (void)
void ComputeLRVector (double vector[3])
void MotionAlongVector (double vector[3], double amount)
void SetupMotionVars (void)
void AzimuthScan (void)

Protected Attributes

unsigned char KeysDown
int Flying
int Reversing
int TimerRunning
int AzimuthScanning
int DisableMotion
int FixUpVector
double OldX
double OldY
double X2
double Y2
double DiagonalLength
double MotionStepSize
double MotionUserScale
double MotionAccelerationFactor
double AngleStepSize
double AngleAccelerationFactor
double YawAngle
double PitchAngle
double FixedUpVector [3]
double AzimuthStepSize

Detailed Description

provides flight motion routines.

Date:
2000/12/10 20:08:40
Revision:
1.8
Thanks:
Thanks to John Biddiscombe of the Rutherford Appleton Laboratory who developed this class.
Left mouse button press produces forward motion. Right mouse button press produces reverse motion. Moving mouse during motion steers user in desired direction. Keyboard controls are: Left/Right/Up/Down Arrows for steering direction 'A' forward, 'Z' reverse motion Ctrl Key causes sidestep instead of steering in mouse and key modes Shift key is accelerator in mouse and key modes Ctrl and Shift together causes Roll in mouse and key modes

Stationary 'look' can be achieved by holding both mouse buttons down and steering with the mouse. Stationary 'look' can also be achieved by holding 'Z' (or 'A') and steering with mouse in forward (or reverse) motion mode. By default, one "step" of motion corresponds to 1/250th of the diagonal of bounding box of visible actors, '+' and '-' keys allow user to increase or decrease step size.

Definition at line 75 of file vtkInteractorStyleFlight.h.

Constructor & Destructor Documentation

vtkInteractorStyleFlight::vtkInteractorStyleFlight (    )  [protected]
 

vtkInteractorStyleFlight::~vtkInteractorStyleFlight (    )  [protected]
 

vtkInteractorStyleFlight::vtkInteractorStyleFlight (  const vtkInteractorStyleFlight &    )  [inline, protected]
 

Definition at line 143 of file vtkInteractorStyleFlight.h.

Member Function Documentation

vtkInteractorStyleFlight* vtkInteractorStyleFlight::New (    )  [static]
 

This class must be supplied with a vtkRenderWindowInteractor wrapper or parent. This class should not normally be instantiated by application programmers.

Reimplemented from vtkInteractorStyle.

virtual const char* vtkInteractorStyleFlight::GetClassName (    )  [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

int vtkInteractorStyleFlight::IsTypeOf (  const char *    type )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

virtual int vtkInteractorStyleFlight::IsA (  const char *    type )  [virtual]
 

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

vtkInteractorStyleFlight* vtkInteractorStyleFlight::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleFlight::PrintSelf (  ostream &    os,
vtkIndent    indent
)  [virtual]
 

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnRightButtonDown (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Concrete implementation of Mouse event bindings for flight

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnRightButtonUp (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnMiddleButtonDown (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnMiddleButtonUp (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnLeftButtonDown (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnLeftButtonUp (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnMouseMove (  int    ctrl,
int    shift,
int    X,
int    Y
)  [virtual]
 

Generic event bindings must be overridden in subclasses

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnChar (  int    ctrl,
int    shift,
char    keycode,
int    repeatcount
)  [virtual]
 

Concrete implementation of Keyboard event bindings for flight

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnKeyDown (  int    ctrl,
int    shift,
char    keycode,
int    repeatcount
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnKeyUp (  int    ctrl,
int    shift,
char    keycode,
int    repeatcount
)  [virtual]
 

Reimplemented from vtkInteractorStyle.

virtual void vtkInteractorStyleFlight::OnTimer (  void    )  [virtual]
 

Mouse and key events set correct motion states, OnTimer performs the motion

Reimplemented from vtkInteractorStyle.

void vtkInteractorStyleFlight::JumpTo (  double    campos[3],
double    focpos[3]
) 
 

Move the Eye/Camera to a specific location (no intermediate steps are taken

void vtkInteractorStyleFlight::PerformAzimuthalScan (  int    numsteps ) 
 

rotate the camera round z axis by 360 degrees for viewing scene this routine starts a timer and disables key/mouse events preventing user interaction until finished (not fully implemented yet) the number of steps can be supplied.

virtual void vtkInteractorStyleFlight::SetMotionStepSize (  double    )  [virtual]
 

Set the basic unit step size : by default 1/250 of bounding diagonal

virtual double vtkInteractorStyleFlight::GetMotionStepSize (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::SetMotionAccelerationFactor (  double    )  [virtual]
 

Set acceleration factor when shift key is applied : default 10

virtual double vtkInteractorStyleFlight::GetMotionAccelerationFactor (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::SetAngleStepSize (  double    )  [virtual]
 

Set the basic angular unit for turning : default 1 degree

virtual double vtkInteractorStyleFlight::GetAngleStepSize (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::SetAngleAccelerationFactor (  double    )  [virtual]
 

Set angular acceleration when shift key is applied : default 5

virtual double vtkInteractorStyleFlight::GetAngleAccelerationFactor (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::SetDisableMotion (  int    )  [virtual]
 

Disable motion (temporarily - for viewing etc)

virtual int vtkInteractorStyleFlight::GetDisableMotion (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::DisableMotionOn (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::DisableMotionOff (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::SetFixUpVector (  int    )  [virtual]
 

Fix the "up" vector: also use FixedUpVector

virtual int vtkInteractorStyleFlight::GetFixUpVector (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::FixUpVectorOn (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::FixUpVectorOff (    )  [virtual]
 

virtual double* vtkInteractorStyleFlight::GetFixedUpVector (    )  [virtual]
 

virtual void vtkInteractorStyleFlight::GetFixedUpVector (  double    data[3] )  [virtual]
 

virtual void vtkInteractorStyleFlight::SetFixedUpVector (  double    data[] )  [virtual]
 

void vtkInteractorStyleFlight::operator= (  const vtkInteractorStyleFlight &    )  [inline, protected]
 

Definition at line 144 of file vtkInteractorStyleFlight.h.

void vtkInteractorStyleFlight::DoTimerStart (  void    )  [protected]
 

Routines used internally for computing motion and steering

void vtkInteractorStyleFlight::DoTimerStop (  void    )  [protected]
 

void vtkInteractorStyleFlight::UpdateMouseSteering (  int    x,
int    y
)  [protected]
 

void vtkInteractorStyleFlight::FlyByMouse (  void    )  [protected]
 

void vtkInteractorStyleFlight::FlyByKey (  void    )  [protected]
 

void vtkInteractorStyleFlight::ComputeLRVector (  double    vector[3] )  [protected]
 

void vtkInteractorStyleFlight::MotionAlongVector (  double    vector[3],
double    amount
)  [protected]
 

void vtkInteractorStyleFlight::SetupMotionVars (  void    )  [protected]
 

void vtkInteractorStyleFlight::AzimuthScan (  void    )  [protected]
 

Member Data Documentation

unsigned char vtkInteractorStyleFlight::KeysDown [protected]
 

Definition at line 158 of file vtkInteractorStyleFlight.h.

int vtkInteractorStyleFlight::Flying [protected]
 

Definition at line 159 of file vtkInteractorStyleFlight.h.

int vtkInteractorStyleFlight::Reversing [protected]
 

Definition at line 160 of file vtkInteractorStyleFlight.h.

int vtkInteractorStyleFlight::TimerRunning [protected]
 

Definition at line 161 of file vtkInteractorStyleFlight.h.

int vtkInteractorStyleFlight::AzimuthScanning [protected]
 

Definition at line 162 of file vtkInteractorStyleFlight.h.

int vtkInteractorStyleFlight::DisableMotion [protected]
 

Definition at line 163 of file vtkInteractorStyleFlight.h.

int vtkInteractorStyleFlight::FixUpVector [protected]
 

Definition at line 164 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::OldX [protected]
 

Definition at line 165 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::OldY [protected]
 

Definition at line 166 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::X2 [protected]
 

Definition at line 167 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::Y2 [protected]
 

Definition at line 168 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::DiagonalLength [protected]
 

Definition at line 169 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::MotionStepSize [protected]
 

Definition at line 170 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::MotionUserScale [protected]
 

Definition at line 171 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::MotionAccelerationFactor [protected]
 

Definition at line 172 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::AngleStepSize [protected]
 

Definition at line 173 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::AngleAccelerationFactor [protected]
 

Definition at line 174 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::YawAngle [protected]
 

Definition at line 175 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::PitchAngle [protected]
 

Definition at line 176 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::FixedUpVector[3] [protected]
 

Definition at line 177 of file vtkInteractorStyleFlight.h.

double vtkInteractorStyleFlight::AzimuthStepSize [protected]
 

Definition at line 178 of file vtkInteractorStyleFlight.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:49:56 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001