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

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.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
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 Member Functions

static int IsTypeOf (const char *type)
static vtkDirectionEncoderSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkDirectionEncoder ()
 ~vtkDirectionEncoder ()


Member Typedef Documentation

typedef vtkObject vtkDirectionEncoder::Superclass
 

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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]
 

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

static 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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

Reimplemented in vtkRecursiveSphereDirectionEncoder.

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

Given a normal vector n, return the encoded direction

Implemented in vtkRecursiveSphereDirectionEncoder.

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

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

Implemented in vtkRecursiveSphereDirectionEncoder.

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

Return the number of encoded directions

Implemented 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.

Implemented in vtkRecursiveSphereDirectionEncoder.


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