A direction encoder based on spherical coordinates. More...

#include <vtkSphericalDirectionEncoder.h>

Inheritance diagram for vtkSphericalDirectionEncoder:

Collaboration diagram for vtkSphericalDirectionEncoder:

Public Types
typedef vtkDirectionEncoder	Superclass

Public Types inherited from vtkDirectionEncoder
typedef vtkObject	Superclass
	Get the name of this class. More...

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Get the name of this class. More...

vtkSphericalDirectionEncoder *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Get the name of this class. More...

int	GetEncodedDirection (float n[3]) override
	Given a normal vector n, return the encoded direction. More...

float *	GetDecodedGradient (int value) override
	/ Given an encoded value, return a pointer to the normal vector More...

int	GetNumberOfEncodedDirections (void) override
	Return the number of encoded directions. More...

float *	GetDecodedGradientTable (void) override
	Get the decoded gradient table. More...

Public Member Functions inherited from vtkDirectionEncoder
virtual int	GetEncodedDirection (float n[3])=0
	Given a normal vector n, return the encoded direction. More...

virtual float *	GetDecodedGradient (int value)=0
	/ Given an encoded value, return a pointer to the normal vector More...

virtual int	GetNumberOfEncodedDirections (void)=0
	Return the number of encoded directions. More...

virtual float *	GetDecodedGradientTable (void)=0
	Get the decoded gradient table. More...

vtkDirectionEncoder *	NewInstance () const
	Get the name of this class. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkSphericalDirectionEncoder *	SafeDownCast (vtkObjectBase *o)

static vtkSphericalDirectionEncoder *	New ()
	Construct the object. More...

Static Public Member Functions inherited from vtkDirectionEncoder
static vtkTypeBool	IsTypeOf (const char *type)
	Get the name of this class. More...

static vtkDirectionEncoder *	SafeDownCast (vtkObjectBase *o)
	Get the name of this class. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	Get the name of this class. More...

	vtkSphericalDirectionEncoder ()

	~vtkSphericalDirectionEncoder () override

Protected Member Functions inherited from vtkDirectionEncoder
	vtkDirectionEncoder ()=default

	~vtkDirectionEncoder () override=default

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Attributes
static float	DecodedGradientTable [65536 *3]

static int	DecodedGradientTableInitialized
	Initialize the table at startup. More...

static void	InitializeDecodedGradientTable ()
	Initialize the table at startup. More...

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

A direction encoder based on spherical coordinates.

vtkSphericalDirectionEncoder is a direction encoder which uses spherical coordinates for mapping (nx, ny, nz) into an azimuth, elevation pair.

See also: vtkDirectionEncoder

Definition at line 32 of file vtkSphericalDirectionEncoder.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDirectionEncoder vtkSphericalDirectionEncoder::Superclass

Definition at line 35 of file vtkSphericalDirectionEncoder.h.

Constructor & Destructor Documentation

◆ vtkSphericalDirectionEncoder()

vtkSphericalDirectionEncoder::vtkSphericalDirectionEncoder ( )

protected

◆ ~vtkSphericalDirectionEncoder()

vtkSphericalDirectionEncoder::~vtkSphericalDirectionEncoder ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkSphericalDirectionEncoder::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkSphericalDirectionEncoder::IsA ( const char * type )

virtual

Get the name of this class.

Reimplemented from vtkDirectionEncoder.

◆ SafeDownCast()

static vtkSphericalDirectionEncoder * vtkSphericalDirectionEncoder::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSphericalDirectionEncoder::NewInstanceInternal ( ) const

protectedvirtual

Get the name of this class.

Reimplemented from vtkDirectionEncoder.

◆ NewInstance()

vtkSphericalDirectionEncoder * vtkSphericalDirectionEncoder::NewInstance ( ) const

◆ PrintSelf()

void vtkSphericalDirectionEncoder::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Get the name of this class.

Reimplemented from vtkDirectionEncoder.

◆ New()

static vtkSphericalDirectionEncoder * vtkSphericalDirectionEncoder::New ( )

static

Construct the object.

Initialize the index table which will be used to map the normal into a patch on the recursively subdivided sphere.

◆ GetEncodedDirection()

int vtkSphericalDirectionEncoder::GetEncodedDirection ( float n[3] )

overridevirtual

Given a normal vector n, return the encoded direction.

Implements vtkDirectionEncoder.

◆ GetDecodedGradient()

float * vtkSphericalDirectionEncoder::GetDecodedGradient ( int value )

overridevirtual

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

Implements vtkDirectionEncoder.

◆ GetNumberOfEncodedDirections()

int vtkSphericalDirectionEncoder::GetNumberOfEncodedDirections ( void )

inlineoverridevirtual

Return the number of encoded directions.

Implements vtkDirectionEncoder.

Definition at line 58 of file vtkSphericalDirectionEncoder.h.

◆ GetDecodedGradientTable()

float * vtkSphericalDirectionEncoder::GetDecodedGradientTable ( void )

inlineoverridevirtual

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.

Implements vtkDirectionEncoder.

Definition at line 66 of file vtkSphericalDirectionEncoder.h.

◆ InitializeDecodedGradientTable()

static void vtkSphericalDirectionEncoder::InitializeDecodedGradientTable ( )

staticprotected

Initialize the table at startup.

Member Data Documentation

◆ DecodedGradientTable

float vtkSphericalDirectionEncoder::DecodedGradientTable[65536 *3]

staticprotected

Definition at line 72 of file vtkSphericalDirectionEncoder.h.

◆ DecodedGradientTableInitialized

int vtkSphericalDirectionEncoder::DecodedGradientTableInitialized

staticprotected

Initialize the table at startup.

Definition at line 79 of file vtkSphericalDirectionEncoder.h.

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

Rendering/Volume/vtkSphericalDirectionEncoder.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkSphericalDirectionEncoder()

◆ ~vtkSphericalDirectionEncoder()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetEncodedDirection()

◆ GetDecodedGradient()

◆ GetNumberOfEncodedDirections()

◆ GetDecodedGradientTable()

◆ InitializeDecodedGradientTable()

Member Data Documentation

◆ DecodedGradientTable

◆ DecodedGradientTableInitialized