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

cull props based on frustum coverage More...

#include <vtkFrustumCoverageCuller.h>

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

Public Types

typedef vtkCuller Superclass
 
- Public Types inherited from vtkCuller
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...
 
vtkFrustumCoverageCullerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
double Cull (vtkRenderer *ren, vtkProp **propList, int &listLength, int &initialized) override
 WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Perform the cull operation This method should only be called by vtkRenderer as part of the render process. More...
 
virtual void SetMinimumCoverage (double)
 Set/Get the minimum coverage - props with less coverage than this are given no time to render (they are culled) More...
 
virtual double GetMinimumCoverage ()
 Set/Get the minimum coverage - props with less coverage than this are given no time to render (they are culled) More...
 
virtual void SetMaximumCoverage (double)
 Set/Get the maximum coverage - props with more coverage than this are given an allocated render time of 1.0 (the maximum) More...
 
virtual double GetMaximumCoverage ()
 Set/Get the maximum coverage - props with more coverage than this are given an allocated render time of 1.0 (the maximum) More...
 
virtual void SetSortingStyle (int)
 Set the sorting style - none, front-to-back or back-to-front The default is none. More...
 
virtual int GetSortingStyle ()
 Set the sorting style - none, front-to-back or back-to-front The default is none. More...
 
void SetSortingStyleToNone ()
 Set the sorting style - none, front-to-back or back-to-front The default is none. More...
 
void SetSortingStyleToBackToFront ()
 Set the sorting style - none, front-to-back or back-to-front The default is none. More...
 
void SetSortingStyleToFrontToBack ()
 Set the sorting style - none, front-to-back or back-to-front The default is none. More...
 
const char * GetSortingStyleAsString (void)
 Set the sorting style - none, front-to-back or back-to-front The default is none. More...
 
- Public Member Functions inherited from vtkCuller
vtkCullerNewInstance () 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...
 
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)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 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...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. 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...
 
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...
 
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...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkFrustumCoverageCullerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkFrustumCoverageCullerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCuller
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCullerSafeDownCast (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
 
 vtkFrustumCoverageCuller ()
 
 ~vtkFrustumCoverageCuller () override=default
 
- Protected Member Functions inherited from vtkCuller
 vtkCuller ()
 
 ~vtkCuller () 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double MinimumCoverage
 
double MaximumCoverage
 
int SortingStyle
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- 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

cull props based on frustum coverage

vtkFrustumCoverageCuller will cull props based on the coverage in the view frustum. The coverage is computed by enclosing the prop in a bounding sphere, projecting that to the viewing coordinate system, then taking a slice through the view frustum at the center of the sphere. This results in a circle on the plane slice through the view frustum. This circle is enclosed in a squared, and the fraction of the plane slice that this square covers is the coverage. This is a number between 0 and 1. If the number is less than the MinimumCoverage, the allocated render time for that prop is set to zero. If it is greater than the MaximumCoverage, the allocated render time is set to 1.0. In between, a linear ramp is used to convert coverage into allocated render time.

See also
vtkCuller
Tests:
vtkFrustumCoverageCuller (Tests)

Definition at line 51 of file vtkFrustumCoverageCuller.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 of file vtkFrustumCoverageCuller.h.

Constructor & Destructor Documentation

◆ vtkFrustumCoverageCuller()

vtkFrustumCoverageCuller::vtkFrustumCoverageCuller ( )
protected

◆ ~vtkFrustumCoverageCuller()

vtkFrustumCoverageCuller::~vtkFrustumCoverageCuller ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkFrustumCoverageCuller* vtkFrustumCoverageCuller::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkFrustumCoverageCuller::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 vtkCuller.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkFrustumCoverageCuller::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCuller.

◆ NewInstance()

vtkFrustumCoverageCuller* vtkFrustumCoverageCuller::NewInstance ( ) const

◆ PrintSelf()

void vtkFrustumCoverageCuller::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 vtkCuller.

◆ SetMinimumCoverage()

virtual void vtkFrustumCoverageCuller::SetMinimumCoverage ( double  )
virtual

Set/Get the minimum coverage - props with less coverage than this are given no time to render (they are culled)

◆ GetMinimumCoverage()

virtual double vtkFrustumCoverageCuller::GetMinimumCoverage ( )
virtual

Set/Get the minimum coverage - props with less coverage than this are given no time to render (they are culled)

◆ SetMaximumCoverage()

virtual void vtkFrustumCoverageCuller::SetMaximumCoverage ( double  )
virtual

Set/Get the maximum coverage - props with more coverage than this are given an allocated render time of 1.0 (the maximum)

◆ GetMaximumCoverage()

virtual double vtkFrustumCoverageCuller::GetMaximumCoverage ( )
virtual

Set/Get the maximum coverage - props with more coverage than this are given an allocated render time of 1.0 (the maximum)

◆ SetSortingStyle()

virtual void vtkFrustumCoverageCuller::SetSortingStyle ( int  )
virtual

Set the sorting style - none, front-to-back or back-to-front The default is none.

◆ GetSortingStyle()

virtual int vtkFrustumCoverageCuller::GetSortingStyle ( )
virtual

Set the sorting style - none, front-to-back or back-to-front The default is none.

◆ SetSortingStyleToNone()

void vtkFrustumCoverageCuller::SetSortingStyleToNone ( )
inline

Set the sorting style - none, front-to-back or back-to-front The default is none.

Definition at line 83 of file vtkFrustumCoverageCuller.h.

◆ SetSortingStyleToBackToFront()

void vtkFrustumCoverageCuller::SetSortingStyleToBackToFront ( )
inline

Set the sorting style - none, front-to-back or back-to-front The default is none.

Definition at line 84 of file vtkFrustumCoverageCuller.h.

◆ SetSortingStyleToFrontToBack()

void vtkFrustumCoverageCuller::SetSortingStyleToFrontToBack ( )
inline

Set the sorting style - none, front-to-back or back-to-front The default is none.

Definition at line 85 of file vtkFrustumCoverageCuller.h.

◆ GetSortingStyleAsString()

const char* vtkFrustumCoverageCuller::GetSortingStyleAsString ( void  )

Set the sorting style - none, front-to-back or back-to-front The default is none.

◆ Cull()

double vtkFrustumCoverageCuller::Cull ( vtkRenderer ren,
vtkProp **  propList,
int &  listLength,
int &  initialized 
)
overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Perform the cull operation This method should only be called by vtkRenderer as part of the render process.

Implements vtkCuller.

Member Data Documentation

◆ MinimumCoverage

double vtkFrustumCoverageCuller::MinimumCoverage
protected

Definition at line 102 of file vtkFrustumCoverageCuller.h.

◆ MaximumCoverage

double vtkFrustumCoverageCuller::MaximumCoverage
protected

Definition at line 103 of file vtkFrustumCoverageCuller.h.

◆ SortingStyle

int vtkFrustumCoverageCuller::SortingStyle
protected

Definition at line 104 of file vtkFrustumCoverageCuller.h.


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