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

The superclass for all representations. More...

#include <vtkDataRepresentation.h>

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

Public Types

typedef vtkPassInputTypeAlgorithm Superclass
 
- Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
vtkAlgorithmOutputGetInputConnection (int port=0, int index=0)
 Convenience override method for obtaining the input connection without specifying the port or index. More...
 
vtkAnnotationLinkGetAnnotationLink ()
 The annotation link for this representation. More...
 
void SetAnnotationLink (vtkAnnotationLink *link)
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 Apply a theme to this representation. More...
 
void Select (vtkView *view, vtkSelection *selection)
 The view calls this method when a selection occurs. More...
 
void Select (vtkView *view, vtkSelection *selection, bool extend)
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations)
 Analogous to Select(). More...
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
 
void UpdateSelection (vtkSelection *selection)
 Updates the selection in the selection link and fires a selection change event. More...
 
void UpdateSelection (vtkSelection *selection, bool extend)
 
void UpdateAnnotations (vtkAnnotationLayers *annotations)
 Updates the selection in the selection link and fires a selection change event. More...
 
void UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort ()
 The output port that contains the annotations whose selections are localized for a particular input data object. More...
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port, int conn)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort ()
 The output port that contains the selection associated with the current annotation (normally the interactive selection). More...
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port, int conn)
 
virtual vtkAlgorithmOutputGetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutputGetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalOutputPort (int port, int conn)
 
virtual vtkSelectionConvertSelection (vtkView *view, vtkSelection *selection)
 Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view. More...
 
virtual void SetSelectable (bool)
 Whether this representation is able to handle a selection. More...
 
virtual bool GetSelectable ()
 Whether this representation is able to handle a selection. More...
 
virtual void SelectableOn ()
 Whether this representation is able to handle a selection. More...
 
virtual void SelectableOff ()
 Whether this representation is able to handle a selection. More...
 
virtual void SetSelectionType (int)
 Set the selection type produced by this view. More...
 
virtual int GetSelectionType ()
 Set the selection type produced by this view. More...
 
virtual void SetSelectionArrayNames (vtkStringArray *names)
 If a VALUES selection, the arrays used to produce a selection. More...
 
virtual vtkStringArrayGetSelectionArrayNames ()
 If a VALUES selection, the arrays used to produce a selection. More...
 
virtual void SetSelectionArrayName (const char *name)
 If a VALUES selection, the array used to produce a selection. More...
 
virtual const char * GetSelectionArrayName ()
 If a VALUES selection, the array used to produce a selection. More...
 
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as a concrete type. More...
 
vtkImageDataGetImageDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as a concrete type. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as a concrete type. More...
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as a concrete type. More...
 
vtkGraphGetGraphOutput ()
 Get the output as a concrete type. More...
 
vtkMoleculeGetMoleculeOutput ()
 Get the output as a concrete type. More...
 
vtkTableGetTableOutput ()
 Get the output as a concrete type. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkDataRepresentationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPassInputTypeAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
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 ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataRepresentation ()
 
 ~vtkDataRepresentation () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses should override this to connect inputs to the internal pipeline as necessary. More...
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 Clear the input shallow copy caches if the algorithm is in "release data" mode. More...
 
virtual bool AddToView (vtkView *vtkNotUsed(view))
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *vtkNotUsed(view))
 Removes the representation to the view. More...
 
virtual vtkAnnotationLayersConvertAnnotations (vtkView *view, vtkAnnotationLayers *annotations)
 Analogous to ConvertSelection(), allows subclasses to manipulate annotations before passing them off to vtkAnnotationLink. More...
 
vtkTrivialProducerGetInternalInput (int port, int conn)
 
void SetInternalInput (int port, int conn, vtkTrivialProducer *producer)
 
- Protected Member Functions inherited from vtkPassInputTypeAlgorithm
 vtkPassInputTypeAlgorithm ()
 
 ~vtkPassInputTypeAlgorithm () override
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

bool Selectable
 
int SelectionType
 The selection type created by the view. More...
 
vtkStringArraySelectionArrayNames
 If a VALUES selection, the array names used in the selection. More...
 
CommandObserver
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkView
 
class vtkRenderView
 
class Command
 
vtkAnnotationLinkAnnotationLinkInternal
 The annotation link for this representation. More...
 
virtual void SetAnnotationLinkInternal (vtkAnnotationLink *link)
 The annotation link for this representation. More...
 

Additional Inherited Members

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

Detailed Description

The superclass for all representations.

vtkDataRepresentation the superclass for representations of data objects. This class itself may be instantiated and used as a representation that simply holds a connection to a pipeline.

If there are multiple representations present in a view, you should use a subclass of vtkDataRepresentation. The representation is responsible for taking the input pipeline connection and converting it to an object usable by a view. In the most common case, the representation will contain the pipeline necessary to convert a data object into an actor or set of actors.

The representation has a concept of a selection. If the user performs a selection operation on the view, the view forwards this on to its representations. The representation is responsible for displaying that selection in an appropriate way.

Representation selections may also be linked. The representation shares the selection by converting it into a view-independent format, then setting the selection on its vtkAnnotationLink. Other representations sharing the same selection link instance will get the same selection from the selection link when the view is updated. The application is responsible for linking representations as appropriate by setting the same vtkAnnotationLink on each linked representation.

Examples:
vtkDataRepresentation (Examples)

Definition at line 69 of file vtkDataRepresentation.h.

Member Typedef Documentation

Definition at line 73 of file vtkDataRepresentation.h.

Constructor & Destructor Documentation

vtkDataRepresentation::vtkDataRepresentation ( )
protected
vtkDataRepresentation::~vtkDataRepresentation ( )
overrideprotected

Member Function Documentation

static vtkDataRepresentation* vtkDataRepresentation::New ( )
static
static vtkTypeBool vtkDataRepresentation::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkDataRepresentation::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPassInputTypeAlgorithm.

Reimplemented in vtkParallelCoordinatesRepresentation, vtkRenderedGraphRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedSurfaceRepresentation, vtkRenderedRepresentation, vtkEmptyRepresentation, and vtkRenderedHierarchyRepresentation.

static vtkDataRepresentation* vtkDataRepresentation::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataRepresentation::NewInstanceInternal ( ) const
protectedvirtual
vtkDataRepresentation* vtkDataRepresentation::NewInstance ( ) const
void vtkDataRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPassInputTypeAlgorithm.

Reimplemented in vtkParallelCoordinatesRepresentation, vtkRenderedGraphRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedSurfaceRepresentation, vtkRenderedRepresentation, vtkEmptyRepresentation, and vtkRenderedHierarchyRepresentation.

vtkAlgorithmOutput* vtkDataRepresentation::GetInputConnection ( int  port = 0,
int  index = 0 
)
inline

Convenience override method for obtaining the input connection without specifying the port or index.

Definition at line 80 of file vtkDataRepresentation.h.

vtkAnnotationLink* vtkDataRepresentation::GetAnnotationLink ( )
inline

The annotation link for this representation.

To link annotations, set the same vtkAnnotationLink object in multiple representations.

Definition at line 88 of file vtkDataRepresentation.h.

void vtkDataRepresentation::SetAnnotationLink ( vtkAnnotationLink link)
virtual void vtkDataRepresentation::ApplyViewTheme ( vtkViewTheme vtkNotUsedtheme)
inlinevirtual

Apply a theme to this representation.

Subclasses should override this method.

Definition at line 96 of file vtkDataRepresentation.h.

void vtkDataRepresentation::Select ( vtkView view,
vtkSelection selection 
)
inline

The view calls this method when a selection occurs.

The representation takes this selection and converts it into a selection on its data by calling ConvertSelection, then calls UpdateSelection with the converted selection. Subclasses should not override this method, but should instead override ConvertSelection. The optional third argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 108 of file vtkDataRepresentation.h.

void vtkDataRepresentation::Select ( vtkView view,
vtkSelection selection,
bool  extend 
)
void vtkDataRepresentation::Annotate ( vtkView view,
vtkAnnotationLayers annotations 
)
inline

Analogous to Select().

The view calls this method when it needs to change the underlying annotations (some views might perform the creation of annotations). The representation takes the annotations and converts them into a selection on its data by calling ConvertAnnotations, then calls UpdateAnnotations with the converted selection. Subclasses should not override this method, but should instead override ConvertSelection. The optional third argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 123 of file vtkDataRepresentation.h.

