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

vtkPVDataRepresentation adds some ParaView specific API to data representations. More...

#include <vtkPVDataRepresentation.h>

Inheritance diagram for vtkPVDataRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVDataRepresentation:
Collaboration graph
[legend]

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
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
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 vtkDataObjectGetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
double GetCacheKey () const
 Returns the cache-key the representation is currently using. More...
 
vtkAlgorithmOutputGetInternalOutputPort () override
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
vtkAlgorithmOutputGetInternalOutputPort (int port) override
 
vtkAlgorithmOutputGetInternalOutputPort (int port, int conn) override
 
vtkViewGetView () const
 Provides access to the view. More...
 
vtkMTimeType GetPipelineDataTime ()
 Returns the timestamp when RequestData was executed on the representation. More...
 
bool GetNeedsUpdate ()
 Returns true if the representation needs an update. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Get whether the UpdateTime is valid. More...
 
void ResetUpdateTime ()
 Get whether the UpdateTime is valid. More...
 
virtual void SetForcedCacheKey (double val)
 Generally, caching is within the purview of the vtkPVView (and subclasses). More...
 
virtual void SetForceUseCache (bool val)
 Generally, caching is within the purview of the vtkPVView (and subclasses). More...
 
virtual double GetForcedCacheKey ()
 Generally, caching is within the purview of the vtkPVView (and subclasses). More...
 
virtual bool GetForceUseCache ()
 Generally, caching is within the purview of the vtkPVView (and subclasses). More...
 
bool AddToView (vtkView *view) override
 Making these methods public. More...
 
bool RemoveFromView (vtkView *view) override
 Making these methods public. More...
 
virtual void SetLogName (const std::string &name)
 This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
 
const std::stringGetLogName () const
 This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...
 
virtual bool GetHasTemporalPipeline ()
 This flag indicates if the representation is for a temporal pipeline. More...
 
virtual void SetHasTemporalPipeline (bool)
 This flag indicates if the representation is for a temporal pipeline. More...
 
void SetInputConnection (int port, vtkAlgorithmOutput *input) override
 Overridden to ensure that MarkModified is called. More...
 
void AddInputConnection (int port, vtkAlgorithmOutput *input) override
 Overridden to ensure that MarkModified is called. More...
 
- Public Member Functions inherited from vtkDataRepresentation
vtkDataRepresentationNewInstance () const
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 
virtual vtkSelectionConvertSelection (vtkView *view, vtkSelection *selection)
 
vtkAlgorithmOutputGetInputConnection (int port=0, int index=0)
 
vtkAnnotationLinkGetAnnotationLink ()
 
void SetAnnotationLink (vtkAnnotationLink *link)
 
void Select (vtkView *view, vtkSelection *selection)
 
void Select (vtkView *view, vtkSelection *selection, bool extend)
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations)
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
 
virtual void SetSelectable (bool)
 
virtual bool GetSelectable ()
 
virtual void SelectableOn ()
 
virtual void SelectableOff ()
 
void UpdateSelection (vtkSelection *selection)
 
void UpdateSelection (vtkSelection *selection, bool extend)
 
void UpdateAnnotations (vtkAnnotationLayers *annotations)
 
void UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort ()
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port, int conn)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort ()
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port, int conn)
 
virtual void SetSelectionType (int)
 
virtual int GetSelectionType ()
 
virtual void SetSelectionArrayNames (vtkStringArray *names)
 
virtual vtkStringArrayGetSelectionArrayNames ()
 
virtual void SetSelectionArrayName (const char *name)
 
virtual const char * GetSelectionArrayName ()
 
vtkAlgorithmOutputGetInputConnection (int port=0, int index=0)
 
vtkAnnotationLinkGetAnnotationLink ()
 
void SetAnnotationLink (vtkAnnotationLink *link)
 
void Select (vtkView *view, vtkSelection *selection)
 
void Select (vtkView *view, vtkSelection *selection, bool extend)
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations)
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
 
virtual void SetSelectable (bool)
 
