cull props based on frustum coverage More...

#include <vtkFrustumCoverageCuller.h>

Inheritance diagram for vtkFrustumCoverageCuller:

Collaboration diagram for vtkFrustumCoverageCuller:

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.

vtkFrustumCoverageCuller *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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.


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

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


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)

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)


virtual void	SetSortingStyle (int)
	Set the sorting style - none, front-to-back or back-to-front The default is none.

virtual int	GetSortingStyle ()
	Set the sorting style - none, front-to-back or back-to-front The default is none.

void	SetSortingStyleToNone ()
	Set the sorting style - none, front-to-back or back-to-front The default is none.

void	SetSortingStyleToBackToFront ()
	Set the sorting style - none, front-to-back or back-to-front The default is none.

void	SetSortingStyleToFrontToBack ()
	Set the sorting style - none, front-to-back or back-to-front The default is none.

const char *	GetSortingStyleAsString (void)
	Set the sorting style - none, front-to-back or back-to-front The default is none.

Public Member Functions inherited from vtkCuller
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkCuller *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

virtual double	Cull (vtkRenderer ren, vtkProp *propList, int &listLength, int &initialized)=0
	This is called outside the render loop by vtkRenderer.

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.

vtkCommand *	GetCommand (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.

Static Public Member Functions
static vtkFrustumCoverageCuller *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkFrustumCoverageCuller *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkCuller
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCuller *	SafeDownCast (vtkObjectBase *o)

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.

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 vtkObjectBase *	New ()
	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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkFrustumCoverageCuller ()

	~vtkFrustumCoverageCuller () override=default

Protected Member Functions inherited from vtkCuller
virtual vtkObjectBase *	NewInstanceInternal () const

	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.

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 &)

Protected Attributes
double	MinimumCoverage

double	MaximumCoverage

int	SortingStyle

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

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

Definition at line 48 of file vtkFrustumCoverageCuller.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCuller vtkFrustumCoverageCuller::Superclass

Definition at line 52 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)