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

generate polygonal model of spatial search object (i.e., a vtkLocator) More...

#include <vtkSpatialRepresentationFilter.h>

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

Public Types

typedef vtkPolyDataSource Superclass
- Public Types inherited from vtkPolyDataSource
typedef vtkSource Superclass
- Public Types inherited from vtkSource
typedef vtkProcessObject Superclass
- Public Types inherited from vtkProcessObject
typedef vtkAlgorithm Superclass
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkPolyDataGetOutput (int level)
vtkPolyDataGetOutput ()
void ResetOutput ()
virtual void SetSpatialRepresentation (vtkLocator *)
virtual vtkLocatorGetSpatialRepresentation ()
virtual int GetLevel ()
virtual void SetInput (vtkDataSet *input)
vtkDataSetGetInput ()
- Public Member Functions inherited from vtkPolyDataSource
void SetOutput (vtkPolyData *output)
- Public Member Functions inherited from vtkSource
virtual void Update ()
virtual void UpdateWholeExtent ()
virtual void UpdateInformation ()
virtual void PropagateUpdateExtent (vtkDataObject *output)
virtual void TriggerAsynchronousUpdate ()
virtual void UpdateData (vtkDataObject *output)
void UnRegisterAllOutputs (void)
int GetOutputIndex (vtkDataObject *out)
virtual void SetExecutive (vtkExecutive *executive)
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
virtual void ReleaseDataFlagOn ()
virtual void ReleaseDataFlagOff ()
vtkDataObject ** GetOutputs ()
virtual int GetNumberOfOutputs ()
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
- Public Member Functions inherited from vtkProcessObject
void SqueezeInputArray ()
void RemoveAllInputs ()
vtkDataObject ** GetInputs ()
int GetNumberOfInputs ()
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetNumberOfInputConnections (int port, int n)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
vtkDataObjectGetOutputDataObject (int port)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (int port, int connection)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static
vtkSpatialRepresentationFilter
New ()
static int IsTypeOf (const char *type)
static
vtkSpatialRepresentationFilter
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkSpatialRepresentationFilter ()
 ~vtkSpatialRepresentationFilter ()
void Execute ()
void GenerateOutput ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual int FillInputPortInformation (int, vtkInformation *)
- Protected Member Functions inherited from vtkPolyDataSource
 vtkPolyDataSource ()
 ~vtkPolyDataSource ()
void ComputeInputUpdateExtents (vtkDataObject *output)
int FillOutputPortInformation (int, vtkInformation *)
- Protected Member Functions inherited from vtkSource
 vtkSource ()
 ~vtkSource ()
virtual void ExecuteData (vtkDataObject *output)
virtual void ExecuteInformation ()
virtual void MarkGeneratedOutputs (vtkDataObject *)
void SetNumberOfOutputs (int num)
virtual void SetNthOutput (int num, vtkDataObject *output)
virtual void AddOutput (vtkDataObject *output)
virtual void RemoveOutput (vtkDataObject *output)
virtual void SetNumberOfOutputPorts (int n)
- Protected Member Functions inherited from vtkProcessObject
void SetNumberOfInputs (int num)
virtual void SetNthInput (int num, vtkDataObject *input)
virtual void AddInput (vtkDataObject *input)
virtual void RemoveInput (vtkDataObject *input)
void AddInputInternal (vtkDataObject *input)
void RemoveInputInternal (vtkDataObject *input)
void SetupInputs ()
 vtkProcessObject ()
 ~vtkProcessObject ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetErrorCode (unsigned long)
- 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)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int Level
int TerminalNodesRequested
vtkLocatorSpatialRepresentation

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

Detailed Description

generate polygonal model of spatial search object (i.e., a vtkLocator)

vtkSpatialRepresentationFilter generates an polygonal representation of a spatial search (vtkLocator) object. The representation varies depending upon the nature of the spatial search object. For example, the representation for vtkOBBTree is a collection of oriented bounding boxes. Ths input to this filter is a dataset of any type, and the output is polygonal data. You must also specify the spatial search object to use.

