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

a data-representation used by ParaView. More...

#include <vtkPVCompositeRepresentation.h>

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

Public Types

typedef vtkCompositeRepresentation Superclass
 
- Public Types inherited from vtkCompositeRepresentation
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)
 
void SetSelectionRepresentation (vtkSelectionRepresentation *)
 These must only be set during initialization before adding the representation to any views or calling Update(). More...
 
virtual void MarkModified ()
 Propagate the modification to all internal representations. More...
 
virtual void SetVisibility (bool visible)
 Set visibility of the representation. More...
 
virtual void SetSelectionVisibility (bool visible)
 Set the selection visibility. More...
 
virtual unsigned int Initialize (unsigned int minIdAvailable, unsigned int maxIdAvailable)
 Override because of internal composite representations that need to be initilized as well. More...
 
virtual void SetUpdateTime (double time)
 Passed on to internal representations as well. More...
 
virtual void SetForceUseCache (bool val)
 Passed on to internal representations as well. More...
 
virtual void SetForcedCacheKey (double val)
 Passed on to internal representations as well. More...
 
virtual void SetPointFieldDataArrayName (const char *)
 Forwarded to vtkSelectionRepresentation. More...
 
virtual void SetCellFieldDataArrayName (const char *)
 Forwarded to vtkSelectionRepresentation. More...
 
- Public Member Functions inherited from vtkCompositeRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkPVDataRepresentationGetActiveRepresentation ()
 Returns the active representation if valid. More...
 
virtual vtkDataObject * GetRenderedDataObject (int port)
 Returns the data object that is rendered from the given input port. More...
 
vtkStringArray * GetRepresentationTypes ()
 Returns the list of available representation types as a string array. More...
 
virtual void AddRepresentation (const char *key, vtkPVDataRepresentation *repr)
 Add/Remove representations. More...
 
virtual void RemoveRepresentation (vtkPVDataRepresentation *repr)
 Add/Remove representations. More...
 
virtual void RemoveRepresentation (const char *key)
 Add/Remove representations. More...
 
void SetActiveRepresentation (const char *key)
 Set the active key. More...
 
const char * GetActiveRepresentationKey ()
 Set the active key. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Overridden to simply pass the input to the internal representations. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Overridden to simply pass the input to the internal representations. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Overridden to simply pass the input to the internal representations. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Overridden to simply pass the input to the internal representations. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Overridden to simply pass the input to the internal representations. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Overridden to simply pass the input to the internal representations. More...
 
- Public Member Functions inherited from vtkPVDataRepresentation
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
 vtkAlgorithm::ProcessRequest() equivalent for rendering passes. 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...
 
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 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 vtkPVCompositeRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVCompositeRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkCompositeRepresentation
static vtkCompositeRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCompositeRepresentationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataRepresentation
static int IsTypeOf (const char *type)
 
static vtkPVDataRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkPVCompositeRepresentation ()
 
 ~vtkPVCompositeRepresentation ()
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
- Protected Member Functions inherited from vtkCompositeRepresentation
 vtkCompositeRepresentation ()
 
 ~vtkCompositeRepresentation ()
 
virtual int FillInputPortInformation (int, vtkInformation *info)
 
void TriggerUpdateDataEvent ()
 Fires UpdateDataEvent. 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 RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 Overridden to invoke vtkCommand::UpdateDataEvent. More...
 
virtual int RequestUpdateExtent (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

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

Detailed Description

a data-representation used by ParaView.

vtkPVCompositeRepresentation is a data-representation used by ParaView for showing a type of data-set in the render view. It is a composite-representation with some fixed representations for showing things like selection and cube-axes. This representation has 1 input port and it ensures that that input is passed on to the internal representations (except SelectionRepresentation) properly. For SelectionRepresentation, the client is expected to setup the input (look at vtkSMPVRepresentationProxy).

Definition at line 36 of file vtkPVCompositeRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkPVCompositeRepresentation.h.

Constructor & Destructor Documentation

◆ vtkPVCompositeRepresentation()

vtkPVCompositeRepresentation::vtkPVCompositeRepresentation ( )
protected

◆ ~vtkPVCompositeRepresentation()

vtkPVCompositeRepresentation::~vtkPVCompositeRepresentation ( )
protected

Member Function Documentation

◆ New()

static vtkPVCompositeRepresentation* vtkPVCompositeRepresentation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVCompositeRepresentation::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ SetSelectionRepresentation()

void vtkPVCompositeRepresentation::SetSelectionRepresentation ( vtkSelectionRepresentation )

These must only be set during initialization before adding the representation to any views or calling Update().

◆ MarkModified()

virtual void vtkPVCompositeRepresentation::MarkModified ( )
virtual

Propagate the modification to all internal representations.

Reimplemented from vtkCompositeRepresentation.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

◆ SetVisibility()

virtual void vtkPVCompositeRepresentation::SetVisibility ( bool  visible)
virtual

Set visibility of the representation.

Overridden to update the cube-axes and selection visibilities.

Reimplemented from vtkCompositeRepresentation.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

◆ SetSelectionVisibility()

virtual void vtkPVCompositeRepresentation::SetSelectionVisibility ( bool  visible)
virtual

Set the selection visibility.

◆ SetUpdateTime()

virtual void vtkPVCompositeRepresentation::SetUpdateTime ( double  time)
virtual

Passed on to internal representations as well.

Reimplemented from vtkCompositeRepresentation.

◆ SetForceUseCache()

virtual void vtkPVCompositeRepresentation::SetForceUseCache ( bool  val)
virtual

Passed on to internal representations as well.

Reimplemented from vtkCompositeRepresentation.

◆ SetForcedCacheKey()

virtual void vtkPVCompositeRepresentation::SetForcedCacheKey ( double  val)
virtual

Passed on to internal representations as well.

Reimplemented from vtkCompositeRepresentation.

◆ SetPointFieldDataArrayName()

virtual void vtkPVCompositeRepresentation::SetPointFieldDataArrayName ( const char *  )
virtual

◆ SetCellFieldDataArrayName()

virtual void vtkPVCompositeRepresentation::SetCellFieldDataArrayName ( const char *  )
virtual

◆ Initialize()

virtual unsigned int vtkPVCompositeRepresentation::Initialize ( unsigned int  minIdAvailable,
unsigned int  maxIdAvailable 
)
virtual

Override because of internal composite representations that need to be initilized as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

◆ AddToView()

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

Adds the representation to the view.

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

Reimplemented from vtkCompositeRepresentation.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

◆ RemoveFromView()

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

Removes the representation to the view.

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

Reimplemented from vtkCompositeRepresentation.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

Member Data Documentation

◆ SelectionRepresentation

vtkSelectionRepresentation* vtkPVCompositeRepresentation::SelectionRepresentation
protected

Definition at line 107 of file vtkPVCompositeRepresentation.h.

◆ SelectionVisibility

bool vtkPVCompositeRepresentation::SelectionVisibility
protected

Definition at line 108 of file vtkPVCompositeRepresentation.h.


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