Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

vuStandardFVR< SIZE > Class Template Reference

A utility template for the standard fourier volume renderin. More...

#include <vuStandardFVR.h>

Inheritance diagram for vuStandardFVR< SIZE >:

Inheritance graph
[legend]
Collaboration diagram for vuStandardFVR< SIZE >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vuStandardFVR ()
 Constructor.
 ~vuStandardFVR ()
 Destructor.
virtual const char * _titleString ()
virtual bool init (const char *DataFile)
virtual vuCameragetCamera ()
 This function must return a pointer to the camera that is taking the picture of the scene.
virtual vuImagegetCurrentImage ()
 This function must return a pointer to the current vuImage buffer that the method can write to or read from.
virtual void DrawFromImage ()
 This function must take the data vuImage buffer from the last call to getCurrent Image and draw that on the screen.
virtual void DrawAgain ()
 This function must rerender the scene completely.
wxString helpText ()
 return own help text
virtual void addRight (wxSizer *sizer)
 This method adds controls to the bottom of the window.
virtual void addBottom (wxSizer *sizer)
 This method adds controls to the bottom of the window.

Protected Types

enum  {
  idFILTER, idRENDERMETHOD, idIMAGESCALE, idFITSCALE,
  idCHANNELS
}

Protected Member Functions

bool glInit ()
 Initializes open gl for the utility.
void glRender ()
void glResize ()
 Resizes the gl viewport and renders the volume.
void onKeyboard (wxKeyEvent &event)
 Callbacks.
void OnChoiceRenderMethod (wxCommandEvent &event)
void OnChoiceFilter (wxCommandEvent &event)
void OnButtonFitScale (wxCommandEvent &event)
void OnSliderImageScale (wxScrollEvent &event)
void OnCheckboxChannels (wxCommandEvent &event)
vu1getVolume ()
 Returns a pointer to the volume object. (usually m_Data).
void _addChannelControls (wxFlexGridSizer *sizer)

Protected Attributes

vu1712_1< SIZE > * m_Data
 The spectral raycaster owned by the utility.
wxChoice * m_CHOICEfilter
wxChoice * m_CHOICErenderMethod
wxButton * m_BUTTONfitScale
wxSlider * m_SLIDERimageScale
wxCheckBox ** m_CHECKBOXchannels

Detailed Description

template<int SIZE>
class vuStandardFVR< SIZE >

A utility template for the standard fourier volume renderin.

Definition at line 10 of file vuStandardFVR.h.


Member Enumeration Documentation

template<int SIZE>
anonymous enum [protected]
 

Enumeration values:
idFILTER 
idRENDERMETHOD 
idIMAGESCALE 
idFITSCALE 
idCHANNELS 

Definition at line 14 of file vuStandardFVR.h.


Constructor & Destructor Documentation

template<int SIZE>
vuStandardFVR< SIZE >::vuStandardFVR  ) 
 

Constructor.

Definition at line 5 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::m_Data.

template<int SIZE>
vuStandardFVR< SIZE >::~vuStandardFVR  ) 
 

Destructor.

Definition at line 11 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::m_Data.


Member Function Documentation

template<int SIZE>
void vuStandardFVR< SIZE >::_addChannelControls wxFlexGridSizer *  sizer  )  [protected]
 

Definition at line 304 of file vuStandardFVR.cpp.

References dword, vuStandardFVR< SIZE >::idCHANNELS, and vuStandardFVR< SIZE >::m_CHECKBOXchannels.

Referenced by vuStandardFVR< SIZE >::addBottom().

template<int SIZE>
const char * vuStandardFVR< SIZE >::_titleString  )  [virtual]
 

Definition at line 20 of file vuStandardFVR.cpp.

Referenced by vuStandardFVR< SIZE >::init().

template<int SIZE>
void vuStandardFVR< SIZE >::addBottom wxSizer *  sizer  )  [virtual]
 

This method adds controls to the bottom of the window.

Reimplemented from vuBasicUtility.

