VTK  9.1.0
Public Member Functions | Protected Member Functions | List of all members
vtkDirectionEncoder Class Referenceabstract

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

#include <vtkDirectionEncoder.h>

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

Public Member Functions

virtual int GetEncodedDirection (float n[3])=0
 Given a normal vector n, return the encoded direction.
 
virtual float * GetDecodedGradient (int value)=0
 / Given an encoded value, return a pointer to the normal vector
 
virtual int GetNumberOfEncodedDirections (void)=0
 Return the number of encoded directions.
 
virtual float * GetDecodedGradientTable (void)=0
 Get the decoded gradient table.
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
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).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Protected Member Functions

 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- 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 &)
 
typedef vtkObject Superclass
 Get the name of this class.
 
static vtkTypeBool IsTypeOf (const char *type)
 Get the name of this class.
 
static vtkDirectionEncoderSafeDownCast (vtkObjectBase *o)
 Get the name of this class.
 
virtual vtkTypeBool IsA (const char *type)
 Get the name of this class.
 
vtkDirectionEncoderNewInstance () const
 Get the name of this class.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Get the name of this class.
 
virtual vtkObjectBaseNewInstanceInternal () const
 Get the name of this class.
 

Additional Inherited Members

- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
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).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
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.
 
- 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

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

Member Typedef Documentation

◆ Superclass

Get the name of this class.

Definition at line 46 of file vtkDirectionEncoder.h.

Constructor & Destructor Documentation

◆ vtkDirectionEncoder()

vtkDirectionEncoder::vtkDirectionEncoder ( )
protecteddefault

◆ ~vtkDirectionEncoder()

vtkDirectionEncoder::~vtkDirectionEncoder ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

Get the name of this class.

◆ IsA()

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

Get the name of this class.

Reimplemented from vtkObjectBase.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

◆ SafeDownCast()

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

Get the name of this class.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDirectionEncoder::NewInstanceInternal ( ) const
protectedvirtual

Get the name of this class.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

◆ NewInstance()

vtkDirectionEncoder * vtkDirectionEncoder::NewInstance ( ) const

Get the name of this class.

◆ PrintSelf()

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

Get the name of this class.

Reimplemented from vtkObject.

Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

◆ GetEncodedDirection()

virtual int vtkDirectionEncoder::GetEncodedDirection ( float  n[3])
pure virtual

Given a normal vector n, return the encoded direction.

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

◆ GetDecodedGradient()

virtual float * vtkDirectionEncoder::GetDecodedGradient ( int  value)
pure virtual

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

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

◆ GetNumberOfEncodedDirections()

virtual int vtkDirectionEncoder::GetNumberOfEncodedDirections ( void  )
pure virtual

Return the number of encoded directions.

Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.

◆ GetDecodedGradientTable()

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: