ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkPythonRepresentation Class Reference

Representation for showing data in a vtkPythonView. More...

#include <vtkPythonRepresentation.h>

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

Public Types

typedef vtkPVDataRepresentation Superclass
 
- Public Types inherited from vtkPVDataRepresentation
typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
int GetNumberOfAttributeArrays (int attributeType)
 Get number of arrays in an attribute (e.g., vtkDataObject::POINT, vtkDataObject::CELL, vtkDataObject::ROW, vtkDataObject::FIELD_DATA). More...
 
const char * GetAttributeArrayName (int attributeType, int arrayIndex)
 From the input data, get the name of attribute array at index for the given attribute type. More...
 
void SetAttributeArrayStatus (int attributeType, const char *name, int status)
 Set the array status for the input data object. More...
 
int GetAttributeArrayStatus (int attributeType, const char *name)
 Get the status indicating whether the array with the given name and attribute type in the input will be copied to the client. More...
 
void EnableAllAttributeArrays ()
 Enable all arrays. More...
 
void DisableAllAttributeArrays ()
 Disable all arrays. More...
 
virtual vtkDataObject * GetLocalInput ()
 Gets local copy of the input. More...
 
virtual vtkDataObject * GetClientDataObject ()
 Gets the client's copy of the input. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void MarkModified ()
 This is one of the most important functions. More...
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Initialize the representation with an identifier range so each internal representation can own a unique ID. More...
 
unsigned int GetUniqueIdentifier ()
 Return 0 if the Initialize() method was not called otherwise a unique ID that will be shared across the processes for that same object. More...
 
virtual void SetVisibility (bool val)
 Get/Set the visibility for this representation. More...
 
virtual bool GetVisibility ()
 
virtual vtkDataObject * GetRenderedDataObject (int vtkNotUsed(port))
 Returns the data object that is rendered from the given input port. More...
 
virtual void SetForcedCacheKey (double val)
 Typically a representation decides whether to use cache based on the view's values for UseCache and CacheKey. More...
 
virtual void SetForceUseCache (bool val)
 
bool GetUsingCacheForUpdate ()
 Called by vtkPVDataRepresentationPipeline to see if using cache is valid and will be used for the update. More...
 
virtual bool GetNeedUpdate ()
 
virtual vtkAlgorithmOutput * GetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index. More...
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutput * GetInternalOutputPort (int port, int conn)
 
vtkView * GetView () const
 Provides access to the view. More...
 
virtual void SetUpdateTime (double time)
 Set the update time. More...
 
virtual double GetUpdateTime ()
 Set the update time. More...
 
virtual bool GetUpdateTimeValid ()
 Set whether the UpdateTime is valid. More...
 
virtual void SetUseCache (bool)
 
virtual void SetCacheKey (double val)
 
virtual double GetCacheKey ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool GetUseCache ()
 Returns whether caching is used and what key to use when caching is enabled. More...
 
virtual bool AddToView (vtkView *view)
 Making these methods public. More...
 
virtual bool RemoveFromView (vtkView *view)
 Making these methods public. More...
 

Static Public Member Functions

static vtkPythonRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPythonRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPythonRepresentation ()
 
 ~vtkPythonRepresentation ()
 
int FillInputPortInformation (int port, vtkInformation *info)
 Overridden to make input optional. More...
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to copy data from the server to the client. More...
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual bool IsCached (double cache_key)
 Subclasses should override this method when they support caching to indicate if the particular key is cached. More...
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Additional Inherited Members

- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

Representation for showing data in a vtkPythonView.

This representation does not create any intermediate data for display. Instead, it simply fetches data from the server.

Definition at line 32 of file vtkPythonRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 36 of file vtkPythonRepresentation.h.

Constructor & Destructor Documentation

§ vtkPythonRepresentation()

vtkPythonRepresentation::vtkPythonRepresentation ( )
protected

§ ~vtkPythonRepresentation()

vtkPythonRepresentation::~vtkPythonRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkPythonRepresentation* vtkPythonRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkPythonRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVDataRepresentation.

§ SafeDownCast()

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

§ PrintSelf()

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

§ ProcessViewRequest()

virtual int vtkPythonRepresentation::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.

Reimplemented from vtkPVDataRepresentation.

§ GetLocalInput()

virtual vtkDataObject* vtkPythonRepresentation::GetLocalInput ( )
virtual

Gets local copy of the input.

This will be NULL on the client when running in client-only mode until after Update() is called.

§ GetClientDataObject()

virtual vtkDataObject* vtkPythonRepresentation::GetClientDataObject ( )
virtual

Gets the client's copy of the input.

§ GetNumberOfAttributeArrays()

int vtkPythonRepresentation::GetNumberOfAttributeArrays ( int  attributeType)

Get number of arrays in an attribute (e.g., vtkDataObject::POINT, vtkDataObject::CELL, vtkDataObject::ROW, vtkDataObject::FIELD_DATA).

§ GetAttributeArrayName()

const char* vtkPythonRepresentation::GetAttributeArrayName ( int  attributeType,
int  arrayIndex 
)

From the input data, get the name of attribute array at index for the given attribute type.

§ SetAttributeArrayStatus()

void vtkPythonRepresentation::SetAttributeArrayStatus ( int  attributeType,
const char *  name,
int  status 
)

Set the array status for the input data object.

A status of 1 means that the array with the given name for the given attribute will be copied to the client. A status of 0 means the array will not be copied to the client. The status is 0 by default.

§ GetAttributeArrayStatus()

int vtkPythonRepresentation::GetAttributeArrayStatus ( int  attributeType,
const char *  name 
)

Get the status indicating whether the array with the given name and attribute type in the input will be copied to the client.

Status is 0 by default.

§ EnableAllAttributeArrays()

void vtkPythonRepresentation::EnableAllAttributeArrays ( )

Enable all arrays.

When called, all arrays will be marked as enabled.

§ DisableAllAttributeArrays()

void vtkPythonRepresentation::DisableAllAttributeArrays ( )

Disable all arrays.

When called, all arrays will be marked as disabled.

§ FillInputPortInformation()

int vtkPythonRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protected

Overridden to make input optional.

§ RequestData()

int vtkPythonRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Overridden to copy data from the server to the client.

Reimplemented from vtkPVDataRepresentation.


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