Definition at line 111 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::_addChannelControls(), dword, vuTorstensFourierFilter::getFilterNames(), vuString::hasPrefix(), vuStandardFVR< SIZE >::idFILTER, vuStandardFVR< SIZE >::idFITSCALE, vuStandardFVR< SIZE >::idIMAGESCALE, vuStandardFVR< SIZE >::idRENDERMETHOD, vuStandardFVR< SIZE >::m_BUTTONfitScale, vuStandardFVR< SIZE >::m_CHOICEfilter, vuStandardFVR< SIZE >::m_CHOICErenderMethod, vuStandardFVR< SIZE >::m_SLIDERimageScale, and NULL.

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::addRight wxSizer *  sizer  )  [virtual]
 

This method adds controls to the bottom of the window.

Reimplemented from vuBasicUtility.

Definition at line 106 of file vuStandardFVR.cpp.

template<int SIZE>
void vuStandardFVR< SIZE >::DrawAgain  )  [virtual]
 

This function must rerender the scene completely.

This is so that the key frame animator can set the camera, and then force a redraw by the method.

Implements vuBasicUtility.

Definition at line 83 of file vuStandardFVR.cpp.

template<int SIZE>
void vuStandardFVR< SIZE >::DrawFromImage  )  [virtual]
 

This function must take the data vuImage buffer from the last call to getCurrent Image and draw that on the screen.

This is so that prerendered video animation can be displayed by the key frame animator by simply setting the vuImage returned by getCurrentImage and then calling this function.

Implements vuBasicUtility.

Definition at line 78 of file vuStandardFVR.cpp.

template<int SIZE>
vuCamera * vuStandardFVR< SIZE >::getCamera  )  [virtual]
 

This function must return a pointer to the camera that is taking the picture of the scene.

This is so that the key frame animator can read the camera when it needs to take a snapshot and change the camera when it wants the method to rerender the scene from a predetermined camera position.

Implements vuBasicUtility.

Definition at line 66 of file vuStandardFVR.cpp.

template<int SIZE>
vuImage * vuStandardFVR< SIZE >::getCurrentImage  )  [virtual]
 

This function must return a pointer to the current vuImage buffer that the method can write to or read from.

This is how the key framer will update the screen.

Implements vuBasicUtility.

Definition at line 72 of file vuStandardFVR.cpp.

template<int SIZE>
vu1 * vuStandardFVR< SIZE >::getVolume  )  [protected, virtual]
 

Returns a pointer to the volume object. (usually m_Data).

Reimplemented from vuBasicUtility.

Definition at line 235 of file vuStandardFVR.cpp.

template<int SIZE>
bool vuStandardFVR< SIZE >::glInit  )  [protected, virtual]
 

Initializes open gl for the utility.

The method calls the initgl() method so it can do the proper initialization.

Reimplemented from vuBasicUtility.

Definition at line 202 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::m_Data.

template<int SIZE>
void vuStandardFVR< SIZE >::glRender  )  [protected, virtual]
 

The method calls the render() method, setting it up to render to the window's gl canvas.

Reimplemented from vuBasicUtility.

Definition at line 210 of file vuStandardFVR.cpp.

References vuGLCanvas::getHeight(), vuGLCanvas::getWidth(), and vuStandardFVR< SIZE >::m_Data.

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::glResize  )  [protected, virtual]
 

Resizes the gl viewport and renders the volume.

Reimplemented from vuBasicUtility.

Definition at line 228 of file vuStandardFVR.cpp.

References vuGLCanvas::getHeight(), vuGLCanvas::getWidth(), vuStandardFVR< SIZE >::m_Data, and vuGLCanvas::redraw().

Here is the call graph for this function:

template<int SIZE>
wxString vuStandardFVR< SIZE >::helpText  )  [virtual]
 

return own help text

Reimplemented from vuBasicUtility.

Definition at line 88 of file vuStandardFVR.cpp.

template<int SIZE>
bool vuStandardFVR< SIZE >::init const char *  DataFile  )  [virtual]
 

Initializes the utility window. A object is created and the volume data is read. The window appears when finished.

Reimplemented from vuBasicUtility.

Definition at line 26 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::_titleString(), vuString::c_str(), and vuStandardFVR< SIZE >::m_Data.

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::OnButtonFitScale wxCommandEvent &  event  )  [protected]
 

Definition at line 278 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::m_Data, and vuGLCanvas::redraw().

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::OnCheckboxChannels wxCommandEvent &  event  )  [protected]
 

