A direction encoder based on the recursive subdivision of an octahedron. More...

#include <vtkRecursiveSphereDirectionEncoder.h>

Inheritance diagram for vtkRecursiveSphereDirectionEncoder:

Collaboration diagram for vtkRecursiveSphereDirectionEncoder:

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

vtkRecursiveSphereDirectionEncoder *	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 () override
	Return the number of encoded directions. More...

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


virtual void	SetRecursionDepth (int)
	Set / Get the recursion depth for the subdivision. More...

virtual int	GetRecursionDepth ()
	Set / Get the recursion depth for the subdivision. More...

Public Member Functions inherited from vtkDirectionEncoder
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	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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

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

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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...

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

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

static vtkRecursiveSphereDirectionEncoder *	SafeDownCast (vtkObjectBase *o)

static vtkRecursiveSphereDirectionEncoder *	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 (vtkTypeBool 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 vtkTypeBool	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...

	vtkRecursiveSphereDirectionEncoder ()

	~vtkRecursiveSphereDirectionEncoder () override

void	InitializeIndexTable ()

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	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	RecursionDepth

int *	IndexTable

float *	DecodedNormal

int	IndexTableRecursionDepth

int	OuterSize

int	InnerSize

int	GridSize

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

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

vtkWeakPointerBase **	WeakPointers

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

A direction encoder based on the recursive subdivision of an octahedron.

vtkRecursiveSphereDirectionEncoder is a direction encoder which uses the vertices of a recursive subdivision of an octahedron (with the vertices pushed out onto the surface of an enclosing sphere) to encode directions into a two byte value.

See also: vtkDirectionEncoder

Definition at line 24 of file vtkRecursiveSphereDirectionEncoder.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDirectionEncoder vtkRecursiveSphereDirectionEncoder::Superclass

Definition at line 27 of file vtkRecursiveSphereDirectionEncoder.h.

Constructor & Destructor Documentation

◆ vtkRecursiveSphereDirectionEncoder()

vtkRecursiveSphereDirectionEncoder::vtkRecursiveSphereDirectionEncoder ( )

protected

◆ ~vtkRecursiveSphereDirectionEncoder()

vtkRecursiveSphereDirectionEncoder::~vtkRecursiveSphereDirectionEncoder ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Get the name of this class.

Reimplemented from vtkDirectionEncoder.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRecursiveSphereDirectionEncoder::NewInstanceInternal ( ) const

protectedvirtual

Get the name of this class.

Reimplemented from vtkDirectionEncoder.

◆ NewInstance()

vtkRecursiveSphereDirectionEncoder* vtkRecursiveSphereDirectionEncoder::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Get the name of this class.

Reimplemented from vtkDirectionEncoder.

◆ New()

static vtkRecursiveSphereDirectionEncoder* vtkRecursiveSphereDirectionEncoder::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 vtkRecursiveSphereDirectionEncoder::GetEncodedDirection ( float n[3] )

overridevirtual

Given a normal vector n, return the encoded direction.

Implements vtkDirectionEncoder.

◆ GetDecodedGradient()

float* vtkRecursiveSphereDirectionEncoder::GetDecodedGradient ( int value )

overridevirtual

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

Implements vtkDirectionEncoder.

◆ GetNumberOfEncodedDirections()

int vtkRecursiveSphereDirectionEncoder::GetNumberOfEncodedDirections ( )

overridevirtual

Return the number of encoded directions.

Implements vtkDirectionEncoder.

◆ GetDecodedGradientTable()

float* vtkRecursiveSphereDirectionEncoder::GetDecodedGradientTable ( )

overridevirtual

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.

◆ SetRecursionDepth()

virtual void vtkRecursiveSphereDirectionEncoder::SetRecursionDepth ( int )

virtual

Set / Get the recursion depth for the subdivision.

This indicates how many time one triangle on the initial 8-sided sphere model is replaced by four triangles formed by connecting triangle edge midpoints. A recursion level of 0 yields 8 triangles with 6 unique vertices. The normals are the vectors from the sphere center through the vertices. The number of directions will be 11 since the four normals with 0 z values will be duplicated in the table - once with +0 values and the other time with -0 values, and an addition index will be used to represent the (0,0,0) normal. If we instead choose a recursion level of 6 (the maximum that can fit within 2 bytes) the number of directions is 16643, with 16386 unique directions and a zero normal.

◆ GetRecursionDepth()

virtual int vtkRecursiveSphereDirectionEncoder::GetRecursionDepth ( )

virtual

Set / Get the recursion depth for the subdivision.

This indicates how many time one triangle on the initial 8-sided sphere model is replaced by four triangles formed by connecting triangle edge midpoints. A recursion level of 0 yields 8 triangles with 6 unique vertices. The normals are the vectors from the sphere center through the vertices. The number of directions will be 11 since the four normals with 0 z values will be duplicated in the table - once with +0 values and the other time with -0 values, and an addition index will be used to represent the (0,0,0) normal. If we instead choose a recursion level of 6 (the maximum that can fit within 2 bytes) the number of directions is 16643, with 16386 unique directions and a zero normal.

◆ InitializeIndexTable()

void vtkRecursiveSphereDirectionEncoder::InitializeIndexTable ( )

protected

Member Data Documentation

◆ RecursionDepth

int vtkRecursiveSphereDirectionEncoder::RecursionDepth

protected

Definition at line 85 of file vtkRecursiveSphereDirectionEncoder.h.

◆ IndexTable

int* vtkRecursiveSphereDirectionEncoder::IndexTable

protected

Definition at line 90 of file vtkRecursiveSphereDirectionEncoder.h.

◆ DecodedNormal

float* vtkRecursiveSphereDirectionEncoder::DecodedNormal

protected

Definition at line 96 of file vtkRecursiveSphereDirectionEncoder.h.

◆ IndexTableRecursionDepth

int vtkRecursiveSphereDirectionEncoder::IndexTableRecursionDepth

protected

Definition at line 102 of file vtkRecursiveSphereDirectionEncoder.h.

◆ OuterSize

int vtkRecursiveSphereDirectionEncoder::OuterSize

protected

Definition at line 104 of file vtkRecursiveSphereDirectionEncoder.h.

◆ InnerSize

int vtkRecursiveSphereDirectionEncoder::InnerSize

protected

Definition at line 105 of file vtkRecursiveSphereDirectionEncoder.h.

◆ GridSize

int vtkRecursiveSphereDirectionEncoder::GridSize

protected

Definition at line 106 of file vtkRecursiveSphereDirectionEncoder.h.

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

Rendering/Volume/vtkRecursiveSphereDirectionEncoder.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkRecursiveSphereDirectionEncoder()

◆ ~vtkRecursiveSphereDirectionEncoder()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ New()

◆ GetEncodedDirection()

◆ GetDecodedGradient()

◆ GetNumberOfEncodedDirections()

◆ GetDecodedGradientTable()

◆ SetRecursionDepth()

◆ GetRecursionDepth()

◆ InitializeIndexTable()

Member Data Documentation

◆ RecursionDepth

◆ IndexTable

◆ DecodedNormal

◆ IndexTableRecursionDepth

◆ OuterSize

◆ InnerSize

◆ GridSize