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

#include <vtkPVDataRepresentation.h>

Inheritance diagram for vtkPVDataRepresentation:

[legend]

Collaboration diagram for vtkPVDataRepresentation:

[legend]

Public Types
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 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 ()

vtkAlgorithmOutput *	GetInternalOutputPort () override
	Retrieves an output port for the input data object at the specified port and connection index. More...

vtkAlgorithmOutput *	GetInternalOutputPort (int port) override

vtkAlgorithmOutput *	GetInternalOutputPort (int port, int conn) override

vtkView *	GetView () const
	Provides access to the view. More...

vtkMTimeType	GetPipelineDataTime ()
	Returns the timestamp when `RequestData` was executed on the representation. 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 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...


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::string &	GetLogName () const
	This is solely intended to simplify debugging and use for any other purpose is vehemently discouraged. More...

Public Member Functions inherited from vtkDataRepresentation
vtkDataRepresentation *	NewInstance () const

virtual void	ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))

virtual vtkSelection *	ConvertSelection (vtkView view, vtkSelection selection)

vtkAlgorithmOutput *	GetInputConnection (int port=0, int index=0)

vtkAnnotationLink *	GetAnnotationLink ()

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 vtkAlgorithmOutput *	GetInternalAnnotationOutputPort ()

virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port)

virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port, int conn)

virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort ()

virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port)

virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port, int conn)

virtual void	SetSelectionType (int)

virtual int	GetSelectionType ()

virtual void	SetSelectionArrayNames (vtkStringArray *names)

virtual vtkStringArray *	GetSelectionArrayNames ()

virtual void	SetSelectionArrayName (const char *name)

virtual const char *	GetSelectionArrayName ()

vtkAlgorithmOutput *	GetInputConnection (int port=0, int index=0)

vtkAnnotationLink *	GetAnnotationLink ()

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 vtkAlgorithmOutput *	GetInternalAnnotationOutputPort ()

virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port)

virtual vtkAlgorithmOutput *	GetInternalAnnotationOutputPort (int port, int conn)

virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort ()

virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port)

virtual vtkAlgorithmOutput *	GetInternalSelectionOutputPort (int port, int conn)

virtual void	SetSelectionType (int)

virtual int	GetSelectionType ()

virtual void	SetSelectionArrayNames (vtkStringArray *names)

virtual vtkStringArray *	GetSelectionArrayNames ()

virtual void	SetSelectionArrayName (const char *name)

virtual const char *	GetSelectionArrayName ()

Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithm *	NewInstance () const

vtkPolyData *	GetPolyDataOutput ()

vtkStructuredPoints *	GetStructuredPointsOutput ()

vtkImageData *	GetImageDataOutput ()

vtkStructuredGrid *	GetStructuredGridOutput ()

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()

vtkRectilinearGrid *	GetRectilinearGridOutput ()

vtkTable *	GetTableOutput ()

vtkGraph *	GetGraphOutput ()

vtkDataObject *	GetInput ()

vtkDataObject *	GetOutput ()

vtkDataObject *	GetOutput (int)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	AddInputData (vtkDataObject *)

void	AddInputData (int, vtkDataObject *)

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

vtkDataObject *	GetOutput ()

vtkDataObject *	GetOutput (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
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual 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 vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual 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)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)

virtual vtkInformation *	GetInformation ()

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)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual 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)

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkPVDataRepresentation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkDataRepresentation
static vtkDataRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkDataRepresentation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkPassInputTypeAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVDataRepresentation ()

	~vtkPVDataRepresentation () override

virtual bool	IsCached (double cache_key)
	Subclasses should override this method when they support caching to indicate if the particular key is cached. More...

vtkExecutive *	CreateDefaultExecutive () 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 vtkObjectBase *	NewInstanceInternal () 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 vtkAnnotationLayers *	ConvertAnnotations (vtkView view, vtkAnnotationLayers annotations)

vtkTrivialProducer *	GetInternalInput (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)

vtkDataObject *	GetInput (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)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	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

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

Detailed Description

vtkPVDataRepresentation adds some ParaView specific API to data representations.

See also: vtkPVDataRepresentationPipeline

Definition at line 34 of file vtkPVDataRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataRepresentation vtkPVDataRepresentation::Superclass