Definition at line 292 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::m_CHECKBOXchannels, vuStandardFVR< SIZE >::m_Data, and vuGLCanvas::redraw().

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::OnChoiceFilter wxCommandEvent &  event  )  [protected]
 

Definition at line 265 of file vuStandardFVR.cpp.

References CHECKNDELETE, vuFilter::getFilterName(), vuStandardFVR< SIZE >::m_CHOICEfilter, vuStandardFVR< SIZE >::m_Data, and vuGLCanvas::redraw().

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::OnChoiceRenderMethod wxCommandEvent &  event  )  [protected]
 

Definition at line 249 of file vuStandardFVR.cpp.

References dword, vuStandardFVR< SIZE >::m_CHOICErenderMethod, vuStandardFVR< SIZE >::m_Data, vuStandardFVR< SIZE >::m_SLIDERimageScale, vuGLCanvas::redraw(), and vu1::setIsReRendering().

Here is the call graph for this function:

template<int SIZE>
void vuStandardFVR< SIZE >::onKeyboard wxKeyEvent &  event  )  [protected, virtual]
 

Callbacks.

Reimplemented from vuBasicUtility.

Definition at line 243 of file vuStandardFVR.cpp.

template<int SIZE>
void vuStandardFVR< SIZE >::OnSliderImageScale wxScrollEvent &  event  )  [protected]
 

Definition at line 285 of file vuStandardFVR.cpp.

References vuStandardFVR< SIZE >::m_Data, vuStandardFVR< SIZE >::m_SLIDERimageScale, and vuGLCanvas::redraw().

Here is the call graph for this function:


Member Data Documentation

template<int SIZE>
wxButton* vuStandardFVR< SIZE >::m_BUTTONfitScale [protected]
 

Definition at line 90 of file vuStandardFVR.h.

Referenced by vuStandardFVR< SIZE >::addBottom().

template<int SIZE>
wxCheckBox** vuStandardFVR< SIZE >::m_CHECKBOXchannels [protected]
 

Definition at line 92 of file vuStandardFVR.h.

Referenced by vuStandardFVR< SIZE >::_addChannelControls(), and vuStandardFVR< SIZE >::OnCheckboxChannels().

template<int SIZE>
wxChoice* vuStandardFVR< SIZE >::m_CHOICEfilter [protected]
 

Definition at line 88 of file vuStandardFVR.h.

Referenced by vuStandardFVR< SIZE >::addBottom(), and vuStandardFVR< SIZE >::OnChoiceFilter().

template<int SIZE>
wxChoice* vuStandardFVR< SIZE >::m_CHOICErenderMethod [protected]
 

Definition at line 89 of file vuStandardFVR.h.

Referenced by vuStandardFVR< SIZE >::addBottom(), and vuStandardFVR< SIZE >::OnChoiceRenderMethod().

template<int SIZE>
vu1712_1<SIZE>* vuStandardFVR< SIZE >::m_Data [protected]
 

The spectral raycaster owned by the utility.

Definition at line 85 of file vuStandardFVR.h.

Referenced by vuStandardFVR< SIZE >::glInit(), vuStandardFVR< SIZE >::glRender(), vuStandardFVR< SIZE >::glResize(), vuStandardFVR< SIZE >::init(), vuStandardFVR< SIZE >::OnButtonFitScale(), vuStandardFVR< SIZE >::OnCheckboxChannels(), vuStandardFVR< SIZE >::OnChoiceFilter(), vuStandardFVR< SIZE >::OnChoiceRenderMethod(), vuStandardFVR< SIZE >::OnSliderImageScale(), vuStandardFVR< SIZE >::vuStandardFVR(), and vuStandardFVR< SIZE >::~vuStandardFVR().

template<int SIZE>
wxSlider* vuStandardFVR< SIZE >::m_SLIDERimageScale [protected]
 

Definition at line 91 of file vuStandardFVR.h.

Referenced by vuStandardFVR< SIZE >::addBottom(), vuStandardFVR< SIZE >::OnChoiceRenderMethod(), and vuStandardFVR< SIZE >::OnSliderImageScale().


The documentation for this class was generated from the following files:
Generated on Wed Dec 15 21:22:06 2004 for vuVolume by  doxygen 1.3.9.1