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

vu1611< SIZE, TYPE > Class Template Reference

#include <spheric.h>

Inheritance diagram for vu1611< SIZE, TYPE >:

Inheritance graph
[legend]
Collaboration diagram for vu1611< SIZE, TYPE >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 vu1611 ()
 The default constructor.
 vu1611 (const vu1611 &inst)
 The copy constructor.
vu1611operator= (const vu1611 &rhs)
 The assignment operator.
 ~vu1611 ()
dword getWidth (void) const
 Returns the width of each view (all views have the same size).
dword getHeight (void) const
 Returns the height of each view (all views have the same size).
dword getNumberOfViews (void) const
 Returns the number of views.
vuSphericView< SIZE, TYPE > * getView (dword i)
 Returns the ith view.
int getIndexOfView (vuSphericView< SIZE, TYPE > *view)
vuSphericView< SIZE, TYPE > *& getViews ()
 Returns the view array.
const char * _typeName ()
void setViewVectors (const vuVector &, const vuVector &, const vuVector &)
 this is deprecated and should not be supported anymore
virtual vuVector getCenter () const
 Returns the center of the volume.
virtual bool read (void)
 Reads volume data from the data file set with setFileName().
virtual bool write (void)
 Writes volume data to the data file set with setFileName().
bool write (const vuString &fileName)

Protected Member Functions

virtual bool read (FILE *file)
virtual bool write (FILE *file)
 Writes the general spheric data information to the file.
virtual void glResize (dword width, dword height)

Protected Attributes

dword m_width
 The width of each view.
dword m_height
 The height of each view.
dword m_numberOfViews
 The number of views.
vuSphericView< SIZE, TYPE > * m_views
 The spheric views.

Private Member Functions

void _initViews ()
bool _isDataSizeValid (dword dataSize)
void _syncViewsToBuffer ()

template<int SIZE, class TYPE>
class vu1611< SIZE, TYPE >


Constructor & Destructor Documentation

template<int SIZE, class TYPE>
vu1611< SIZE, TYPE >::vu1611  ) 
 

The default constructor.

Definition at line 8 of file spheric.cpp.

References vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_numberOfViews, vu1611< SIZE, TYPE >::m_views, and vu1611< SIZE, TYPE >::m_width.

template<int SIZE, class TYPE>
vu1611< SIZE, TYPE >::vu1611 const vu1611< SIZE, TYPE > &  inst  ) 
 

The copy constructor.

Definition at line 19 of file spheric.cpp.

References vu1611< SIZE, TYPE >::operator=().

Here is the call graph for this function:

template<int SIZE, class TYPE>
vu1611< SIZE, TYPE >::~vu1611  ) 
 

Definition at line 40 of file spheric.cpp.

References vu1611< SIZE, TYPE >::m_numberOfViews, and vu1611< SIZE, TYPE >::m_views.


Member Function Documentation

template<int SIZE, class TYPE>
void vu1611< SIZE, TYPE >::_initViews  )  [private]
 

Definition at line 258 of file spheric.cpp.

References byte, dword, vuSphericView< SIZE, TYPE >::getSizeInByte(), vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_views, and vu1611< SIZE, TYPE >::m_width.

Referenced by vu1611< SIZE, TYPE >::operator=(), and vu1611< SIZE, TYPE >::read().

Here is the call graph for this function:

template<int SIZE, class TYPE>
bool vu1611< SIZE, TYPE >::_isDataSizeValid dword  dataSize  )  [private]
 

Definition at line 276 of file spheric.cpp.

References dword, vuSphericView< SIZE, TYPE >::getSizeInByte(), vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_width, and size.

Referenced by vu1611< SIZE, TYPE >::read().

Here is the call graph for this function:

template<int SIZE, class TYPE>
void vu1611< SIZE, TYPE >::_syncViewsToBuffer  )  [private]
 

Definition at line 283 of file spheric.cpp.

References byte, dword, vuSphericView< SIZE, TYPE >::getSizeInByte(), vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_views, and vu1611< SIZE, TYPE >::m_width.

Referenced by vu1611< SIZE, TYPE >::write().

Here is the call graph for this function:

template<int SIZE, class TYPE>
const char * vu1611< SIZE, TYPE >::_typeName  ) 
 

Definition at line 89 of file spheric.cpp.

Referenced by vu1611< SIZE, TYPE >::read(), and vu1611< SIZE, TYPE >::write().

