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

A simple implementation of vtkCellDepthSort. More...

#include <vtkCellCenterDepthSort.h>

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

Public Types

typedef vtkVisibilitySort Superclass
 
- Public Types inherited from vtkVisibilitySort
enum  { BACK_TO_FRONT, FRONT_TO_BACK }
 
typedef vtkObject Superclass
 

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...
 
vtkCellCenterDepthSortNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void InitTraversal () override
 To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process. More...
 
vtkIdTypeArrayGetNextCells () override
 To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process. More...
 
- Public Member Functions inherited from vtkVisibilitySort
vtkVisibilitySortNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkMatrix4x4GetInverseModelTransform ()
 
virtual void SetMaxCellsReturned (int)
 Set/Get the maximum number of cells that GetNextCells will return in one invocation. More...
 
virtual int GetMaxCellsReturned ()
 Set/Get the maximum number of cells that GetNextCells will return in one invocation. More...
 
virtual void SetModelTransform (vtkMatrix4x4 *mat)
 Set/Get the matrix that transforms from object space to world space. More...
 
virtual vtkMatrix4x4GetModelTransform ()
 Set/Get the matrix that transforms from object space to world space. More...
 
virtual void SetCamera (vtkCamera *camera)
 Set/Get the camera that specifies the viewing parameters. More...
 
virtual vtkCameraGetCamera ()
 Set/Get the camera that specifies the viewing parameters. More...
 
virtual void SetInput (vtkDataSet *data)
 Set/Get the data set containing the cells to sort. More...
 
virtual vtkDataSetGetInput ()
 Set/Get the data set containing the cells to sort. More...
 
virtual int GetDirection ()
 Set/Get the sorting direction. More...
 
virtual void SetDirection (int)
 Set/Get the sorting direction. More...
 
void SetDirectionToBackToFront ()
 Set/Get the sorting direction. More...
 
void SetDirectionToFrontToBack ()
 Set/Get the sorting direction. More...
 
void Register (vtkObjectBase *o) override
 Overwritten to enable garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Overwritten to enable garbage collection. 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...
 
vtkCommandGetCommand (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 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...
 
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...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellCenterDepthSortSafeDownCast (vtkObjectBase *o)
 
static vtkCellCenterDepthSortNew ()
 
- Static Public Member Functions inherited from vtkVisibilitySort
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVisibilitySortSafeDownCast (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 ()
 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 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkCellCenterDepthSort ()
 
 ~vtkCellCenterDepthSort () override
 
virtual float * ComputeProjectionVector ()
 
virtual void ComputeCellCenters ()
 
virtual void ComputeDepths ()
 
- Protected Member Functions inherited from vtkVisibilitySort
 vtkVisibilitySort ()
 
 ~vtkVisibilitySort () override
 
void ReportReferences (vtkGarbageCollector *collector) 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 ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkIdTypeArraySortedCells
 
vtkIdTypeArraySortedCellPartition
 
vtkFloatArrayCellCenters
 
vtkFloatArrayCellDepths
 
vtkFloatArrayCellPartitionDepths
 
- Protected Attributes inherited from vtkVisibilitySort
vtkTimeStamp LastSortTime
 
vtkMatrix4x4ModelTransform
 
vtkMatrix4x4InverseModelTransform
 
vtkCameraCamera
 
vtkDataSetInput
 
int MaxCellsReturned
 
int Direction
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- 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 simple implementation of vtkCellDepthSort.

vtkCellCenterDepthSort is a simple and fast implementation of depth sort, but it only provides approximate results. The sorting algorithm finds the centroids of all the cells. It then performs the dot product of the centroids against a vector pointing in the direction of the camera transformed into object space. It then performs an ordinary sort on the result.

Definition at line 49 of file vtkCellCenterDepthSort.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkCellCenterDepthSort.h.

Constructor & Destructor Documentation

◆ vtkCellCenterDepthSort()

vtkCellCenterDepthSort::vtkCellCenterDepthSort ( )
protected

◆ ~vtkCellCenterDepthSort()

vtkCellCenterDepthSort::~vtkCellCenterDepthSort ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCellCenterDepthSort::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 vtkVisibilitySort.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCellCenterDepthSort::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkVisibilitySort.

◆ NewInstance()

vtkCellCenterDepthSort* vtkCellCenterDepthSort::NewInstance ( ) const

◆ PrintSelf()

void vtkCellCenterDepthSort::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 vtkObject.

◆ New()

static vtkCellCenterDepthSort* vtkCellCenterDepthSort::New ( )
static

◆ InitTraversal()

void vtkCellCenterDepthSort::InitTraversal ( )
overridevirtual

To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process.

That is, call InitTraversal to start the iteration and call GetNextCells to get the cell IDs in order. However, for efficiencies sake, GetNextCells returns an ordered list of several id's in once call (but not necessarily all). GetNextCells will return NULL once the entire sorted list is output. The vtkIdTypeArray returned from GetNextCells is a cached array, so do not delete it. At the same note, do not expect the array to be valid after subsequent calls to GetNextCells.

Implements vtkVisibilitySort.

◆ GetNextCells()

vtkIdTypeArray* vtkCellCenterDepthSort::GetNextCells ( )
overridevirtual

To facilitate incremental sorting algorithms, the cells are retrieved in an iteration process.

That is, call InitTraversal to start the iteration and call GetNextCells to get the cell IDs in order. However, for efficiencies sake, GetNextCells returns an ordered list of several id's in once call (but not necessarily all). GetNextCells will return NULL once the entire sorted list is output. The vtkIdTypeArray returned from GetNextCells is a cached array, so do not delete it. At the same note, do not expect the array to be valid after subsequent calls to GetNextCells.

Implements vtkVisibilitySort.

◆ ComputeProjectionVector()

virtual float* vtkCellCenterDepthSort::ComputeProjectionVector ( )
protectedvirtual

◆ ComputeCellCenters()

virtual void vtkCellCenterDepthSort::ComputeCellCenters ( )
protectedvirtual

◆ ComputeDepths()

virtual void vtkCellCenterDepthSort::ComputeDepths ( )
protectedvirtual

Member Data Documentation

◆ SortedCells

vtkIdTypeArray* vtkCellCenterDepthSort::SortedCells
protected

Definition at line 63 of file vtkCellCenterDepthSort.h.

◆ SortedCellPartition

vtkIdTypeArray* vtkCellCenterDepthSort::SortedCellPartition
protected

Definition at line 64 of file vtkCellCenterDepthSort.h.

◆ CellCenters

vtkFloatArray* vtkCellCenterDepthSort::CellCenters
protected

Definition at line 66 of file vtkCellCenterDepthSort.h.

◆ CellDepths

vtkFloatArray* vtkCellCenterDepthSort::CellDepths
protected

Definition at line 67 of file vtkCellCenterDepthSort.h.

◆ CellPartitionDepths

vtkFloatArray* vtkCellCenterDepthSort::CellPartitionDepths
protected

Definition at line 68 of file vtkCellCenterDepthSort.h.


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