vtkPVDataRepresentation adds some ParaView specific API to data representations. More...
#include <vtkPVDataRepresentation.h>
Public Types | |
enum | { SkippedUpdateDataEvent = vtkCommand::UserEvent + 91, UpdateTimeChangedEvent } |
typedef vtkDataRepresentation | Superclass |
Public Types inherited from vtkDataRepresentation | |
typedef vtkPassInputTypeAlgorithm | Superclass |
Public Types inherited from vtkPassInputTypeAlgorithm | |
typedef vtkAlgorithm | Superclass |
Public Types inherited from vtkAlgorithm | |
enum | DesiredOutputPrecision |
enum | DesiredOutputPrecision |
typedef vtkObject | Superclass |
Protected Attributes | |
double | UpdateTime |
bool | UpdateTimeValid |
unsigned int | UniqueIdentifier |
Protected Attributes inherited from vtkDataRepresentation | |
bool | Selectable |
int | SelectionType |
vtkStringArray * | SelectionArrayNames |
Command * | Observer |
vtkAnnotationLink * | AnnotationLinkInternal |
Protected Attributes inherited from vtkAlgorithm | |
vtkInformation * | Information |
double | Progress |
char * | ProgressText |
vtkProgressObserver * | ProgressObserver |
unsigned long | ErrorCode |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
Protected Attributes inherited from vtkObjectBase | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
Public Attributes inherited from vtkAlgorithm | |
SINGLE_PRECISION | |
DOUBLE_PRECISION | |
DEFAULT_PRECISION | |
int | AbortExecute |
Static Protected Member Functions inherited from vtkAlgorithm | |
static vtkInformationIntegerKey * | PORT_REQUIREMENTS_FILLED () |
Static Protected Attributes inherited from vtkAlgorithm | |
static vtkExecutive * | DefaultExecutivePrototype |
vtkPVDataRepresentation adds some ParaView specific API to data representations.
Definition at line 23 of file vtkPVDataRepresentation.h.
Definition at line 26 of file vtkPVDataRepresentation.h.
anonymous enum |
Enumerator | |
---|---|
SkippedUpdateDataEvent | This event is fired in this->GetNeedsUpdate() == true), however was skipped since the data is already cached by the view. |
UpdateTimeChangedEvent |
Definition at line 200 of file vtkPVDataRepresentation.h.
|
protected |
|
overrideprotected |
|
virtual |
Reimplemented in vtkGeometryRepresentation, vtkImageVolumeRepresentation, vtkHyperTreeGridRepresentation, vtkDataLabelRepresentation, vtkChartRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartSelectionRepresentation, vtkCompositeRepresentation, vtkPVPlotMatrixRepresentation, vtkXYChartRepresentation, vtkAMROutlineRepresentation, vtkPVCompositeRepresentation, vtkChartTextRepresentation, vtkImageSliceRepresentation, vtkProtractorRepresentation, vtkSpreadSheetRepresentation, vtkPolarAxesRepresentation, vtkPointGaussianRepresentation, vtkPVImageChartRepresentation, vtkVolumeRepresentation, vtkPVHistogramChartRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkCellGridRepresentation, vtkProgressBarSourceRepresentation, vtkRulerSourceRepresentation, vtkChartLogoRepresentation, vtkGlyph3DRepresentation, vtkMoleculeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkPVGridAxes3DRepresentation, vtkPVParallelCoordinatesRepresentation, vtkSurfaceLICRepresentation, vtkPythonRepresentation, vtkLogoSourceRepresentation, vtkPVBoxChartRepresentation, vtkStructuredGridVolumeRepresentation, vtkFeatureEdgesRepresentation, vtkGeometrySliceRepresentation, vtkGeometryRepresentationWithFaces, vtkOutlineRepresentation, and vtkQuartileChartRepresentation.
Reimplemented from vtkDataRepresentation.
Reimplemented in vtkGeometryRepresentation, vtkImageVolumeRepresentation, vtkHyperTreeGridRepresentation, vtkDataLabelRepresentation, vtkChartRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartSelectionRepresentation, vtkCompositeRepresentation, vtkPVPlotMatrixRepresentation, vtkXYChartRepresentation, vtkAMROutlineRepresentation, vtkPVCompositeRepresentation, vtkChartTextRepresentation, vtkImageSliceRepresentation, vtkProtractorRepresentation, vtkSpreadSheetRepresentation, vtkPolarAxesRepresentation, vtkPointGaussianRepresentation, vtkPVImageChartRepresentation, vtkVolumeRepresentation, vtkPVHistogramChartRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkCellGridRepresentation, vtkProgressBarSourceRepresentation, vtkRulerSourceRepresentation, vtkChartLogoRepresentation, vtkGlyph3DRepresentation, vtkMoleculeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkPVGridAxes3DRepresentation, vtkPVParallelCoordinatesRepresentation, vtkSurfaceLICRepresentation, vtkPythonRepresentation, vtkLogoSourceRepresentation, vtkPVBoxChartRepresentation, vtkStructuredGridVolumeRepresentation, vtkFeatureEdgesRepresentation, vtkGeometrySliceRepresentation, vtkGeometryRepresentationWithFaces, vtkOutlineRepresentation, and vtkQuartileChartRepresentation.
|
static |
|
overridevirtual |
Reimplemented from vtkDataRepresentation.
Reimplemented in vtkUnstructuredGridVolumeRepresentation, vtkPVPlotMatrixRepresentation, vtkXYChartRepresentation, vtkSpreadSheetRepresentation, vtkPVImageChartRepresentation, vtkVolumeRepresentation, vtkPVHistogramChartRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkRulerSourceRepresentation, vtkPVGridAxes3DRepresentation, vtkPVParallelCoordinatesRepresentation, vtkSurfaceLICRepresentation, vtkPythonRepresentation, vtkStructuredGridVolumeRepresentation, and vtkQuartileChartRepresentation.
|
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.
vtkDataRepresentation::GetVisibility()
returns false. Reimplemented in vtkPolarAxesRepresentation, vtkXYChartRepresentation, vtkRulerSourceRepresentation, vtkDataLabelRepresentation, vtkChartRepresentation, vtkLogoSourceRepresentation, vtkTextSourceRepresentation, vtkChartTextRepresentation, vtkAMRStreamingVolumeRepresentation, vtkImageSliceRepresentation, vtkProtractorRepresentation, vtkGeometryRepresentation, vtkImageVolumeRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkChartLogoRepresentation, vtkChartSelectionRepresentation, vtkProgressBarSourceRepresentation, vtkHyperTreeGridRepresentation, vtkAMROutlineRepresentation, vtkGeometryRepresentationWithFaces, vtkPVGridAxes3DRepresentation, vtkSpreadSheetRepresentation, vtkCellGridRepresentation, vtkCompositeRepresentation, vtkGlyph3DRepresentation, vtkPythonRepresentation, vtkPointGaussianRepresentation, vtkSurfaceLICRepresentation, vtkSelectionRepresentation, vtkMoleculeRepresentation, and vtkGeometrySliceRepresentation.
|
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 vtkPolarAxesRepresentation, vtkCompositeRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkChartRepresentation, vtkSelectionRepresentation, vtkPVCompositeRepresentation, vtkSpreadSheetRepresentation, and vtkChartSelectionRepresentation.
|
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.
Reimplemented in vtkSelectionRepresentation, vtkPVCompositeRepresentation, vtkChartRepresentation, 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 83 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 vtkPolarAxesRepresentation, vtkSelectionRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartTextRepresentation, vtkImageSliceRepresentation, vtkGeometryRepresentation, vtkHyperTreeGridRepresentation, vtkPVCompositeRepresentation, vtkRulerSourceRepresentation, vtkChartLogoRepresentation, vtkChartRepresentation, vtkProtractorRepresentation, vtkDataLabelRepresentation, vtkGlyph3DRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkChartSelectionRepresentation, vtkAMROutlineRepresentation, vtkGeometryRepresentationWithFaces, vtkPointGaussianRepresentation, vtkCellGridRepresentation, vtkCompositeRepresentation, vtkTextSourceRepresentation, vtkProgressBarSourceRepresentation, vtkXYChartRepresentation, vtkPVPlotMatrixRepresentation, vtkLogoSourceRepresentation, vtkVolumeRepresentation, vtkPVImageChartRepresentation, vtkMoleculeRepresentation, vtkPVGridAxes3DRepresentation, vtkPVParallelCoordinatesRepresentation, and vtkPVBoxChartRepresentation.
Definition at line 89 of file vtkPVDataRepresentation.h.
|
virtual |
Reimplemented in vtkDataLabelRepresentation.
|
inlinevirtual |
Returns the data object that is rendered from the given input port.
Definition at line 95 of file vtkPVDataRepresentation.h.
|
virtual |
Set the update time.
Reimplemented in vtkCompositeRepresentation, vtkPVCompositeRepresentation, and vtkSelectionRepresentation.
|
virtual |
Set the update time.
|
virtual |
Get whether the UpdateTime is valid.
ResetUpdateTime
can be used to clear the UpdateTimeValid flag.
void vtkPVDataRepresentation::ResetUpdateTime | ( | ) |
Get whether the UpdateTime is valid.
ResetUpdateTime
can be used to clear the UpdateTimeValid flag.
|
inlinevirtual |
Generally, caching is within the purview of the vtkPVView (and subclasses).
However, a representation may choose to override that caching by forcing specific caching parameters. This is primarily intended for views like comparative view that rely on caching to show multiple frames from the same pipeline at a time.
Reimplemented in vtkCompositeRepresentation, vtkPVCompositeRepresentation, and vtkSelectionRepresentation.
Definition at line 125 of file vtkPVDataRepresentation.h.
|
inlinevirtual |
Generally, caching is within the purview of the vtkPVView (and subclasses).
However, a representation may choose to override that caching by forcing specific caching parameters. This is primarily intended for views like comparative view that rely on caching to show multiple frames from the same pipeline at a time.
Reimplemented in vtkCompositeRepresentation, vtkPVCompositeRepresentation, and vtkSelectionRepresentation.
Definition at line 126 of file vtkPVDataRepresentation.h.
|
virtual |
Generally, caching is within the purview of the vtkPVView (and subclasses).
However, a representation may choose to override that caching by forcing specific caching parameters. This is primarily intended for views like comparative view that rely on caching to show multiple frames from the same pipeline at a time.
|
virtual |
Generally, caching is within the purview of the vtkPVView (and subclasses).
However, a representation may choose to override that caching by forcing specific caching parameters. This is primarily intended for views like comparative view that rely on caching to show multiple frames from the same pipeline at a time.
double vtkPVDataRepresentation::GetCacheKey | ( | ) | const |
Returns the cache-key the representation is currently using.
This takes into consideration whether ForcedCacheKey is to be used.
|
override |
Making these methods public.
When constructing composite representations, we need to call these methods directly on internal representations.
|
override |
Making these methods public.
When constructing composite representations, we need to call these methods directly on internal representations.
|
inlineoverridevirtual |
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
Reimplemented from vtkDataRepresentation.
Definition at line 152 of file vtkPVDataRepresentation.h.
|
inlineoverridevirtual |
Reimplemented from vtkDataRepresentation.
Definition at line 153 of file vtkPVDataRepresentation.h.
|
overridevirtual |
Reimplemented from vtkDataRepresentation.
vtkView* vtkPVDataRepresentation::GetView | ( | ) | const |
Provides access to the view.
vtkMTimeType vtkPVDataRepresentation::GetPipelineDataTime | ( | ) |
Returns the timestamp when RequestData
was executed on the representation.
|
inlinevirtual |
This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged.
Reimplemented in vtkSelectionRepresentation.
Definition at line 175 of file vtkPVDataRepresentation.h.
|
inline |
This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged.
Definition at line 176 of file vtkPVDataRepresentation.h.
|
virtual |
This flag indicates if the representation is for a temporal pipeline.
If true, then calling SetUpdateTime
will result in calling this->MarkModified()
i.e. will cause the representation to update on subsequent update request. Otherwise, the subsequent update request will be a no-op (unless the representation ended up calling MarkModified due to other changes i.e. change in input pipeline). HasTemporalPipeline
gets set in the first update on the representation, however, only on the data-server side. vtkPVView ensures that the flag is synced up among all ranks at the end of each vtkPVView::Update
call.
|
virtual |
This flag indicates if the representation is for a temporal pipeline.
If true, then calling SetUpdateTime
will result in calling this->MarkModified()
i.e. will cause the representation to update on subsequent update request. Otherwise, the subsequent update request will be a no-op (unless the representation ended up calling MarkModified due to other changes i.e. change in input pipeline). HasTemporalPipeline
gets set in the first update on the representation, however, only on the data-server side. vtkPVView ensures that the flag is synced up among all ranks at the end of each vtkPVView::Update
call.
bool vtkPVDataRepresentation::GetNeedsUpdate | ( | ) |
Returns true if the representation needs an update.
|
overridevirtual |
Overridden to ensure that MarkModified
is called.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSelectionRepresentation.
|
overridevirtual |
Overridden to ensure that MarkModified
is called.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkSelectionRepresentation.
|
inlinevirtual |
Specify the array names used for the selection.
Empty method to be implemented by inheriting classes
Definition at line 226 of file vtkPVDataRepresentation.h.
|
overrideprotectedvirtual |
Create a default executive.
Reimplemented from vtkAlgorithm.
|
overrideprotectedvirtual |
Overridden to invoke vtkCommand::UpdateDataEvent.
Reimplemented from vtkDataRepresentation.
Reimplemented in vtkXYChartRepresentation, vtkRulerSourceRepresentation, vtkPythonRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkTextSourceRepresentation, vtkSpreadSheetRepresentation, and vtkPVGridAxes3DRepresentation.
|
overrideprotectedvirtual |
Reimplemented from vtkPassInputTypeAlgorithm.
|
overrideprotectedvirtual |
Reimplemented from vtkPassInputTypeAlgorithm.
|
protected |
Definition at line 248 of file vtkPVDataRepresentation.h.
|
protected |
Definition at line 249 of file vtkPVDataRepresentation.h.
|
protected |
Definition at line 250 of file vtkPVDataRepresentation.h.