Definition at line 37 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

Reimplemented in vtkCinemaLayerRepresentation, vtkGeometryRepresentation, vtkPVPlotMatrixRepresentation, vtkDataLabelRepresentation, vtkImageVolumeRepresentation, vtkChartRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartSelectionRepresentation, vtkCompositeRepresentation, vtkImageSliceRepresentation, vtkPVCompositeRepresentation, vtkAMROutlineRepresentation, vtkSpreadSheetRepresentation, vtkXYChartRepresentation, vtkPointGaussianRepresentation, vtkProgressBarSourceRepresentation, vtkPVHistogramChartRepresentation, vtkRulerSourceRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkMoleculeRepresentation, vtkPolarAxesRepresentation, vtkGlyph3DRepresentation, vtkPythonRepresentation, vtkLogoSourceRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkPVGridAxes3DRepresentation, vtkPVBoxChartRepresentation, vtkPVParallelCoordinatesRepresentation, vtkGeometrySliceRepresentation, vtkStructuredGridVolumeRepresentation, vtkFeatureEdgesRepresentation, vtkGeometryRepresentationWithFaces, vtkOutlineRepresentation, and vtkQuartileChartRepresentation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkDataRepresentation.

Reimplemented in vtkCinemaLayerRepresentation, vtkGeometryRepresentation, vtkPVPlotMatrixRepresentation, vtkDataLabelRepresentation, vtkImageVolumeRepresentation, vtkChartRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkAMRStreamingVolumeRepresentation, vtkChartSelectionRepresentation, vtkCompositeRepresentation, vtkImageSliceRepresentation, vtkPVCompositeRepresentation, vtkAMROutlineRepresentation, vtkSpreadSheetRepresentation, vtkXYChartRepresentation, vtkPointGaussianRepresentation, vtkProgressBarSourceRepresentation, vtkPVHistogramChartRepresentation, vtkRulerSourceRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkMoleculeRepresentation, vtkPolarAxesRepresentation, vtkGlyph3DRepresentation, vtkPythonRepresentation, vtkLogoSourceRepresentation, vtkPVCompositeOrthographicSliceRepresentation, vtkPVGridAxes3DRepresentation, vtkPVBoxChartRepresentation, vtkPVParallelCoordinatesRepresentation, vtkGeometrySliceRepresentation, vtkStructuredGridVolumeRepresentation, vtkFeatureEdgesRepresentation, vtkGeometryRepresentationWithFaces, vtkOutlineRepresentation, and vtkQuartileChartRepresentation.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkDataRepresentation.

Reimplemented in vtkPVPlotMatrixRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkSpreadSheetRepresentation, vtkXYChartRepresentation, vtkPVHistogramChartRepresentation, vtkRulerSourceRepresentation, vtkSelectionRepresentation, vtkTextSourceRepresentation, vtkPVGridAxes3DRepresentation, vtkPVParallelCoordinatesRepresentation, vtkStructuredGridVolumeRepresentation, and vtkQuartileChartRepresentation.

◆ ProcessViewRequest()

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

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.

◆ 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.

◆ 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 91 of file vtkPVDataRepresentation.h.

◆ SetVisibility()

virtual void vtkPVDataRepresentation::SetVisibility ( bool val )

inlinevirtual

Get/Set the visibility for this representation.

When the visibility of representation of false, all view passes are ignored.

Definition at line 97 of file vtkPVDataRepresentation.h.

◆ 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 103 of file vtkPVDataRepresentation.h.

◆ SetUpdateTime()

virtual void vtkPVDataRepresentation::SetUpdateTime ( double time )

virtual

Set the update time.

Reimplemented in vtkCompositeRepresentation, vtkPVCompositeRepresentation, and vtkSelectionRepresentation.

◆ GetUpdateTime()

virtual double vtkPVDataRepresentation::GetUpdateTime ( )

virtual

Set the update time.

◆ GetUpdateTimeValid()

virtual bool vtkPVDataRepresentation::GetUpdateTimeValid ( )

virtual

Set whether the UpdateTime is valid.

◆ SetForcedCacheKey()

virtual void vtkPVDataRepresentation::SetForcedCacheKey ( double val )

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, vtkPVCompositeRepresentation, and vtkSelectionRepresentation.

