vtkFrustumSource Class Reference

#include <vtkFrustumSource.h>

Inheritance diagram for vtkFrustumSource:

Inheritance graph
[legend]
Collaboration diagram for vtkFrustumSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

create a polygonal representation of a frustum

vtkFrustumSource creates a frustum defines by a set of planes. The frustum is represented with four-sided polygons. It is possible to specify extra lines to better visualize the field of view.

Usage:
Typical use consists of 3 steps: 1. get the planes coefficients from a vtkCamera with vtkCamera::GetFrustumPlanes() 2. initialize the planes with vtkPlanes::SetFrustumPlanes() with the planes coefficients 3. pass the vtkPlanes to a vtkFrustumSource.

Definition at line 37 of file vtkFrustumSource.h.


Public Types

typedef vtkPolyDataAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetPlanes (vtkPlanes *planes)
unsigned long GetMTime ()
virtual vtkPlanesGetPlanes ()
virtual bool GetShowLines ()
virtual void SetShowLines (bool)
virtual void ShowLinesOn ()
virtual void ShowLinesOff ()
virtual double GetLinesLength ()
virtual void SetLinesLength (double)

Static Public Member Functions

static vtkFrustumSourceNew ()
static int IsTypeOf (const char *type)
static vtkFrustumSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkFrustumSource ()
virtual ~vtkFrustumSource ()
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
void ComputePoint (int planes[3], double *pt)

Protected Attributes

vtkPlanesPlanes
bool ShowLines
double LinesLength

Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 41 of file vtkFrustumSource.h.


Constructor & Destructor Documentation

vtkFrustumSource::vtkFrustumSource (  )  [protected]

Default construtor. Planes=NULL. ShowLines=true. LinesLength=1.0.

virtual vtkFrustumSource::~vtkFrustumSource (  )  [protected, virtual]


Member Function Documentation

static vtkFrustumSource* vtkFrustumSource::New (  )  [static]

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

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkFrustumSource::GetClassName (  )  [virtual]

Reimplemented from vtkPolyDataAlgorithm.

static int vtkFrustumSource::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 vtkPolyDataAlgorithm.

virtual int vtkFrustumSource::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 vtkPolyDataAlgorithm.

static vtkFrustumSource* vtkFrustumSource::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkPolyDataAlgorithm.

void vtkFrustumSource::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 vtkPolyDataAlgorithm.

virtual vtkPlanes* vtkFrustumSource::GetPlanes (  )  [virtual]

Return the 6 planes defining the frustum. Initial value is NULL. The 6 planes are defined in this order: left,right,bottom,top,far,near. If Planes==NULL or if Planes->GetNumberOfPlanes()!=6 when RequestData() is called, an error message will be emitted and RequestData() will return right away.

virtual void vtkFrustumSource::SetPlanes ( vtkPlanes planes  )  [virtual]

Set the 6 planes defining the frustum.

virtual bool vtkFrustumSource::GetShowLines (  )  [virtual]

Tells if some extra lines will be generated. Initial value is true.

virtual void vtkFrustumSource::SetShowLines ( bool   )  [virtual]

Tells if some extra lines will be generated. Initial value is true.

virtual void vtkFrustumSource::ShowLinesOn (  )  [virtual]

Tells if some extra lines will be generated. Initial value is true.

virtual void vtkFrustumSource::ShowLinesOff (  )  [virtual]

Tells if some extra lines will be generated. Initial value is true.

virtual double vtkFrustumSource::GetLinesLength (  )  [virtual]

Length of the extra lines. This a stricly positive value. Initial value is 1.0.

virtual void vtkFrustumSource::SetLinesLength ( double   )  [virtual]

Length of the extra lines. This a stricly positive value. Initial value is 1.0.

unsigned long vtkFrustumSource::GetMTime (  )  [virtual]

Modified GetMTime because of Planes.

Reimplemented from vtkObject.

virtual int vtkFrustumSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

void vtkFrustumSource::ComputePoint ( int  planes[3],
double *  pt 
) [protected]

Compute the intersection of 3 planes.


Member Data Documentation

Definition at line 89 of file vtkFrustumSource.h.

bool vtkFrustumSource::ShowLines [protected]

Definition at line 90 of file vtkFrustumSource.h.

double vtkFrustumSource::LinesLength [protected]

Definition at line 91 of file vtkFrustumSource.h.


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

Generated on Mon Sep 27 18:24:33 2010 for VTK by  doxygen 1.5.6