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

combine multiple representations into one with only 1 representation active at a time. More...

#include <vtkCompositeRepresentation.h>

Inheritance diagram for vtkCompositeRepresentation:
Inheritance graph
[legend]
Collaboration diagram for vtkCompositeRepresentation:
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 void SetVisibility (bool val)
 Methods overridden to propagate to the active representation. More...
 
vtkPVDataRepresentationGetActiveRepresentation ()
 Returns the active representation if valid. More...
 
virtual void MarkModified ()
 Propagate the modification to all internal representations. 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...
 
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...
 
- 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...
 
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...
 
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 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

 vtkCompositeRepresentation ()
 
 ~vtkCompositeRepresentation ()
 
virtual int FillInputPortInformation (int, vtkInformation *info)
 
virtual bool AddToView (vtkView *view)
 Adds the representation to the view. More...
 
virtual bool RemoveFromView (vtkView *view)
 Removes the representation to the view. More...
 
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 *)
 

Additional Inherited Members

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

Detailed Description

combine multiple representations into one with only 1 representation active at a time.

vtkCompositeRepresentation makes is possible to combine multiple representations into one. Only one representation can be active at a give time. vtkCompositeRepresentation provides API to add the representations that form the composite and to pick the active representation.

vtkCompositeRepresentation relies on call AddToView and RemoveFromView on the internal representations whenever it needs to change the active representation. So it is essential that representations handle those methods correctly and don't suffer from uncanny side effects when that's done repeatedly.

Definition at line 40 of file vtkCompositeRepresentation.h.

Member Typedef Documentation

§ Superclass

Definition at line 45 of file vtkCompositeRepresentation.h.

Constructor & Destructor Documentation

§ vtkCompositeRepresentation()

vtkCompositeRepresentation::vtkCompositeRepresentation ( )
protected

§ ~vtkCompositeRepresentation()

vtkCompositeRepresentation::~vtkCompositeRepresentation ( )
protected

Member Function Documentation

§ New()

static vtkCompositeRepresentation* vtkCompositeRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtkCompositeRepresentation::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetVisibility()

virtual void vtkCompositeRepresentation::SetVisibility ( bool  val)
virtual

Methods overridden to propagate to the active representation.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation, and vtkPVCompositeOrthographicSliceRepresentation.

§ AddRepresentation()

virtual void vtkCompositeRepresentation::AddRepresentation ( const char *  key,
vtkPVDataRepresentation repr 
)
virtual

Add/Remove representations.

key is a unique string used to identify that representation.

§ RemoveRepresentation() [1/2]

virtual void vtkCompositeRepresentation::RemoveRepresentation ( vtkPVDataRepresentation repr)
virtual

Add/Remove representations.

key is a unique string used to identify that representation.

§ RemoveRepresentation() [2/2]

virtual void vtkCompositeRepresentation::RemoveRepresentation ( const char *  key)
virtual

Add/Remove representations.

key is a unique string used to identify that representation.

§ SetActiveRepresentation()

void vtkCompositeRepresentation::SetActiveRepresentation ( const char *  key)

Set the active key.

If a valid key is not specified, then none of the representations is treated as active.

§ GetActiveRepresentationKey()

const char* vtkCompositeRepresentation::GetActiveRepresentationKey ( )

Set the active key.

If a valid key is not specified, then none of the representations is treated as active.

§ GetActiveRepresentation()

vtkPVDataRepresentation* vtkCompositeRepresentation::GetActiveRepresentation ( )

Returns the active representation if valid.

§ SetInputConnection() [1/2]

virtual void vtkCompositeRepresentation::SetInputConnection ( int  port,
vtkAlgorithmOutput *  input 
)
virtual

Overridden to simply pass the input to the internal representations.

We won't need this if vtkPVDataRepresentation correctly respected in the arguments passed to it during ProcessRequest() etc.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

§ SetInputConnection() [2/2]

virtual void vtkCompositeRepresentation::SetInputConnection ( vtkAlgorithmOutput *  input)
virtual

Overridden to simply pass the input to the internal representations.

We won't need this if vtkPVDataRepresentation correctly respected in the arguments passed to it during ProcessRequest() etc.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

§ AddInputConnection() [1/2]

virtual void vtkCompositeRepresentation::AddInputConnection ( int  port,
vtkAlgorithmOutput *  input 
)
virtual

Overridden to simply pass the input to the internal representations.

We won't need this if vtkPVDataRepresentation correctly respected in the arguments passed to it during ProcessRequest() etc.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

§ AddInputConnection() [2/2]

virtual void vtkCompositeRepresentation::AddInputConnection ( vtkAlgorithmOutput *  input)
virtual

Overridden to simply pass the input to the internal representations.

We won't need this if vtkPVDataRepresentation correctly respected in the arguments passed to it during ProcessRequest() etc.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

§ RemoveInputConnection() [1/2]

virtual void vtkCompositeRepresentation::RemoveInputConnection ( int  port,
vtkAlgorithmOutput *  input 
)
virtual

Overridden to simply pass the input to the internal representations.

We won't need this if vtkPVDataRepresentation correctly respected in the arguments passed to it during ProcessRequest() etc.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

§ RemoveInputConnection() [2/2]

virtual void vtkCompositeRepresentation::RemoveInputConnection ( int  port,
int  idx 
)
virtual

Overridden to simply pass the input to the internal representations.

We won't need this if vtkPVDataRepresentation correctly respected in the arguments passed to it during ProcessRequest() etc.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation.

§ MarkModified()

virtual void vtkCompositeRepresentation::MarkModified ( )
virtual

Propagate the modification to all internal representations.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeOrthographicSliceRepresentation, and vtkPVCompositeRepresentation.

§ GetRenderedDataObject()

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

Returns the data object that is rendered from the given input port.

§ GetRepresentationTypes()

vtkStringArray* vtkCompositeRepresentation::GetRepresentationTypes ( )

Returns the list of available representation types as a string array.

§ SetUpdateTime()

virtual void vtkCompositeRepresentation::SetUpdateTime ( double  time)
virtual

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

§ SetForceUseCache()

virtual void vtkCompositeRepresentation::SetForceUseCache ( bool  val)
virtual

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

§ SetForcedCacheKey()

virtual void vtkCompositeRepresentation::SetForcedCacheKey ( double  val)
virtual

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

§ FillInputPortInformation()

virtual int vtkCompositeRepresentation::FillInputPortInformation ( int  ,
vtkInformation *  info 
)
protectedvirtual

§ AddToView()

virtual bool vtkCompositeRepresentation::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 vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation, and vtkPVCompositeOrthographicSliceRepresentation.

§ RemoveFromView()

virtual bool vtkCompositeRepresentation::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 vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation, and vtkPVCompositeOrthographicSliceRepresentation.

§ TriggerUpdateDataEvent()

void vtkCompositeRepresentation::TriggerUpdateDataEvent ( )
protected

Fires UpdateDataEvent.


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