Generally spatial search objects are used for collision detection and other geometric operations, but in this filter one or more levels of spatial searchers can be generated to form a geometric approximation to the input data. This is a form of data simplification, generally used to accelerate the rendering process. Or, this filter can be used as a debugging/ visualization aid for spatial search objects.

This filter can generate one or more output vtkPolyData corresponding to different levels in the spatial search tree. The output data is retrieved using the GetOutput(id) method, where id ranges from 0 (root level) to Level. Note that the output for level "id" is not computed unless a GetOutput(id) method is issued. Thus, if you desire three levels of output (say 2,4,7), you would have to invoke GetOutput(2), GetOutput(4), and GetOutput(7). (Also note that the Level ivar is computed automatically depending on the size and nature of the input data.) There is also another GetOutput() method that takes no parameters. This method returns the leafs of the spatial search tree, which may be at different levels.

Warning
You can specify the number of levels of to generate with the MaxLevels ivar. However, when the spatial search tree is built, this number of levels may not actually be generated. The actual number available can be found in the Levels ivar. Note that the value of Levels may change after filter execution.
See Also
vtkLocator vtkPointLocator vtkCellLocator vtkOBBTree
Tests:
vtkSpatialRepresentationFilter (Tests)

Definition at line 68 of file vtkSpatialRepresentationFilter.h.

Member Typedef Documentation

Definition at line 72 of file vtkSpatialRepresentationFilter.h.

Constructor & Destructor Documentation

vtkSpatialRepresentationFilter::vtkSpatialRepresentationFilter ( )
protected
vtkSpatialRepresentationFilter::~vtkSpatialRepresentationFilter ( )
protected

Member Function Documentation

static vtkSpatialRepresentationFilter* vtkSpatialRepresentationFilter::New ( )
static

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

Reimplemented from vtkAlgorithm.

virtual const char* vtkSpatialRepresentationFilter::GetClassName ( )
virtual

Reimplemented from vtkPolyDataSource.

static int vtkSpatialRepresentationFilter::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 vtkPolyDataSource.

virtual int vtkSpatialRepresentationFilter::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 vtkPolyDataSource.

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

Reimplemented from vtkPolyDataSource.

void vtkSpatialRepresentationFilter::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 vtkPolyDataSource.

virtual void vtkSpatialRepresentationFilter::SetSpatialRepresentation ( vtkLocator )
virtual

Set/Get the locator that will be used to generate the representation.

virtual vtkLocator* vtkSpatialRepresentationFilter::GetSpatialRepresentation ( )
virtual

Set/Get the locator that will be used to generate the representation.

virtual int vtkSpatialRepresentationFilter::GetLevel ( )
virtual

Get the maximum number of outputs actually available.

vtkPolyData* vtkSpatialRepresentationFilter::GetOutput ( int  level)

A special form of the GetOutput() method that returns multiple outputs.

Reimplemented from vtkPolyDataSource.

vtkPolyData* vtkSpatialRepresentationFilter::GetOutput ( )

Output of terminal nodes/leaves.

Reimplemented from vtkPolyDataSource.

void vtkSpatialRepresentationFilter::ResetOutput ( )

Reset requested output levels

virtual void vtkSpatialRepresentationFilter::SetInput ( vtkDataSet input)
virtual

Set / get the input data or filter.

vtkDataSet* vtkSpatialRepresentationFilter::GetInput ( )

Set / get the input data or filter.

void vtkSpatialRepresentationFilter::Execute ( )
protectedvirtual

This method is the old style execute method

Reimplemented from vtkSource.

void vtkSpatialRepresentationFilter::GenerateOutput ( )
protected
virtual void vtkSpatialRepresentationFilter::ReportReferences ( vtkGarbageCollector )
protectedvirtual

Reimplemented from vtkSource.

virtual int vtkSpatialRepresentationFilter::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkProcessObject.

Member Data Documentation

int vtkSpatialRepresentationFilter::Level
protected

Definition at line 109 of file vtkSpatialRepresentationFilter.h.

int vtkSpatialRepresentationFilter::TerminalNodesRequested
protected

Definition at line 110 of file vtkSpatialRepresentationFilter.h.

vtkLocator* vtkSpatialRepresentationFilter::SpatialRepresentation
protected

Definition at line 112 of file vtkSpatialRepresentationFilter.h.


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