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

#include <vtkMoleculeRepresentation.h>

Inheritance diagram for vtkMoleculeRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkMoleculeRepresentation:
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 *requestType, vtkInformation *inputInfo, vtkInformation *outputInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. More...
 
virtual void SetVisibility (bool value)
 Get/Set the visibility for this representation. More...
 
virtual int GetMoleculeRenderMode ()
 
void SetMoleculeRenderMode (int mode)
 
virtual bool GetUseCustomRadii ()
 
void SetUseCustomRadii (bool val)
 
void SetLookupTable (vtkScalarsToColors *lut)
 
void SetRepresentation (const char *)
 
virtual vtkDataObject * GetRenderedDataObject (int port)
 
void MarkModified ()
 This is one of the most important functions. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
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 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...
 

Static Public Member Functions

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

Protected Member Functions

 vtkMoleculeRepresentation ()
 
 ~vtkMoleculeRepresentation ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
virtual bool AddToView (vtkView *view)
 Making these methods public. More...
 
virtual bool RemoveFromView (vtkView *view)
 Making these methods public. More...
 
bool IsCached (double cache_key)
 Subclasses should override this method when they support caching to indicate if the particular key is cached. More...
 
void SyncMapper ()
 
void UpdateColoringParameters ()
 
- Protected Member Functions inherited from vtkPVDataRepresentation
 vtkPVDataRepresentation ()
 
 ~vtkPVDataRepresentation ()
 
virtual vtkExecutive * CreateDefaultExecutive ()
 Create a default executive. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

vtkActor * Actor
 
vtkMoleculeMapper * Mapper
 
vtkNew< vtkPVCacheKeeperCacheKeeper
 
vtkNew< vtkMolecule > DummyMolecule
 
int MoleculeRenderMode
 
bool UseCustomRadii
 
double DataBounds [6]
 
- Protected Attributes inherited from vtkPVDataRepresentation
double UpdateTime
 
bool UpdateTimeValid
 
unsigned int UniqueIdentifier
 

Detailed Description

Definition at line 30 of file vtkMoleculeRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 35 of file vtkMoleculeRepresentation.h.

Constructor & Destructor Documentation

§ vtkMoleculeRepresentation()

vtkMoleculeRepresentation::vtkMoleculeRepresentation ( )
protected

§ ~vtkMoleculeRepresentation()

vtkMoleculeRepresentation::~vtkMoleculeRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkMoleculeRepresentation* vtkMoleculeRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkMoleculeRepresentation::GetClassName ( )
virtual

Reimplemented from vtkPVDataRepresentation.

§ IsTypeOf()

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

§ IsA()

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

Reimplemented from vtkPVDataRepresentation.

§ SafeDownCast()

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

§ PrintSelf()

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

§ ProcessViewRequest()

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

§ SetVisibility()

virtual void vtkMoleculeRepresentation::SetVisibility ( bool  val)
virtual

Get/Set the visibility for this representation.

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

Reimplemented from vtkPVDataRepresentation.

§ GetMoleculeRenderMode()

virtual int vtkMoleculeRepresentation::GetMoleculeRenderMode ( )
virtual

§ SetMoleculeRenderMode()

void vtkMoleculeRepresentation::SetMoleculeRenderMode ( int  mode)

§ GetUseCustomRadii()

virtual bool vtkMoleculeRepresentation::GetUseCustomRadii ( )
virtual

§ SetUseCustomRadii()

void vtkMoleculeRepresentation::SetUseCustomRadii ( bool  val)

§ SetLookupTable()

void vtkMoleculeRepresentation::SetLookupTable ( vtkScalarsToColors *  lut)

§ SetRepresentation()

void vtkMoleculeRepresentation::SetRepresentation ( const char *  )
inline

Definition at line 52 of file vtkMoleculeRepresentation.h.

§ GetRenderedDataObject()

virtual vtkDataObject* vtkMoleculeRepresentation::GetRenderedDataObject ( int  port)
virtual

§ MarkModified()

void vtkMoleculeRepresentation::MarkModified ( )
virtual

This is one of the most important functions.

In VTK pipelines, it's very easy for the pipeline to decide when it needs to re-execute. vtkAlgorithm::Update() can go up the entire pipeline to see if any filters MTime changed (among other things) and if so, it can re-execute the pipeline. However in case of representations, the real input connection may only be present on the data-server nodes. In that case the vtkPVDataRepresentation::RequestData() will only get called on the data-server nodes. That means that representations won't be able to any data-delivery in RequestData(). We'd need some other mechanisms to synchronize data-delivery among processes. To avoid that conundrum, the vtkSMRepresentationProxy calls MarkModified() on all processes whenever any filter in the pipeline is modified. In this method, the vtkPVDataRepresentation subclasses should ensure that they mark all delivery related filters dirty in their RequestData to ensure they execute then next time they are updated. The vtkPVDataRepresentation also uses a special executive which avoids updating the representation unless MarkModified() was called since the last Update(), thus acting as a update-suppressor.

Reimplemented from vtkPVDataRepresentation.

§ FillInputPortInformation()

virtual int vtkMoleculeRepresentation::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

§ RequestData()

virtual int vtkMoleculeRepresentation::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Overridden to invoke vtkCommand::UpdateDataEvent.

Reimplemented from vtkPVDataRepresentation.

§ AddToView()

virtual bool vtkMoleculeRepresentation::AddToView ( vtkView *  view)
protectedvirtual

Making these methods public.

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

Reimplemented from vtkPVDataRepresentation.

§ RemoveFromView()

virtual bool vtkMoleculeRepresentation::RemoveFromView ( vtkView *  view)
protectedvirtual

Making these methods public.

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

Reimplemented from vtkPVDataRepresentation.

§ IsCached()

bool vtkMoleculeRepresentation::IsCached ( double  cache_key)
protectedvirtual

Subclasses should override this method when they support caching to indicate if the particular key is cached.

Default returns false.

Reimplemented from vtkPVDataRepresentation.

§ SyncMapper()

void vtkMoleculeRepresentation::SyncMapper ( )
protected

§ UpdateColoringParameters()

void vtkMoleculeRepresentation::UpdateColoringParameters ( )
protected

Member Data Documentation

§ Actor

vtkActor* vtkMoleculeRepresentation::Actor
protected

Definition at line 74 of file vtkMoleculeRepresentation.h.

§ Mapper

vtkMoleculeMapper* vtkMoleculeRepresentation::Mapper
protected

Definition at line 75 of file vtkMoleculeRepresentation.h.

§ CacheKeeper

vtkNew<vtkPVCacheKeeper> vtkMoleculeRepresentation::CacheKeeper
protected

Definition at line 77 of file vtkMoleculeRepresentation.h.

§ DummyMolecule

vtkNew<vtkMolecule> vtkMoleculeRepresentation::DummyMolecule
protected

Definition at line 78 of file vtkMoleculeRepresentation.h.

§ MoleculeRenderMode

int vtkMoleculeRepresentation::MoleculeRenderMode
protected

Definition at line 80 of file vtkMoleculeRepresentation.h.

§ UseCustomRadii

bool vtkMoleculeRepresentation::UseCustomRadii
protected

Definition at line 81 of file vtkMoleculeRepresentation.h.

§ DataBounds

double vtkMoleculeRepresentation::DataBounds[6]
protected

Definition at line 83 of file vtkMoleculeRepresentation.h.


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