template<int SIZE, class TYPE>
vuVector vu1611< SIZE, TYPE >::getCenter  )  const [virtual]
 

Returns the center of the volume.

Reimplemented from vu1.

Definition at line 295 of file spheric.cpp.

template<int SIZE, class TYPE>
dword vu1611< SIZE, TYPE >::getHeight void   )  const
 

Returns the height of each view (all views have the same size).

Definition at line 56 of file spheric.cpp.

References dword.

template<int SIZE, class TYPE>
int vu1611< SIZE, TYPE >::getIndexOfView vuSphericView< SIZE, TYPE > *  view  ) 
 

Definition at line 74 of file spheric.cpp.

References dword, and vu1611< SIZE, TYPE >::m_views.

template<int SIZE, class TYPE>
dword vu1611< SIZE, TYPE >::getNumberOfViews void   )  const [virtual]
 

Returns the number of views.

Implements vu1611_ST.

Definition at line 62 of file spheric.cpp.

References dword.

template<int SIZE, class TYPE>
vuSphericView< SIZE, TYPE > * vu1611< SIZE, TYPE >::getView dword  i  )  [virtual]
 

Returns the ith view.

Implements vu1611_ST.

Definition at line 68 of file spheric.cpp.

References vu1611< SIZE, TYPE >::m_views.

template<int SIZE, class TYPE>
vuSphericView< SIZE, TYPE > *& vu1611< SIZE, TYPE >::getViews  ) 
 

Returns the view array.

Definition at line 83 of file spheric.cpp.

template<int SIZE, class TYPE>
dword vu1611< SIZE, TYPE >::getWidth void   )  const
 

Returns the width of each view (all views have the same size).

Definition at line 50 of file spheric.cpp.

References dword.

template<int SIZE, class TYPE>
void vu1611< SIZE, TYPE >::glResize dword  width,
dword  height
[protected, virtual]
 

Reimplemented from vu1.

Reimplemented in vu1611_1< SIZE, TYPE >, vu1611_2< SIZE, TYPE >, vu1611_1< SIZE, float >, vu1611_1< SIZE, byte >, vu1611_2< SIZE, float >, and vu1611_2< SIZE, byte >.

Definition at line 241 of file spheric.cpp.

References vuCamera::init(), vuCamera::setHeight(), and vuCamera::setWidth().

Referenced by vu1611_2< SIZE, TYPE >::glResize().

Here is the call graph for this function:

template<int SIZE, class TYPE>
vu1611< SIZE, TYPE > & vu1611< SIZE, TYPE >::operator= const vu1611< SIZE, TYPE > &  rhs  ) 
 

The assignment operator.

Definition at line 26 of file spheric.cpp.

References vu1611< SIZE, TYPE >::_initViews(), vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_numberOfViews, vu1611< SIZE, TYPE >::m_width, and vu1::operator=().

Referenced by vu1611< SIZE, TYPE >::vu1611().

Here is the call graph for this function:

template<int SIZE, class TYPE>
bool vu1611< SIZE, TYPE >::read void   )  [virtual]
 

Reads volume data from the data file set with setFileName().

This implements the abstract read() method from the general Volume class. If the read is successful, the function returns true. If the file does not exist or is in an invalid format, the function returns false. In this case, the error information is set for the instance.

Returns:
True if successful, false otherwise.

Implements vu1.

Reimplemented in vu1611_4< SIZE, TYPE >, vu1611_3< SIZE, TYPE >, vu1611_2< SIZE, TYPE >, vu1611_2< SIZE, float >, and vu1611_2< SIZE, byte >.

Definition at line 299 of file spheric.cpp.

References vuString::isEmpty(), and vu1::setError().

Referenced by vu1611_2< SIZE, TYPE >::read(), and vu1611_3< SIZE, TYPE >::read().

Here is the call graph for this function:

template<int SIZE, class TYPE>
bool vu1611< SIZE, TYPE >::read FILE *  file  )  [protected, virtual]
 

This method reads in the general information for spheric data sets. It also asserts whether the data is indeed spheric or not and whether the data type is indeed from the correct TYPE and SIZE.

Returns:
True if successful (data is spheric), false otherwise.

Reimplemented from vu161.

Definition at line 107 of file spheric.cpp.

