VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkRecursiveSphereDirectionEncoder Class Reference

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

#include <vtkRecursiveSphereDirectionEncoder.h>

Inheritance diagram for vtkRecursiveSphereDirectionEncoder:
[legend]
Collaboration diagram for vtkRecursiveSphereDirectionEncoder:
[legend]

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)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkRecursiveSphereDirectionEncoderNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
int GetEncodedDirection (float n[3]) override
 Given a normal vector n, return the encoded direction. More...
 
floatGetDecodedGradient (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...
 
floatGetDecodedGradientTable (void) override
 Get the decoded gradient table. More...
 
virtual void SetRecursionDepth (int)
 Set / Get the recursion depth for the subdivision. More...
 
virtual int GetRecursionDepth ()
 
- Public Member Functions inherited from vtkDirectionEncoder
vtkDirectionEncoderNewInstance () const
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRecursiveSphereDirectionEncoderSafeDownCast (vtkObjectBase *o)
 
static vtkRecursiveSphereDirectionEncoderNew ()
 Construct the object. More...
 
- Static Public Member Functions inherited from vtkDirectionEncoder
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDirectionEncoderSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRecursiveSphereDirectionEncoder ()
 
 ~vtkRecursiveSphereDirectionEncoder () override
 
void InitializeIndexTable (void)
 
- Protected Member Functions inherited from vtkDirectionEncoder
 vtkDirectionEncoder ()
 
 ~vtkDirectionEncoder () override
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int RecursionDepth
 
intIndexTable
 
floatDecodedNormal
 
int IndexTableRecursionDepth
 
int OuterSize
 
int InnerSize
 
int GridSize
 
- 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 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 35 of file vtkRecursiveSphereDirectionEncoder.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 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 *  name)
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 vtkDirectionEncoder.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRecursiveSphereDirectionEncoder::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDirectionEncoder.

◆ NewInstance()

vtkRecursiveSphereDirectionEncoder* vtkRecursiveSphereDirectionEncoder::NewInstance ( ) const

◆ PrintSelf()

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

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 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 ( void  )
overridevirtual

Return the number of encoded directions.

Implements vtkDirectionEncoder.

◆ GetDecodedGradientTable()

float* vtkRecursiveSphereDirectionEncoder::GetDecodedGradientTable ( void  )
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

◆ InitializeIndexTable()

void vtkRecursiveSphereDirectionEncoder::InitializeIndexTable ( void  )
protected

Member Data Documentation

◆ RecursionDepth

int vtkRecursiveSphereDirectionEncoder::RecursionDepth
protected

Definition at line 97 of file vtkRecursiveSphereDirectionEncoder.h.

◆ IndexTable

int* vtkRecursiveSphereDirectionEncoder::IndexTable
protected

Definition at line 102 of file vtkRecursiveSphereDirectionEncoder.h.

◆ DecodedNormal

float* vtkRecursiveSphereDirectionEncoder::DecodedNormal
protected

Definition at line 108 of file vtkRecursiveSphereDirectionEncoder.h.

◆ IndexTableRecursionDepth

int vtkRecursiveSphereDirectionEncoder::IndexTableRecursionDepth
protected

Definition at line 114 of file vtkRecursiveSphereDirectionEncoder.h.

◆ OuterSize

int vtkRecursiveSphereDirectionEncoder::OuterSize
protected

Definition at line 116 of file vtkRecursiveSphereDirectionEncoder.h.

◆ InnerSize

int vtkRecursiveSphereDirectionEncoder::InnerSize
protected

Definition at line 117 of file vtkRecursiveSphereDirectionEncoder.h.

◆ GridSize

int vtkRecursiveSphereDirectionEncoder::GridSize
protected

Definition at line 118 of file vtkRecursiveSphereDirectionEncoder.h.


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