vtkDirectionEncoder Class Reference

#include <vtkDirectionEncoder.h>

Inheritance diagram for vtkDirectionEncoder:

Inheritance graph
[legend]
Collaboration diagram for vtkDirectionEncoder:

Collaboration graph
[legend]

List of all members.


Detailed Description

encode a direction into a one or two byte value

Given a direction, encode it into an integer value. This value should be less than 65536, which is the maximum number of encoded directions supported by this superclass. A direction encoded is used to encode normals in a volume for use during volume rendering, and the amount of space that is allocated per normal is 2 bytes. This is an abstract superclass - see the subclasses for specific implementation details.

See also:
vtkRecursiveSphereDirectionEncoder

Definition at line 37 of file vtkDirectionEncoder.h.

typedef vtkObject Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
static int IsTypeOf (const char *type)
static vtkDirectionEncoderSafeDownCast (vtkObject *o)

Public Member Functions

virtual int GetEncodedDirection (float n[3])=0
virtual float * GetDecodedGradient (int value)=0
virtual int GetNumberOfEncodedDirections (void)=0
virtual float * GetDecodedGradientTable (void)=0

Protected Member Functions

 vtkDirectionEncoder ()
 ~vtkDirectionEncoder ()

Member Typedef Documentation

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

Definition at line 42 of file vtkDirectionEncoder.h.


Constructor & Destructor Documentation

vtkDirectionEncoder::vtkDirectionEncoder (  )  [inline, protected]

Definition at line 62 of file vtkDirectionEncoder.h.

vtkDirectionEncoder::~vtkDirectionEncoder (  )  [inline, protected]

Definition at line 63 of file vtkDirectionEncoder.h.


Member Function Documentation

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

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

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

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

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

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

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

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

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

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

virtual int vtkDirectionEncoder::GetEncodedDirection ( float  n[3]  )  [pure virtual]

Given a normal vector n, return the encoded direction

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

virtual float* vtkDirectionEncoder::GetDecodedGradient ( int  value  )  [pure virtual]

/ Given an encoded value, return a pointer to the normal vector

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

virtual int vtkDirectionEncoder::GetNumberOfEncodedDirections ( void   )  [pure virtual]

Return the number of encoded directions

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

virtual float* vtkDirectionEncoder::GetDecodedGradientTable ( void   )  [pure virtual]

Get the decoded gradient table. There are this->GetNumberOfEncodedDirections() entries in the table, each containing a normal (direction) vector. This is a flat structure - 3 times the number of directions floats in an array.

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.


The documentation for this class was generated from the following file:

Generated on Sat Dec 27 13:22:43 2008 for VTK by  doxygen 1.5.6