VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkFrustumSource Class Reference

create a polygonal representation of a frustum More...

#include <vtkFrustumSource.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkFrustumSource * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetPlanes (vtkPlanes *planes)
 
unsigned long GetMTime ()
 
virtual vtkPlanes * GetPlanes ()
 
virtual bool GetShowLines ()
 
virtual void SetShowLines (bool)
 
virtual void ShowLinesOn ()
 
virtual void ShowLinesOff ()
 
virtual double GetLinesLength ()
 
virtual void SetLinesLength (double)
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObject * GetInput ()
 
vtkDataObject * GetInput (int port)
 
vtkPolyData * GetPolyDataInput (int port)
 
vtkPolyData * GetOutput ()
 
vtkPolyData * GetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm * NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutive * GetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformation * GetInputPortInformation (int port)
 
vtkInformation * GetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformation * GetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObject * GetOutputDataObject (int port)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, int idx)
 
virtual void RemoveAllInputConnections (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutput * GetInputConnection (int port, int index)
 
vtkAlgorithm * GetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithm * GetInputAlgorithm (int port, int index)
 
vtkExecutive * GetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformation * GetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObject * GetInputDataObject (int port, int connection)
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutput * GetOutputPort (int index)
 
vtkAlgorithmOutput * GetOutputPort ()
 
vtkAlgorithm * GetInputAlgorithm ()
 
vtkExecutive * GetInputExecutive ()
 
vtkInformation * GetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
void SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int piece, int numPieces, int ghostLevel)
 
void SetUpdateExtent (int extent[6])
 
int * GetUpdateExtent ()
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 

Static Public Member Functions

static vtkFrustumSource * New ()
 
static int IsTypeOf (const char *type)
 
static vtkFrustumSource * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm * New ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithm * SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm * New ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithm * SafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKey * INPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKey * INPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey * 		INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey * 		INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey * 		INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKey * INPUT_PORT ()
 
static vtkInformationIntegerKey * INPUT_CONNECTION ()
 
static vtkInformationIntegerKey * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkFrustumSource ()
 
virtual ~vtkFrustumSource ()
 
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
void ComputePoint (int planes[3], double *pt)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutive * CreateDefaultExecutive ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void SetNumberOfInputConnections (int port, int n)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArray * GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArray * GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArray * GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformation * GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
virtual void SetErrorCode (unsigned long)
 

Protected Attributes

vtkPlanes * Planes
 
bool ShowLines
 
double LinesLength
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey * PORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive * DefaultExecutivePrototype
 

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 38 of file vtkFrustumSource.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkFrustumSource::Superclass

Definition at line 42 of file vtkFrustumSource.h.

Constructor & Destructor Documentation

vtkFrustumSource::vtkFrustumSource ( )
protected

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

virtual vtkFrustumSource::~vtkFrustumSource ( )
protectedvirtual

Member Function Documentation

static vtkFrustumSource* vtkFrustumSource::New ( )
static
static int vtkFrustumSource::IsTypeOf ( const char *  type)
static
virtual int vtkFrustumSource::IsA ( const char *  type)
virtual

Reimplemented from vtkPolyDataAlgorithm.

static vtkFrustumSource* vtkFrustumSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkFrustumSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkFrustumSource* vtkFrustumSource::NewInstance ( ) const
void vtkFrustumSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 ( )

Modified GetMTime because of Planes.

virtual int vtkFrustumSource::RequestData ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

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

vtkPlanes* vtkFrustumSource::Planes
protected

Definition at line 90 of file vtkFrustumSource.h.

bool vtkFrustumSource::ShowLines
protected

Definition at line 91 of file vtkFrustumSource.h.

double vtkFrustumSource::LinesLength
protected

Definition at line 92 of file vtkFrustumSource.h.

The documentation for this class was generated from the following file:
Generated on Sat Apr 12 2014 01:08:05 for VTK by   doxygen 1.8.6