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

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

#include <vtkSphericalDirectionEncoder.h>

Inheritance diagram for vtkSphericalDirectionEncoder:
[legend]
Collaboration diagram for vtkSphericalDirectionEncoder:
[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...
 
vtkSphericalDirectionEncoderNewInstance () 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...
 
- 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 vtkSphericalDirectionEncoderSafeDownCast (vtkObjectBase *o)
 
static vtkSphericalDirectionEncoderNew ()
 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
 
 vtkSphericalDirectionEncoder ()
 
 ~vtkSphericalDirectionEncoder () override
 
- 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 &)
 

Static Protected Member Functions

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

Static Protected Attributes

static float DecodedGradientTable [65536 *3]
 
static int DecodedGradientTableInitialized
 

Additional Inherited Members

- 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

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 *  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 vtkSphericalDirectionEncoder* vtkSphericalDirectionEncoder::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkSphericalDirectionEncoder::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDirectionEncoder.

◆ NewInstance()

vtkSphericalDirectionEncoder* vtkSphericalDirectionEncoder::NewInstance ( ) const

◆ PrintSelf()

void vtkSphericalDirectionEncoder::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 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 59 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 67 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 77 of file vtkSphericalDirectionEncoder.h.

◆ DecodedGradientTableInitialized

int vtkSphericalDirectionEncoder::DecodedGradientTableInitialized
staticprotected

Definition at line 84 of file vtkSphericalDirectionEncoder.h.


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