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

vtkDirectionEncoder Class Reference

encode a direction into a one or two byte value. More...

#include <vtkDirectionEncoder.h>

Inheritance diagram for vtkDirectionEncoder:

Inheritance graph
[legend]
Collaboration diagram for vtkDirectionEncoder:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual int GetEncodedDirection (float n[3])=0
virtual float * GetDecodedGradient (int value)=0
virtual int GetNumberOfEncodedDirections (void)=0
virtual float * GetDecodedGradientTable (void)=0

Static Public Methods

int IsTypeOf (const char *type)
vtkDirectionEncoder * SafeDownCast (vtkObject *o)

Protected Methods

 vtkDirectionEncoder ()
 ~vtkDirectionEncoder ()
 vtkDirectionEncoder (const vtkDirectionEncoder &)
void operator= (const vtkDirectionEncoder &)

Detailed Description

encode a direction into a one or two byte value.

Date:
2000/12/10 20:08:36
Revision:
1.11

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 64 of file vtkDirectionEncoder.h.


Constructor & Destructor Documentation

vtkDirectionEncoder::vtkDirectionEncoder   [inline, protected]
 

Definition at line 86 of file vtkDirectionEncoder.h.

vtkDirectionEncoder::~vtkDirectionEncoder   [inline, protected]
 

Definition at line 87 of file vtkDirectionEncoder.h.

vtkDirectionEncoder::vtkDirectionEncoder const vtkDirectionEncoder &    [inline, protected]
 

Definition at line 88 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.

int vtkDirectionEncoder::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 vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

virtual int vtkDirectionEncoder::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 vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

vtkDirectionEncoder* vtkDirectionEncoder::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 vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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

Given a normal vector n, return the encoded direction

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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

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

Reimplemented in vtkRecursiveSphereDirectionEncoder.

virtual int vtkDirectionEncoder::GetNumberOfEncodedDirections void    [pure virtual]
 

Return the number of encoded directions

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

void vtkDirectionEncoder::operator= const vtkDirectionEncoder &    [inline, protected]
 

Definition at line 89 of file vtkDirectionEncoder.h.


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