virtual bool GetSelectable ()
 
virtual void SelectableOn ()
 
virtual void SelectableOff ()
 
void UpdateSelection (vtkSelection *selection)
 
void UpdateSelection (vtkSelection *selection, bool extend)
 
void UpdateAnnotations (vtkAnnotationLayers *annotations)
 
void UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort ()
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port, int conn)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort ()
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port, int conn)
 
virtual void SetSelectionType (int)
 
virtual int GetSelectionType ()
 
virtual void SetSelectionArrayNames (vtkStringArray *names)
 
virtual vtkStringArrayGetSelectionArrayNames ()
 
virtual void SetSelectionArrayName (const char *name)
 
virtual const char * GetSelectionArrayName ()
 
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithmNewInstance () const
 
vtkPolyDataGetPolyDataOutput ()
 
vtkStructuredPointsGetStructuredPointsOutput ()
 
vtkImageDataGetImageDataOutput ()
 
vtkStructuredGridGetStructuredGridOutput ()
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 
vtkRectilinearGridGetRectilinearGridOutput ()
 
vtkTableGetTableOutput ()
 
vtkGraphGetGraphOutput ()
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetOutput ()
 
vtkDataObjectGetOutput (int)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
vtkDataObjectGetOutput ()
 
vtkDataObjectGetOutput (int)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformationGetInputInformation (int port, int index)
 
vtkInformationGetOutputInformation (int port)
 
virtual int Update (int port, vtkInformationVector *requests)
 
virtual int Update (vtkInformation *requests)
 
virtual int UpdateExtent (const int extents[6])
 
virtual void UpdateInformation ()
 
virtual void UpdateDataObject ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
int SetUpdateExtentToWholeExtent (int port)
 
int SetUpdateExtentToWholeExtent ()
 
void SetUpdateExtent (int port, int extent[6])
 
void SetUpdateExtent (int extent[6])
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
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)
 
virtual void SetInputConnection (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
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)
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserverGetProgressObserver ()
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
void Register (vtkObjectBase *o) VTK_OVERRIDE
 
void UnRegister (vtkObjectBase *o) VTK_OVERRIDE
 
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)
 
virtual void SetInputConnection (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
vtkInformationGetInputInformation ()
 
virtual void Update (int port)
 
virtual void Update ()
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=0)
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=0)
 
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)
 
intGetUpdateExtent ()
 
intGetUpdateExtent (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)
 
void SetProgressObserver (vtkProgressObserver *)
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
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 *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkDataRepresentation
static vtkDataRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPassInputTypeAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation () override
 
vtkExecutiveCreateDefaultExecutive () override
 Create a default executive. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 
int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 
- Protected Member Functions inherited from vtkDataRepresentation
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataRepresentation ()
 
 ~vtkDataRepresentation ()
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 
virtual bool AddToView (vtkView *vtkNotUsed(view))
 
virtual bool RemoveFromView (vtkView *vtkNotUsed(view))
 
virtual vtkAnnotationLayersConvertAnnotations (vtkView *view, vtkAnnotationLayers *annotations)
 
vtkTrivialProducerGetInternalInput (int port, int conn)
 
void SetInternalInput (int port, int conn, vtkTrivialProducer *producer)
 
virtual void SetAnnotationLinkInternal (vtkAnnotationLink *link)
 
- Protected Member Functions inherited from vtkPassInputTypeAlgorithm
 vtkPassInputTypeAlgorithm ()
 
 ~vtkPassInputTypeAlgorithm ()
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
vtkDataObjectGetInput (int port)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- 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)
 
void ReportReferences (vtkGarbageCollector *) VTK_OVERRIDE
 
virtual void SetNumberOfInputConnections (int port, int n)
 
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 SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
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)
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 
void SetInputDataInternal (int port, vtkDataObject *input)
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 
- Protected Attributes inherited from vtkDataRepresentation
bool Selectable
 
int SelectionType
 
vtkStringArraySelectionArrayNames
 
CommandObserver
 
