VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkFrustumCoverageCuller Class Reference

cull props based on frustum coverage More...

#include <vtkFrustumCoverageCuller.h>

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

List of all members.

Public Types

typedef vtkCuller Superclass
- Public Types inherited from vtkCuller
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetMinimumCoverage (double)
virtual double GetMinimumCoverage ()
virtual void SetMaximumCoverage (double)
virtual double GetMaximumCoverage ()
virtual void SetSortingStyle (int)
virtual int GetSortingStyle ()
void SetSortingStyleToNone ()
void SetSortingStyleToBackToFront ()
void SetSortingStyleToFrontToBack ()
const char * GetSortingStyleAsString (void)
double Cull (vtkRenderer *ren, vtkProp **propList, int &listLength, int &initialized)

Static Public Member Functions

static vtkFrustumCoverageCullerNew ()
static int IsTypeOf (const char *type)
static vtkFrustumCoverageCullerSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkFrustumCoverageCuller ()
 ~vtkFrustumCoverageCuller ()
- Protected Member Functions inherited from vtkCuller
 vtkCuller ()
 ~vtkCuller ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

double MinimumCoverage
double MaximumCoverage
int SortingStyle

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 MinumumCoverage, 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 49 of file vtkFrustumCoverageCuller.h.


Member Typedef Documentation

Reimplemented from vtkCuller.

Definition at line 53 of file vtkFrustumCoverageCuller.h.


Constructor & Destructor Documentation

vtkFrustumCoverageCuller::vtkFrustumCoverageCuller ( )
protected
vtkFrustumCoverageCuller::~vtkFrustumCoverageCuller ( )
inlineprotected

Definition at line 98 of file vtkFrustumCoverageCuller.h.


Member Function Documentation

static vtkFrustumCoverageCuller* vtkFrustumCoverageCuller::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkFrustumCoverageCuller::GetClassName ( )
virtual

Reimplemented from vtkCuller.

static int vtkFrustumCoverageCuller::IsTypeOf ( const char *  name)
static

Return 1 if this class type 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.

virtual int 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.

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

Reimplemented from vtkCuller.

void vtkFrustumCoverageCuller::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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.

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)

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)

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)

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)

virtual void vtkFrustumCoverageCuller::SetSortingStyle ( int  )
virtual

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

virtual int vtkFrustumCoverageCuller::GetSortingStyle ( )
virtual

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

void vtkFrustumCoverageCuller::SetSortingStyleToNone ( )
inline

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

Definition at line 76 of file vtkFrustumCoverageCuller.h.

void vtkFrustumCoverageCuller::SetSortingStyleToBackToFront ( )
inline

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

Definition at line 78 of file vtkFrustumCoverageCuller.h.

void vtkFrustumCoverageCuller::SetSortingStyleToFrontToBack ( )
inline

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

Definition at line 80 of file vtkFrustumCoverageCuller.h.

const char* vtkFrustumCoverageCuller::GetSortingStyleAsString ( void  )

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

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

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

double vtkFrustumCoverageCuller::MinimumCoverage
protected

Definition at line 98 of file vtkFrustumCoverageCuller.h.

double vtkFrustumCoverageCuller::MaximumCoverage
protected

Definition at line 101 of file vtkFrustumCoverageCuller.h.

int vtkFrustumCoverageCuller::SortingStyle
protected

Definition at line 102 of file vtkFrustumCoverageCuller.h.


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