void vtkDataRepresentation::Annotate ( vtkView view,
vtkAnnotationLayers annotations,
bool  extend 
)
virtual void vtkDataRepresentation::SetSelectable ( bool  )
virtual

Whether this representation is able to handle a selection.

Default is true.

virtual bool vtkDataRepresentation::GetSelectable ( )
virtual

Whether this representation is able to handle a selection.

Default is true.

virtual void vtkDataRepresentation::SelectableOn ( )
virtual

Whether this representation is able to handle a selection.

Default is true.

virtual void vtkDataRepresentation::SelectableOff ( )
virtual

Whether this representation is able to handle a selection.

Default is true.

void vtkDataRepresentation::UpdateSelection ( vtkSelection selection)
inline

Updates the selection in the selection link and fires a selection change event.

Subclasses should not override this method, but should instead override ConvertSelection. The optional second argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 144 of file vtkDataRepresentation.h.

void vtkDataRepresentation::UpdateSelection ( vtkSelection selection,
bool  extend 
)
void vtkDataRepresentation::UpdateAnnotations ( vtkAnnotationLayers annotations)
inline

Updates the selection in the selection link and fires a selection change event.

Subclasses should not override this method, but should instead override ConvertSelection. The optional second argument specifies whether the selection should be added to the previous selection on this representation.

Definition at line 155 of file vtkDataRepresentation.h.

void vtkDataRepresentation::UpdateAnnotations ( vtkAnnotationLayers annotations,
bool  extend 
)
virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalAnnotationOutputPort ( )
inlinevirtual

The output port that contains the annotations whose selections are localized for a particular input data object.

This should be used when connecting the internal pipelines.

Reimplemented in vtkEmptyRepresentation.

Definition at line 164 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalAnnotationOutputPort ( int  port)
inlinevirtual

Reimplemented in vtkEmptyRepresentation.

Definition at line 166 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalAnnotationOutputPort ( int  port,
int  conn 
)
virtual

Reimplemented in vtkEmptyRepresentation.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalSelectionOutputPort ( )
inlinevirtual

The output port that contains the selection associated with the current annotation (normally the interactive selection).

This should be used when connecting the internal pipelines.

Definition at line 175 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalSelectionOutputPort ( int  port)
inlinevirtual

Definition at line 177 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalSelectionOutputPort ( int  port,
int  conn 
)
virtual
virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalOutputPort ( )
inlinevirtual

Retrieves an output port for the input data object at the specified port and connection index.

This may be connected to the representation's internal pipeline.

Definition at line 186 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalOutputPort ( int  port)
inlinevirtual

Definition at line 188 of file vtkDataRepresentation.h.

virtual vtkAlgorithmOutput* vtkDataRepresentation::GetInternalOutputPort ( int  port,
int  conn 
)
virtual
virtual void vtkDataRepresentation::SetSelectionType ( int  )
virtual

Set the selection type produced by this view.

This should be one of the content type constants defined in vtkSelectionNode.h. Common values are vtkSelectionNode::INDICES vtkSelectionNode::PEDIGREEIDS vtkSelectionNode::VALUES

virtual int vtkDataRepresentation::GetSelectionType ( )
virtual

Set the selection type produced by this view.

This should be one of the content type constants defined in vtkSelectionNode.h. Common values are vtkSelectionNode::INDICES vtkSelectionNode::PEDIGREEIDS vtkSelectionNode::VALUES

virtual void vtkDataRepresentation::SetSelectionArrayNames ( vtkStringArray names)
virtual

If a VALUES selection, the arrays used to produce a selection.

virtual vtkStringArray* vtkDataRepresentation::GetSelectionArrayNames ( )
virtual

If a VALUES selection, the arrays used to produce a selection.

virtual void vtkDataRepresentation::SetSelectionArrayName ( const char *  name)
virtual

If a VALUES selection, the array used to produce a selection.

virtual const char* vtkDataRepresentation::GetSelectionArrayName ( )
virtual

If a VALUES selection, the array used to produce a selection.

