encode a direction into a one or two byte value More...
#include <vtkDirectionEncoder.h>
Inheritance diagram for vtkDirectionEncoder:
Collaboration diagram for vtkDirectionEncoder:
Public Member Functions | |
| 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... | |
 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) |
| 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 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... | |
| void | PrintRevisions (ostream &) |
| Legacy. 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... | |
Protected Member Functions | |
| 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 () |
| These methods allow a command to exclusively grab all events. More... | |
| Protected Member Functions inherited from vtkObjectBase | |
| vtkObjectBase () | |
| virtual | ~vtkObjectBase () |
| virtual void | CollectRevisions (ostream &) |
| virtual void | ReportReferences (vtkGarbageCollector *) |
| vtkObjectBase (const vtkObjectBase &) | |
| void | operator= (const vtkObjectBase &) |
| typedef vtkObject | Superclass |
| Get the name of this class. More... | |
| 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... | |
| virtual vtkTypeBool | IsA (const char *type) |
| Get the name of this class. More... | |
| vtkDirectionEncoder * | NewInstance () const |
| Get the name of this class. More... | |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| Get the name of this class. More... | |
| virtual vtkObjectBase * | NewInstanceInternal () const |
| Get the name of this class. More... | |
Additional Inherited Members | |
| 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 vtkObjectBase * | New () |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
| Protected Attributes inherited from vtkObject | |
| bool | Debug |
| vtkTimeStamp | MTime |
| vtkSubjectHelper * | SubjectHelper |
| Protected Attributes inherited from vtkObjectBase | |
| vtkAtomicInt32 | 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.
Definition at line 39 of file vtkDirectionEncoder.h.
Member Typedef Documentation
Get the name of this class.
Definition at line 46 of file vtkDirectionEncoder.h.
Constructor & Destructor Documentation
|
inlineprotected |
Definition at line 74 of file vtkDirectionEncoder.h.
|
inlineoverrideprotected |
Definition at line 75 of file vtkDirectionEncoder.h.
Member Function Documentation
|
static |
Get the name of this class.
|
virtual |
Get the name of this class.
Reimplemented from vtkObjectBase.
Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.
|
static |
Get the name of this class.
|
protectedvirtual |
Get the name of this class.
Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.
| vtkDirectionEncoder* vtkDirectionEncoder::NewInstance | ( | ) | const |
Get the name of this class.
|
overridevirtual |
Get the name of this class.
Reimplemented from vtkObject.
Reimplemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.
Given a normal vector n, return the encoded direction.
Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.
/ Given an encoded value, return a pointer to the normal vector
Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.
|
pure virtual |
Return the number of encoded directions.
Implemented in vtkRecursiveSphereDirectionEncoder, and vtkSphericalDirectionEncoder.
|
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:
- /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/Volume/vtkDirectionEncoder.h