References vu1611< SIZE, TYPE >::_initViews(), vu1611< SIZE, TYPE >::_isDataSizeValid(), vu1611< SIZE, TYPE >::_typeName(), byte, dword, vuCamera::getLookAtVector(), vuCamera::init(), vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_numberOfViews, vu1611< SIZE, TYPE >::m_views, vu1611< SIZE, TYPE >::m_width, vu1::read(), vu1::setError(), vu1::setInvalidFormatError(), vuCamera::setPosition(), and size.

Here is the call graph for this function:

template<int SIZE, class TYPE>
void vu1611< SIZE, TYPE >::setViewVectors const vuVector ,
const vuVector ,
const vuVector
[virtual]
 

this is deprecated and should not be supported anymore

Implements vu1.

Definition at line 98 of file spheric.cpp.

template<int SIZE, class TYPE>
bool vu1611< SIZE, TYPE >::write const vuString fileName  ) 
 

Definition at line 330 of file spheric.cpp.

References vu1611< SIZE, TYPE >::write().

Here is the call graph for this function:

template<int SIZE, class TYPE>
bool vu1611< SIZE, TYPE >::write void   )  [virtual]
 

Writes volume data to the data file set with setFileName().

This implements the abstract write() method from the general Volume class.

Returns:
True if successful, false otherwise.

Implements vu1.

Definition at line 314 of file spheric.cpp.

References vuString::isEmpty(), and vu1::setError().

Referenced by vu1611< SIZE, TYPE >::write().

Here is the call graph for this function:

template<int SIZE, class TYPE>
bool vu1611< SIZE, TYPE >::write FILE *  file  )  [protected, virtual]
 

Writes the general spheric data information to the file.

Returns:
True if successful, false otherwise.

Reimplemented from vu161.

Definition at line 192 of file spheric.cpp.

References vu1611< SIZE, TYPE >::_syncViewsToBuffer(), vu1611< SIZE, TYPE >::_typeName(), byte, vuString::c_str(), dword, vuString::isEmpty(), vu1611< SIZE, TYPE >::m_height, vu1611< SIZE, TYPE >::m_numberOfViews, vu1611< SIZE, TYPE >::m_width, vu1::setWriteError(), size, and vu1::write().

Here is the call graph for this function:


Member Data Documentation

template<int SIZE, class TYPE>
dword vu1611< SIZE, TYPE >::m_height [protected]
 

The height of each view.

Definition at line 115 of file spheric.h.

Referenced by vu1611< SIZE, TYPE >::_initViews(), vu1611< SIZE, TYPE >::_isDataSizeValid(), vu1611< SIZE, TYPE >::_syncViewsToBuffer(), vu1611< SIZE, TYPE >::operator=(), vu1611< SIZE, TYPE >::read(), vu1611< SIZE, TYPE >::vu1611(), and vu1611< SIZE, TYPE >::write().

template<int SIZE, class TYPE>
dword vu1611< SIZE, TYPE >::m_numberOfViews [protected]
 

The number of views.

Definition at line 117 of file spheric.h.

Referenced by vu1611< SIZE, TYPE >::operator=(), vu1611< SIZE, TYPE >::read(), vu1611< SIZE, TYPE >::vu1611(), vu1611< SIZE, TYPE >::write(), and vu1611< SIZE, TYPE >::~vu1611().

template<int SIZE, class TYPE>
vuSphericView<SIZE,TYPE>* vu1611< SIZE, TYPE >::m_views [protected]
 

The spheric views.

Definition at line 119 of file spheric.h.

Referenced by vu1611< SIZE, TYPE >::_initViews(), vu1611< SIZE, TYPE >::_syncViewsToBuffer(), vu1611< SIZE, TYPE >::getIndexOfView(), vu1611< SIZE, TYPE >::getView(), vu1611< SIZE, TYPE >::read(), vu1611< SIZE, TYPE >::vu1611(), and vu1611< SIZE, TYPE >::~vu1611().

template<int SIZE, class TYPE>
dword vu1611< SIZE, TYPE >::m_width [protected]
 

The width of each view.

Definition at line 113 of file spheric.h.

Referenced by vu1611< SIZE, TYPE >::_initViews(), vu1611< SIZE, TYPE >::_isDataSizeValid(), vu1611< SIZE, TYPE >::_syncViewsToBuffer(), vu1611< SIZE, TYPE >::operator=(), vu1611< SIZE, TYPE >::read(), vu1611< SIZE, TYPE >::vu1611(), and vu1611< SIZE, TYPE >::write().


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