vtkAnnotationLinkAnnotationLinkInternal
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
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 vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

vtkPVDataRepresentation adds some ParaView specific API to data representations.

See also
vtkPVDataRepresentationPipeline

Definition at line 35 of file vtkPVDataRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkPVDataRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
SkippedUpdateDataEvent 

This event is fired in ProcessViewRequest when REQUEST_UPDATE was requested and the representation needed an update (i.e.

this->GetNeedsUpdate() == true), however was skipped since the data is already cached by the view.

UpdateTimeChangedEvent 

Definition at line 212 of file vtkPVDataRepresentation.h.

Constructor & Destructor Documentation

◆ vtkPVDataRepresentation()

vtkPVDataRepresentation::vtkPVDataRepresentation ( )
protected

◆ ~vtkPVDataRepresentation()

vtkPVDataRepresentation::~vtkPVDataRepresentation ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkPVDataRepresentation::GetClassName ( )
virtual

◆ IsTypeOf()

static int vtkPVDataRepresentation::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkPVDataRepresentation::IsA ( const char *  type)
virtual

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkPVDataRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

◆ ProcessViewRequest()

virtual int vtkPVDataRepresentation::ProcessViewRequest ( vtkInformationRequestKey request_type,
vtkInformation inInfo,
vtkInformation outInfo 
)
virtual

◆ MarkModified()

virtual void vtkPVDataRepresentation::MarkModified ( )
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, vtkPolarAxesRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkSelectionRepresentation, vtkChartRepresentation, vtkPVCompositeRepresentation, vtkSpreadSheetRepresentation, and vtkChartSelectionRepresentation.

◆ Initialize()

virtual unsigned int vtkPVDataRepresentation::Initialize ( unsigned int  minIdAvailable,
unsigned int  maxIdAvailable 
)
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.

Note
CallOnAllProcesses 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, vtkPVCompositeRepresentation, vtkChartRepresentation, and vtkPVCompositeOrthographicSliceRepresentation.

◆ GetUniqueIdentifier()

unsigned int vtkPVDataRepresentation::GetUniqueIdentifier ( )
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 95 of file vtkPVDataRepresentation.h.

◆ SetVisibility()

virtual void vtkPVDataRepresentation::SetVisibility ( bool  val)
inlinevirtual

◆ GetVisibility()

virtual bool vtkPVDataRepresentation::GetVisibility ( )
virtual

Reimplemented in vtkDataLabelRepresentation.

◆ GetRenderedDataObject()

virtual vtkDataObject* vtkPVDataRepresentation::GetRenderedDataObject ( int   vtkNotUsedport)
inlinevirtual

Returns the data object that is rendered from the given input port.

Definition at line 107 of file vtkPVDataRepresentation.h.

◆ SetUpdateTime()

virtual void vtkPVDataRepresentation::SetUpdateTime ( double  time)
virtual

◆ GetUpdateTime()

virtual double vtkPVDataRepresentation::GetUpdateTime ( )
virtual

Set the update time.

◆ GetUpdateTimeValid()

virtual bool vtkPVDataRepresentation::GetUpdateTimeValid ( )
virtual

Get whether the UpdateTime is valid.

ResetUpdateTime can be used to clear the UpdateTimeValid flag.

◆ ResetUpdateTime()

void vtkPVDataRepresentation::ResetUpdateTime ( )

Get whether the UpdateTime is valid.

ResetUpdateTime can be used to clear the UpdateTimeValid flag.

◆ SetForcedCacheKey()

virtual void vtkPVDataRepresentation::SetForcedCacheKey ( double  val)
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 137 of file vtkPVDataRepresentation.h.

◆ SetForceUseCache()

virtual void vtkPVDataRepresentation::SetForceUseCache ( bool  val)
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 138 of file vtkPVDataRepresentation.h.

◆ GetForcedCacheKey()

virtual double vtkPVDataRepresentation::GetForcedCacheKey ( )
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.

◆ GetForceUseCache()

virtual bool vtkPVDataRepresentation::GetForceUseCache ( )
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.

