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

#include <vtkDirectionEncoder.h>

Inheritance diagram for vtkDirectionEncoder:

Collaboration diagram for vtkDirectionEncoder:

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

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Protected Member Functions
	vtkDirectionEncoder ()

	~vtkDirectionEncoder ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

typedef vtkObject	Superclass

static int	IsTypeOf (const char *type)

static vtkDirectionEncoder *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkDirectionEncoder *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Member Typedef Documentation

typedef vtkObject vtkDirectionEncoder::Superclass

Get the name of this class

Definition at line 43 of file vtkDirectionEncoder.h.

Constructor & Destructor Documentation

vtkDirectionEncoder::vtkDirectionEncoder ( )

inlineprotected

Definition at line 63 of file vtkDirectionEncoder.h.

vtkDirectionEncoder::~vtkDirectionEncoder ( )

inlineprotected

Definition at line 64 of file vtkDirectionEncoder.h.

Member Function Documentation

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

static

Get the name of this class

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 ( vtkObjectBase * o )

static

Get the name of this class

virtual vtkObjectBase* vtkDirectionEncoder::NewInstanceInternal ( ) const

protectedvirtual

Get the name of this class

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

vtkDirectionEncoder* vtkDirectionEncoder::NewInstance ( ) const

Get the name of this class

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:

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Rendering/Volume/vtkDirectionEncoder.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation