ParaView
Public Member Functions | Static Public Member Functions | Protected Member Functions
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]

List of all members.

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkPVDataRepresentationGetActiveRepresentation ()
virtual void MarkModified ()
virtual vtkSelectionConvertSelection (vtkView *view, vtkSelection *selection)
virtual vtkDataObjectGetRenderedDataObject (int port)
virtual void Update ()
vtkStringArrayGetRepresentationTypes ()
virtual void SetVisibility (bool val)
virtual int ProcessViewRequest (vtkInformationRequestKey *request_type, vtkInformation *inInfo, vtkInformation *outInfo)
void AddRepresentation (const char *key, vtkPVDataRepresentation *repr)
void RemoveRepresentation (vtkPVDataRepresentation *repr)
void RemoveRepresentation (const char *key)
void SetActiveRepresentation (const char *key)
const char * GetActiveRepresentationKey ()
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetUpdateTime (double time)
virtual void SetUseCache (bool val)
virtual void SetCacheKey (double val)
virtual void SetForceUseCache (bool val)
virtual void SetForcedCacheKey (double val)

Static Public Member Functions

static vtkCompositeRepresentationNew ()
static int IsTypeOf (const char *type)
static vtkCompositeRepresentationSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCompositeRepresentation ()
 ~vtkCompositeRepresentation ()
virtual int FillInputPortInformation (int, vtkInformation *info)
virtual bool AddToView (vtkView *view)
virtual bool RemoveFromView (vtkView *view)
void TriggerUpdateDataEvent ()

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 38 of file vtkCompositeRepresentation.h.


Constructor & Destructor Documentation

vtkCompositeRepresentation::vtkCompositeRepresentation ( ) [protected]
vtkCompositeRepresentation::~vtkCompositeRepresentation ( ) [protected]

Member Function Documentation

static vtkCompositeRepresentation* vtkCompositeRepresentation::New ( ) [static]

Reimplemented from vtkDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual const char* vtkCompositeRepresentation::GetClassName ( ) [virtual]

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

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

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::SetVisibility ( bool  val) [virtual]

Methods overridden to propagate to the active representation.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual int vtkCompositeRepresentation::ProcessViewRequest ( vtkInformationRequestKey request_type,
vtkInformation inInfo,
vtkInformation outInfo 
) [virtual]

Methods overridden to propagate to the active representation.

Reimplemented from vtkPVDataRepresentation.

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

Add/Remove representations. key is a unique string used to identify that representation.

void vtkCompositeRepresentation::RemoveRepresentation ( vtkPVDataRepresentation repr)

Add/Remove representations. key is a unique string used to identify that representation.

void vtkCompositeRepresentation::RemoveRepresentation ( const char *  key)

Add/Remove representations. key is a unique string used to identify that representation.

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.

const char* vtkCompositeRepresentation::GetActiveRepresentationKey ( )

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

vtkPVDataRepresentation* vtkCompositeRepresentation::GetActiveRepresentation ( )

Returns the active representation if valid.

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 from vtkAlgorithm.

Reimplemented in vtkPVCompositeRepresentation.

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 from vtkAlgorithm.

Reimplemented in vtkPVCompositeRepresentation.

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 from vtkAlgorithm.

Reimplemented in vtkPVCompositeRepresentation.

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 from vtkAlgorithm.

Reimplemented in vtkPVCompositeRepresentation.

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 from vtkAlgorithm.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::MarkModified ( ) [virtual]

Propagate the modification to all internal representations.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual vtkSelection* vtkCompositeRepresentation::ConvertSelection ( vtkView view,
vtkSelection selection 
) [virtual]

Overridden to forward to active representation.

Reimplemented from vtkDataRepresentation.

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

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

virtual void vtkCompositeRepresentation::SetUpdateTime ( double  time) [virtual]

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::SetUseCache ( bool  val) [virtual]

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::SetCacheKey ( double  val) [virtual]

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::SetForceUseCache ( bool  val) [virtual]

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::SetForcedCacheKey ( double  val) [virtual]

Passed on to internal representations as well.

Reimplemented from vtkPVDataRepresentation.

Reimplemented in vtkPVCompositeRepresentation.

virtual void vtkCompositeRepresentation::Update ( ) [virtual]

Bring this algorithm's outputs up-to-date.

Reimplemented from vtkAlgorithm.

vtkStringArray* vtkCompositeRepresentation::GetRepresentationTypes ( )

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

virtual int vtkCompositeRepresentation::FillInputPortInformation ( int  ,
vtkInformation info 
) [protected, virtual]

Reimplemented from vtkPassInputTypeAlgorithm.

Reimplemented in vtkPVCompositeRepresentation.

virtual bool vtkCompositeRepresentation::AddToView ( vtkView view) [protected, virtual]

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.

virtual bool vtkCompositeRepresentation::RemoveFromView ( vtkView view) [protected, virtual]

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.

void vtkCompositeRepresentation::TriggerUpdateDataEvent ( ) [protected]

Fires UpdateDataEvent


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