◆ GetCacheKey()

double vtkPVDataRepresentation::GetCacheKey ( ) const

Returns the cache-key the representation is currently using.

This takes into consideration whether ForcedCacheKey is to be used.

◆ AddToView()

bool vtkPVDataRepresentation::AddToView ( vtkView view)
override

Making these methods public.

When constructing composite representations, we need to call these methods directly on internal representations.

◆ RemoveFromView()

bool vtkPVDataRepresentation::RemoveFromView ( vtkView view)
override

Making these methods public.

When constructing composite representations, we need to call these methods directly on internal representations.

◆ GetInternalOutputPort() [1/3]

vtkAlgorithmOutput* vtkPVDataRepresentation::GetInternalOutputPort ( )
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 164 of file vtkPVDataRepresentation.h.

◆ GetInternalOutputPort() [2/3]

vtkAlgorithmOutput* vtkPVDataRepresentation::GetInternalOutputPort ( int  port)
inlineoverridevirtual

Reimplemented from vtkDataRepresentation.

Definition at line 165 of file vtkPVDataRepresentation.h.

◆ GetInternalOutputPort() [3/3]

vtkAlgorithmOutput* vtkPVDataRepresentation::GetInternalOutputPort ( int  port,
int  conn 
)
overridevirtual

Reimplemented from vtkDataRepresentation.

◆ GetView()

vtkView* vtkPVDataRepresentation::GetView ( ) const

Provides access to the view.

◆ GetPipelineDataTime()

vtkMTimeType vtkPVDataRepresentation::GetPipelineDataTime ( )

Returns the timestamp when RequestData was executed on the representation.

◆ SetLogName()

virtual void vtkPVDataRepresentation::SetLogName ( const std::string name)
inlinevirtual

This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged.

Reimplemented in vtkSelectionRepresentation.

Definition at line 187 of file vtkPVDataRepresentation.h.

◆ GetLogName()

const std::string& vtkPVDataRepresentation::GetLogName ( ) const
inline

This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged.

Definition at line 188 of file vtkPVDataRepresentation.h.

◆ GetHasTemporalPipeline()

virtual bool vtkPVDataRepresentation::GetHasTemporalPipeline ( )
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.

◆ SetHasTemporalPipeline()

virtual void vtkPVDataRepresentation::SetHasTemporalPipeline ( bool  )
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.

◆ GetNeedsUpdate()

bool vtkPVDataRepresentation::GetNeedsUpdate ( )

Returns true if the representation needs an update.

◆ SetInputConnection()

void vtkPVDataRepresentation::SetInputConnection ( int  port,
vtkAlgorithmOutput input 
)
overridevirtual

Overridden to ensure that MarkModified is called.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSelectionRepresentation.

◆ AddInputConnection()

void vtkPVDataRepresentation::AddInputConnection ( int  port,
vtkAlgorithmOutput input 
)
overridevirtual

Overridden to ensure that MarkModified is called.

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSelectionRepresentation.

◆ CreateDefaultExecutive()

vtkExecutive* vtkPVDataRepresentation::CreateDefaultExecutive ( )
overrideprotectedvirtual

Create a default executive.

Reimplemented from vtkAlgorithm.

◆ RequestData()

int vtkPVDataRepresentation::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

◆ RequestUpdateExtent()

int vtkPVDataRepresentation::RequestUpdateExtent ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

◆ RequestUpdateTime()

int vtkPVDataRepresentation::RequestUpdateTime ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

Member Data Documentation

◆ UpdateTime

double vtkPVDataRepresentation::UpdateTime
protected

Definition at line 253 of file vtkPVDataRepresentation.h.

◆ UpdateTimeValid

bool vtkPVDataRepresentation::UpdateTimeValid
protected

Definition at line 254 of file vtkPVDataRepresentation.h.

◆ UniqueIdentifier

unsigned int vtkPVDataRepresentation::UniqueIdentifier
protected

Definition at line 255 of file vtkPVDataRepresentation.h.


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