Definition at line 131 of file vtkPVDataRepresentation.h.

◆ SetForceUseCache()

virtual void vtkPVDataRepresentation::SetForceUseCache ( bool val )

inlinevirtual

Reimplemented in vtkCompositeRepresentation, vtkPVCompositeRepresentation, and vtkSelectionRepresentation.

Definition at line 132 of file vtkPVDataRepresentation.h.

◆ GetCacheKey()

virtual double vtkPVDataRepresentation::GetCacheKey ( )

virtual

Returns whether caching is used and what key to use when caching is enabled.

◆ GetUseCache()

virtual bool vtkPVDataRepresentation::GetUseCache ( )

virtual

Returns whether caching is used and what key to use when caching is enabled.

◆ GetUsingCacheForUpdate()

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.

◆ GetNeedUpdate()

virtual bool vtkPVDataRepresentation::GetNeedUpdate ( )

virtual

◆ 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 168 of file vtkPVDataRepresentation.h.

◆ GetInternalOutputPort() [2/3]

vtkAlgorithmOutput* vtkPVDataRepresentation::GetInternalOutputPort ( int port )

inlineoverridevirtual

Reimplemented from vtkDataRepresentation.

Definition at line 169 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 191 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 192 of file vtkPVDataRepresentation.h.

◆ IsCached()

virtual bool vtkPVDataRepresentation::IsCached ( double cache_key )

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, vtkUnstructuredGridVolumeRepresentation, vtkRulerSourceRepresentation, vtkGlyph3DRepresentation, vtkImageVolumeRepresentation, vtkTextSourceRepresentation, vtkLogoSourceRepresentation, vtkProgressBarSourceRepresentation, vtkMoleculeRepresentation, vtkCinemaLayerRepresentation, and vtkPVGridAxes3DRepresentation.

Definition at line 203 of file vtkPVDataRepresentation.h.

◆ CreateDefaultExecutive()

vtkExecutive* vtkPVDataRepresentation::CreateDefaultExecutive ( )

overrideprotectedvirtual

Create a default executive.

Reimplemented from vtkAlgorithm.

◆ RequestData()

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

overrideprotectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkDataRepresentation.

Reimplemented in vtkXYChartRepresentation, vtkUnstructuredGridVolumeRepresentation, vtkRulerSourceRepresentation, vtkTextSourceRepresentation, vtkSpreadSheetRepresentation, and vtkPVGridAxes3DRepresentation.

◆ 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 224 of file vtkPVDataRepresentation.h.

◆ UpdateTimeValid

bool vtkPVDataRepresentation::UpdateTimeValid

protected

Definition at line 225 of file vtkPVDataRepresentation.h.

◆ UniqueIdentifier

unsigned int vtkPVDataRepresentation::UniqueIdentifier

protected

Definition at line 226 of file vtkPVDataRepresentation.h.

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

/home/utkarsh/Kitware/ParaView3/ParaViewTemp/ParaViewCore/ClientServerCore/Rendering/vtkPVDataRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVDataRepresentation()

◆ ~vtkPVDataRepresentation()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ ProcessViewRequest()

◆ MarkModified()

◆ Initialize()

◆ GetUniqueIdentifier()

◆ SetVisibility()

◆ GetVisibility()

◆ GetRenderedDataObject()

◆ SetUpdateTime()

◆ GetUpdateTime()

◆ GetUpdateTimeValid()

◆ SetForcedCacheKey()

◆ SetForceUseCache()

◆ GetCacheKey()

◆ GetUseCache()

◆ GetUsingCacheForUpdate()

◆ GetNeedUpdate()

◆ AddToView()

◆ RemoveFromView()

◆ GetInternalOutputPort() [1/3]

◆ GetInternalOutputPort() [2/3]

◆ GetInternalOutputPort() [3/3]

◆ GetView()

◆ GetPipelineDataTime()

◆ SetLogName()

◆ GetLogName()

◆ IsCached()

◆ CreateDefaultExecutive()

◆ RequestData()

◆ RequestUpdateExtent()

◆ RequestUpdateTime()

Member Data Documentation

◆ UpdateTime

◆ UpdateTimeValid

◆ UniqueIdentifier