ParaView
|
vtkPVDataRepresentation adds some ParaView specific API to data representations. More...
#include <vtkPVDataRepresentation.h>
Public Types | |
typedef vtkDataRepresentation | Superclass |
Public Member Functions | |
virtual const char * | GetClassName () |
virtual int | IsA (const char *type) |
void | PrintSelf (ostream &os, vtkIndent indent) |
virtual int | ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo) |
vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More... | |
virtual void | MarkModified () |
This is one of the most important functions. More... | |
virtual unsigned int | Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable) |
Initialize the representation with an identifier range so each internal representation can own a unique ID. More... | |
unsigned int | GetUniqueIdentifier () |
Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More... | |
virtual void | SetVisibility (bool val) |
Get/Set the visibility for this representation. More... | |
virtual bool | GetVisibility () |
virtual vtkDataObject * | GetRenderedDataObject (int vtkNotUsed(port)) |
Returns the data object that is rendered from the given input port. More... | |
virtual void | SetForcedCacheKey (double val) |
Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More... | |
virtual void | SetForceUseCache (bool val) |
bool | GetUsingCacheForUpdate () |
Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More... | |
virtual bool | GetNeedUpdate () |
virtual vtkAlgorithmOutput * | GetInternalOutputPort () |
Retrieves an output port for the input data object at the specified port and connection index. More... | |
virtual vtkAlgorithmOutput * | GetInternalOutputPort (int port) |
virtual vtkAlgorithmOutput * | GetInternalOutputPort (int port, int conn) |
vtkView * | GetView () const |
Provides access to the view. More... | |
virtual void | SetUpdateTime (double time) |
Set the update time. More... | |
virtual double | GetUpdateTime () |
Set the update time. More... | |
virtual bool | GetUpdateTimeValid () |
Set whether the UpdateTime is valid. More... | |
virtual void | SetUseCache (bool) |
virtual void | SetCacheKey (double val) |
virtual double | GetCacheKey () |
Returns whether caching is used and what key to use when caching is enabled. More... | |
virtual bool | GetUseCache () |
Returns whether caching is used and what key to use when caching is enabled. More... | |
virtual bool | AddToView (vtkView *view) |
Making these methods public. More... | |
virtual bool | RemoveFromView (vtkView *view) |
Making these methods public. More... | |
Static Public Member Functions | |
static int | IsTypeOf (const char *type) |
static vtkPVDataRepresentation * | SafeDownCast (vtkObject *o) |
Protected Member Functions | |
vtkPVDataRepresentation () | |
~vtkPVDataRepresentation () | |
virtual bool | IsCached (double cache_key) |
Subclasses should override this method when they support caching to indicate if the particular key is cached. More... | |
virtual vtkExecutive * | CreateDefaultExecutive () |
Create a default executive. More... | |
virtual int | RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
Overridden to invoke vtkCommand::UpdateDataEvent. More... | |
virtual int | RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) |
virtual int | RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *) |
Protected Attributes | |
double | UpdateTime |
bool | UpdateTimeValid |
unsigned int | UniqueIdentifier |
vtkPVDataRepresentation adds some ParaView specific API to data representations.
Definition at line 32 of file vtkPVDataRepresentation.h.
typedef vtkDataRepresentation vtkPVDataRepresentation::Superclass |
Definition at line 35 of file vtkPVDataRepresentation.h.
|
protected |
|
protected |
|
virtual |
Reimplemented in vtkPVPlotMatrixRepresentation, vtkDataLabelRepresentation, vtkImageVolumeRepresentation, vtkChartRepresentation, vtkGeometryRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartSelectionRepresentation, vtkCompositeRepresentation, vtkImageSliceRepresentation, vtkAMROutlineRepresentation, vtkSpreadSheetRepresentation, vtkXYChartRepresentation, vtkStructuredGridVolumeRepresentation, vtkPVCompositeRepresentation, vtkPointGaussianRepresentation, vtkProgressBarSourceRepresentation, vtkPVHistogramChartRepresentation, vtkRulerSourceRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkGlyph3DRepresentation, vtkPVBagChartRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkPVBoxChartRepresentation, vtkPVParallelCoordinatesRepresentation, vtkPythonRepresentation, vtkGeometrySliceRepresentation, vtkMoleculeRepresentation, vtkGeometryRepresentationWithFaces, vtkOutlineRepresentation, and vtkQuartileChartRepresentation.
|
static |
|
virtual |
Reimplemented in vtkPVPlotMatrixRepresentation, vtkDataLabelRepresentation, vtkImageVolumeRepresentation, vtkChartRepresentation, vtkGeometryRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartSelectionRepresentation, vtkCompositeRepresentation, vtkImageSliceRepresentation, vtkAMROutlineRepresentation, vtkSpreadSheetRepresentation, vtkXYChartRepresentation, vtkStructuredGridVolumeRepresentation, vtkPVCompositeRepresentation, vtkPointGaussianRepresentation, vtkProgressBarSourceRepresentation, vtkPVHistogramChartRepresentation, vtkRulerSourceRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkGlyph3DRepresentation, vtkPVBagChartRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkPVBoxChartRepresentation, vtkPVParallelCoordinatesRepresentation, vtkPythonRepresentation, vtkGeometrySliceRepresentation, vtkMoleculeRepresentation, vtkGeometryRepresentationWithFaces, vtkOutlineRepresentation, and vtkQuartileChartRepresentation.
|
static |
void vtkPVDataRepresentation::PrintSelf | ( | ostream & | os, |
vtkIndent | indent | ||
) |
|
virtual |
vtkAlgorithm::ProcessRequest() equivalent for rendering passes.
This is typically called by the vtkView to request meta-data from the representations or ask them to perform certain tasks e.g. PrepareForRendering. Overridden to skip processing when visibility if off.
Reimplemented in vtkRulerSourceRepresentation, vtkDataLabelRepresentation, vtkChartRepresentation, vtkImageSliceRepresentation, vtkAMRStreamingVolumeRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkProgressBarSourceRepresentation, vtkTextSourceRepresentation, vtkStructuredGridVolumeRepresentation, vtkImageVolumeRepresentation, vtkGeometryRepresentation, vtkGeometryRepresentationWithFaces, vtkAMROutlineRepresentation, vtkGlyph3DRepresentation, vtkPythonRepresentation, vtkPointGaussianRepresentation, vtkGeometrySliceRepresentation, and vtkMoleculeRepresentation.
|
virtual |
This is one of the most important functions.
In VTK pipelines, it's very easy for the pipeline to decide when it needs to re-execute. vtkAlgorithm::Update() can go up the entire pipeline to see if any filters MTime changed (among other things) and if so, it can re-execute the pipeline. However in case of representations, the real input connection may only be present on the data-server nodes. In that case the vtkPVDataRepresentation::RequestData() will only get called on the data-server nodes. That means that representations won't be able to any data-delivery in RequestData(). We'd need some other mechanisms to synchronize data-delivery among processes. To avoid that conundrum, the vtkSMRepresentationProxy calls MarkModified() on all processes whenever any filter in the pipeline is modified. In this method, the vtkPVDataRepresentation subclasses should ensure that they mark all delivery related filters dirty in their RequestData to ensure they execute then next time they are updated. The vtkPVDataRepresentation also uses a special executive which avoids updating the representation unless MarkModified() was called since the last Update(), thus acting as a update-suppressor.
Reimplemented in vtkCompositeRepresentation, vtkImageSliceRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkChartRepresentation, vtkImageVolumeRepresentation, vtkGeometryRepresentation, vtkSelectionRepresentation, vtkRulerSourceRepresentation, vtkDataLabelRepresentation, vtkMoleculeRepresentation, vtkPVCompositeRepresentation, vtkChartSelectionRepresentation, vtkProgressBarSourceRepresentation, vtkTextSourceRepresentation, and vtkSpreadSheetRepresentation.
|
virtual |
Initialize the representation with an identifier range so each internal representation can own a unique ID.
If a representation requires more IDs than the set of ids provided, the representation MUST complains by an error or abort explaining how many ids where expected so the number of reserved ids could be easily adjust. Unless noted otherwise, this method must be called before calling any other methods on this class. Internally you can pick an id that follow that condition minIdAvailable <= id <= maxIdAvailable Return the minIdAvailable after initialization so that new range could be used
Reimplemented in vtkSelectionRepresentation, vtkChartRepresentation, vtkPVCompositeRepresentation, and vtkPVCompositeOrthographicSliceRepresentation.
|
inline |
Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object.
Definition at line 89 of file vtkPVDataRepresentation.h.
|
inlinevirtual |
Get/Set the visibility for this representation.
When the visibility of representation of false, all view passes are ignored.
Reimplemented in vtkImageSliceRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkSelectionRepresentation, vtkAMRStreamingVolumeRepresentation, vtkImageVolumeRepresentation, vtkGeometryRepresentation, vtkRulerSourceRepresentation, vtkDataLabelRepresentation, vtkPVPlotMatrixRepresentation, vtkChartRepresentation, vtkGlyph3DRepresentation, vtkPVCompositeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkChartSelectionRepresentation, vtkGeometryRepresentationWithFaces, vtkAMROutlineRepresentation, vtkProgressBarSourceRepresentation, vtkTextSourceRepresentation, vtkPointGaussianRepresentation, vtkCompositeRepresentation, vtkXYChartRepresentation, vtkPVBagChartRepresentation, vtkPVBoxChartRepresentation, vtkPVParallelCoordinatesRepresentation, and vtkMoleculeRepresentation.
Definition at line 95 of file vtkPVDataRepresentation.h.
|
virtual |
Reimplemented in vtkDataLabelRepresentation.
|
inlinevirtual |
Returns the data object that is rendered from the given input port.
Definition at line 101 of file vtkPVDataRepresentation.h.
|
virtual |
Set the update time.
Reimplemented in vtkCompositeRepresentation, vtkSelectionRepresentation, and vtkPVCompositeRepresentation.
|
virtual |
Set the update time.
|
virtual |
Set whether the UpdateTime is valid.
|
virtual |
Simply remove these methods from your subclass implementation.
|
virtual |
Simply remove these methods from your subclass implementation.
|
inlinevirtual |
Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey.
However in some cases we may want to force a representation to cache irrespective of the view (e.g. comparative views). In which case these ivars can up set. If ForcedCacheKey is true, it overrides UseCache and CacheKey. Instead, ForcedCacheKey is used.
Reimplemented in vtkCompositeRepresentation, vtkSelectionRepresentation, and vtkPVCompositeRepresentation.
Definition at line 138 of file vtkPVDataRepresentation.h.
|
inlinevirtual |
Reimplemented in vtkCompositeRepresentation, vtkSelectionRepresentation, and vtkPVCompositeRepresentation.
Definition at line 139 of file vtkPVDataRepresentation.h.
|
virtual |
Returns whether caching is used and what key to use when caching is enabled.
|
virtual |
Returns whether caching is used and what key to use when caching is enabled.
bool vtkPVDataRepresentation::GetUsingCacheForUpdate | ( | ) |
Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update.
If so, it bypasses all pipeline passes. Subclasses should override IsCached(double) to indicate if a particular entry is cached.
|
virtual |
|
virtual |
Making these methods public.
When constructing composite representations, we need to call these methods directly on internal representations.
Reimplemented in vtkGeometryRepresentation, vtkPVBagChartRepresentation, vtkChartRepresentation, vtkImageSliceRepresentation, vtkPointGaussianRepresentation, vtkAMRStreamingVolumeRepresentation, vtkRulerSourceRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkSelectionRepresentation, vtkPVPlotMatrixRepresentation, vtkImageVolumeRepresentation, vtkDataLabelRepresentation, vtkCompositeRepresentation, vtkGlyph3DRepresentation, vtkPVParallelCoordinatesRepresentation, vtkPVBoxChartRepresentation, vtkPVCompositeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkProgressBarSourceRepresentation, vtkGeometryRepresentationWithFaces, vtkTextSourceRepresentation, vtkChartSelectionRepresentation, vtkAMROutlineRepresentation, vtkGeometrySliceRepresentation, and vtkMoleculeRepresentation.
|
virtual |
Making these methods public.
When constructing composite representations, we need to call these methods directly on internal representations.
Reimplemented in vtkGeometryRepresentation, vtkPVBagChartRepresentation, vtkChartRepresentation, vtkImageSliceRepresentation, vtkPointGaussianRepresentation, vtkAMRStreamingVolumeRepresentation, vtkRulerSourceRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkXYChartRepresentation, vtkSelectionRepresentation, vtkImageVolumeRepresentation, vtkDataLabelRepresentation, vtkPVPlotMatrixRepresentation, vtkCompositeRepresentation, vtkGlyph3DRepresentation, vtkPVParallelCoordinatesRepresentation, vtkPVBoxChartRepresentation, vtkPVCompositeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkProgressBarSourceRepresentation, vtkGeometryRepresentationWithFaces, vtkTextSourceRepresentation, vtkChartSelectionRepresentation, vtkAMROutlineRepresentation, vtkGeometrySliceRepresentation, and vtkMoleculeRepresentation.
|
inlinevirtual |
Retrieves an output port for the input data object at the specified port and connection index.
This may be connected to the representation's internal pipeline. Overridden to use vtkPVTrivialProducer instead of vtkTrivialProducer
Definition at line 175 of file vtkPVDataRepresentation.h.
|
inlinevirtual |
Definition at line 176 of file vtkPVDataRepresentation.h.
|
virtual |
vtkView* vtkPVDataRepresentation::GetView | ( | ) | const |
Provides access to the view.
|
inlineprotectedvirtual |
Subclasses should override this method when they support caching to indicate if the particular key is cached.
Default returns false.
Reimplemented in vtkGeometryRepresentation, vtkChartRepresentation, vtkImageSliceRepresentation, vtkDataLabelRepresentation, vtkRulerSourceRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkImageVolumeRepresentation, vtkProgressBarSourceRepresentation, vtkTextSourceRepresentation, and vtkMoleculeRepresentation.
Definition at line 195 of file vtkPVDataRepresentation.h.
|
protectedvirtual |
Create a default executive.
|
protectedvirtual |
Overridden to invoke vtkCommand::UpdateDataEvent.
Reimplemented in vtkGeometryRepresentation, vtkPVBagChartRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartRepresentation, vtkImageSliceRepresentation, vtkPointGaussianRepresentation, vtkDataLabelRepresentation, vtkXYChartRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkRulerSourceRepresentation, vtkImageVolumeRepresentation, vtkPythonRepresentation, vtkAMROutlineRepresentation, vtkGlyph3DRepresentation, vtkSpreadSheetRepresentation, vtkProgressBarSourceRepresentation, vtkTextSourceRepresentation, vtkStructuredGridVolumeRepresentation, vtkChartSelectionRepresentation, vtkMoleculeRepresentation, and vtkGeometrySliceRepresentation.
|
protectedvirtual |
Reimplemented in vtkGeometryRepresentation, vtkAMRStreamingVolumeRepresentation, vtkGlyph3DRepresentation, and vtkAMROutlineRepresentation.
|
protectedvirtual |
|
protected |
Definition at line 216 of file vtkPVDataRepresentation.h.
|
protected |
Definition at line 217 of file vtkPVDataRepresentation.h.
|
protected |
Definition at line 218 of file vtkPVDataRepresentation.h.