ParaView
Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Friends
pqRepresentation Class Reference

This is PQ representation for a single representation. More...

#include <pqRepresentation.h>

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

List of all members.

Public Slots

void renderView (bool force)
 Renders the view to which this representation has been added if any.
void renderViewEventually ()
 Simply calls renderView(false);.

Signals

void visibilityChanged (bool visible)
 Fired when the visibility property of the underlying display changes.
void updated ()
 Fired whenever Update() is called on the underlying display proxy.

Public Member Functions

 pqRepresentation (const QString &group, const QString &name, vtkSMProxy *repr, pqServer *server, QObject *parent=NULL)
virtual ~pqRepresentation ()
virtual bool isVisible () const
 Returns if the status of the visbility property of this display.
virtual void setVisible (bool visible)
 Set the visibility.
pqViewgetView () const
 Returns the view to which this representation has been added, if any.

Protected Slots

virtual void onVisibilityChanged ()
 called when the display visibility property changes.

Protected Member Functions

void setView (pqView *)
 Called by pqView when this representation gets added to / removed from the view.

Friends

class pqView

Detailed Description

This is PQ representation for a single representation.

This class provides API for the Qt layer to access representations.

Definition at line 45 of file pqRepresentation.h.


Constructor & Destructor Documentation

pqRepresentation::pqRepresentation ( const QString &  group,
const QString &  name,
vtkSMProxy repr,
pqServer server,
QObject *  parent = NULL 
)
virtual pqRepresentation::~pqRepresentation ( ) [virtual]

Member Function Documentation

virtual bool pqRepresentation::isVisible ( ) const [virtual]

Returns if the status of the visbility property of this display.

Note that for a display to be visible in a view, it must be added to that view as well as visibility must be set to 1.

virtual void pqRepresentation::setVisible ( bool  visible) [virtual]

Set the visibility.

Note that this affects the visibility of the display in the view it has been added to, if any. This method does not call a re-render on the view, caller must call that explicitly.

Reimplemented in pqScalarBarRepresentation.

pqView* pqRepresentation::getView ( ) const

Returns the view to which this representation has been added, if any.

void pqRepresentation::renderView ( bool  force) [slot]

Renders the view to which this representation has been added if any.

If force is true, then the render is triggerred immediately, otherwise, it will be called on idle.

void pqRepresentation::renderViewEventually ( ) [inline, slot]

Simply calls renderView(false);.

Definition at line 84 of file pqRepresentation.h.

void pqRepresentation::visibilityChanged ( bool  visible) [signal]

Fired when the visibility property of the underlying display changes.

It must be noted that this is fired on the property change, the property is not pushed yet, hence the visibility of the underlying VTK prop hasn't changed.

void pqRepresentation::updated ( ) [signal]

Fired whenever Update() is called on the underlying display proxy.

virtual void pqRepresentation::onVisibilityChanged ( ) [protected, virtual, slot]

called when the display visibility property changes.

void pqRepresentation::setView ( pqView ) [protected]

Called by pqView when this representation gets added to / removed from the view.


Friends And Related Function Documentation

friend class pqView [friend]

Definition at line 101 of file pqRepresentation.h.


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