virtual vtkSelection* vtkDataRepresentation::ConvertSelection ( vtkView view,
vtkSelection selection 
)
virtual

Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.

For the superclass, we just return the same selection. Subclasses may do something more fancy, like convert the selection from a frustrum to a list of pedigree ids. If the selection cannot be applied to this representation, return nullptr.

Reimplemented in vtkRenderedGraphRepresentation, vtkParallelCoordinatesRepresentation, vtkRenderedTreeAreaRepresentation, vtkRenderedHierarchyRepresentation, and vtkRenderedSurfaceRepresentation.

int vtkDataRepresentation::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineoverrideprotectedvirtual

Subclasses should override this to connect inputs to the internal pipeline as necessary.

Since most representations are "meta-filters" (i.e. filters containing other filters), you should create shallow copies of your input before connecting to the internal pipeline. The convenience method GetInternalOutputPort will create a cached shallow copy of a specified input for you. The related helper functions GetInternalAnnotationOutputPort, GetInternalSelectionOutputPort should be used to obtain a selection or annotation port whose selections are localized for a particular input data object.

Reimplemented from vtkPassInputTypeAlgorithm.

Reimplemented in vtkRenderedGraphRepresentation, vtkRenderedTreeAreaRepresentation, vtkParallelCoordinatesRepresentation, vtkRenderedHierarchyRepresentation, vtkParallelCoordinatesHistogramRepresentation, vtkQtTableRepresentation, and vtkRenderedSurfaceRepresentation.

Definition at line 245 of file vtkDataRepresentation.h.

virtual void vtkDataRepresentation::ProcessEvents ( vtkObject caller,
unsigned long  eventId,
void *  callData 
)
protectedvirtual

Clear the input shallow copy caches if the algorithm is in "release data" mode.

virtual void vtkDataRepresentation::SetAnnotationLinkInternal ( vtkAnnotationLink link)
protectedvirtual

The annotation link for this representation.

virtual bool vtkDataRepresentation::AddToView ( vtkView vtkNotUsedview)
inlineprotectedvirtual

Adds the representation to the view.

This is called from vtkView::AddRepresentation(). Subclasses should override this method. Returns true if the addition succeeds.

Definition at line 292 of file vtkDataRepresentation.h.

virtual bool vtkDataRepresentation::RemoveFromView ( vtkView vtkNotUsedview)
inlineprotectedvirtual

Removes the representation to the view.

This is called from vtkView::RemoveRepresentation(). Subclasses should override this method. Returns true if the removal succeeds.

Definition at line 299 of file vtkDataRepresentation.h.

virtual vtkAnnotationLayers* vtkDataRepresentation::ConvertAnnotations ( vtkView view,
vtkAnnotationLayers annotations 
)
protectedvirtual

Analogous to ConvertSelection(), allows subclasses to manipulate annotations before passing them off to vtkAnnotationLink.

If the annotations cannot be applied to this representation, return nullptr.

vtkTrivialProducer* vtkDataRepresentation::GetInternalInput ( int  port,
int  conn 
)
protected
void vtkDataRepresentation::SetInternalInput ( int  port,
int  conn,
vtkTrivialProducer producer 
)
protected

Friends And Related Function Documentation

friend class vtkView
friend

Definition at line 277 of file vtkDataRepresentation.h.

friend class vtkRenderView
friend

Definition at line 278 of file vtkDataRepresentation.h.

friend class Command
friend

Definition at line 279 of file vtkDataRepresentation.h.

Member Data Documentation

vtkAnnotationLink* vtkDataRepresentation::AnnotationLinkInternal
protected

The annotation link for this representation.

Definition at line 261 of file vtkDataRepresentation.h.

bool vtkDataRepresentation::Selectable
protected

Definition at line 265 of file vtkDataRepresentation.h.

int vtkDataRepresentation::SelectionType
protected

The selection type created by the view.

Definition at line 270 of file vtkDataRepresentation.h.

vtkStringArray* vtkDataRepresentation::SelectionArrayNames
protected

If a VALUES selection, the array names used in the selection.

Definition at line 275 of file vtkDataRepresentation.h.

Command* vtkDataRepresentation::Observer
protected

Definition at line 281 of file vtkDataRepresentation.h.


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