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

vtk3DWidgetRepresentation is a vtkDataRepresentation subclass for 3D widgets and their representations. More...

#include <vtk3DWidgetRepresentation.h>

Inherits vtkDataRepresentation.

Public Types

typedef vtkDataRepresentation Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetWidget (vtkAbstractWidget *)
 Get/Set the widget. More...
 
virtual vtkAbstractWidget * GetWidget ()
 Get/Set the widget. More...
 
void SetRepresentation (vtkWidgetRepresentation *)
 Get/Set the representation. More...
 
virtual vtkWidgetRepresentation * GetRepresentation ()
 Get/Set the representation. More...
 
virtual void SetUseNonCompositedRenderer (bool)
 Set to true to add the vtkWidgetRepresentation to the non-composited renderer. More...
 
virtual bool GetUseNonCompositedRenderer ()
 Set to true to add the vtkWidgetRepresentation to the non-composited renderer. More...
 
virtual void UseNonCompositedRendererOn ()
 Set to true to add the vtkWidgetRepresentation to the non-composited renderer. More...
 
virtual void UseNonCompositedRendererOff ()
 Set to true to add the vtkWidgetRepresentation to the non-composited renderer. More...
 
void SetEnabled (bool)
 Get/Set whether the widget is enabled. More...
 
virtual bool GetEnabled ()
 Get/Set whether the widget is enabled. More...
 
virtual void EnabledOn ()
 Get/Set whether the widget is enabled. More...
 
virtual void EnabledOff ()
 Get/Set whether the widget is enabled. More...
 

Static Public Member Functions

static vtk3DWidgetRepresentationNew ()
 
static int IsTypeOf (const char *type)
 
static vtk3DWidgetRepresentationSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtk3DWidgetRepresentation ()
 
 ~vtk3DWidgetRepresentation ()
 
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 UpdateEnabled ()
 Updates 'Enabled' on this->Widget. More...
 
void OnRepresentationModified ()
 Callback whenever the representation is modified. More...
 
void OnViewModified ()
 Callback whenever the view is modified. More...
 

Protected Attributes

bool Enabled
 
bool UseNonCompositedRenderer
 
vtkAbstractWidget * Widget
 
vtkWidgetRepresentation * Representation
 
vtkWeakPointer< vtkPVRenderViewView
 

Detailed Description

vtk3DWidgetRepresentation is a vtkDataRepresentation subclass for 3D widgets and their representations.

It makes it possible to add 3D widgets to vtkPVRenderView.

Definition at line 34 of file vtk3DWidgetRepresentation.h.

Member Typedef Documentation

§ Superclass

typedef vtkDataRepresentation vtk3DWidgetRepresentation::Superclass

Definition at line 38 of file vtk3DWidgetRepresentation.h.

Constructor & Destructor Documentation

§ vtk3DWidgetRepresentation()

vtk3DWidgetRepresentation::vtk3DWidgetRepresentation ( )
protected

§ ~vtk3DWidgetRepresentation()

vtk3DWidgetRepresentation::~vtk3DWidgetRepresentation ( )
protected

Member Function Documentation

§ New()

static vtk3DWidgetRepresentation* vtk3DWidgetRepresentation::New ( )
static

§ GetClassName()

virtual const char* vtk3DWidgetRepresentation::GetClassName ( )
virtual

§ IsTypeOf()

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

§ IsA()

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

§ SafeDownCast()

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

§ PrintSelf()

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

§ SetWidget()

void vtk3DWidgetRepresentation::SetWidget ( vtkAbstractWidget *  )

Get/Set the widget.

§ GetWidget()

virtual vtkAbstractWidget* vtk3DWidgetRepresentation::GetWidget ( )
virtual

Get/Set the widget.

§ SetRepresentation()

void vtk3DWidgetRepresentation::SetRepresentation ( vtkWidgetRepresentation *  )

Get/Set the representation.

§ GetRepresentation()

virtual vtkWidgetRepresentation* vtk3DWidgetRepresentation::GetRepresentation ( )
virtual

Get/Set the representation.

§ SetUseNonCompositedRenderer()

virtual void vtk3DWidgetRepresentation::SetUseNonCompositedRenderer ( bool  )
virtual

Set to true to add the vtkWidgetRepresentation to the non-composited renderer.

false by default.

§ GetUseNonCompositedRenderer()

virtual bool vtk3DWidgetRepresentation::GetUseNonCompositedRenderer ( )
virtual

Set to true to add the vtkWidgetRepresentation to the non-composited renderer.

false by default.

§ UseNonCompositedRendererOn()

virtual void vtk3DWidgetRepresentation::UseNonCompositedRendererOn ( )
virtual

Set to true to add the vtkWidgetRepresentation to the non-composited renderer.

false by default.

§ UseNonCompositedRendererOff()

virtual void vtk3DWidgetRepresentation::UseNonCompositedRendererOff ( )
virtual

Set to true to add the vtkWidgetRepresentation to the non-composited renderer.

false by default.

§ SetEnabled()

void vtk3DWidgetRepresentation::SetEnabled ( bool  )

Get/Set whether the widget is enabled.

§ GetEnabled()

virtual bool vtk3DWidgetRepresentation::GetEnabled ( )
virtual

Get/Set whether the widget is enabled.

§ EnabledOn()

virtual void vtk3DWidgetRepresentation::EnabledOn ( )
virtual

Get/Set whether the widget is enabled.

§ EnabledOff()

virtual void vtk3DWidgetRepresentation::EnabledOff ( )
virtual

Get/Set whether the widget is enabled.

§ AddToView()

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

§ RemoveFromView()

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

§ UpdateEnabled()

void vtk3DWidgetRepresentation::UpdateEnabled ( )
protected

Updates 'Enabled' on this->Widget.

§ OnRepresentationModified()

void vtk3DWidgetRepresentation::OnRepresentationModified ( )
protected

Callback whenever the representation is modified.

We call UpdateEnabled() to ensure that the widget is not left enabled when the representation is hidden.

§ OnViewModified()

void vtk3DWidgetRepresentation::OnViewModified ( )
protected

Callback whenever the view is modified.

If the view's interactor has changed, we will pass that to the vtkAbstractWidget instance and then call UpdateEnabled().

Member Data Documentation

§ Enabled

bool vtk3DWidgetRepresentation::Enabled
protected

Definition at line 113 of file vtk3DWidgetRepresentation.h.

§ UseNonCompositedRenderer

bool vtk3DWidgetRepresentation::UseNonCompositedRenderer
protected

Definition at line 114 of file vtk3DWidgetRepresentation.h.

§ Widget

vtkAbstractWidget* vtk3DWidgetRepresentation::Widget
protected

Definition at line 115 of file vtk3DWidgetRepresentation.h.

§ Representation

vtkWidgetRepresentation* vtk3DWidgetRepresentation::Representation
protected

Definition at line 116 of file vtk3DWidgetRepresentation.h.

§ View

vtkWeakPointer<vtkPVRenderView> vtk3DWidgetRepresentation::View
protected

Definition at line 117 of file vtk3DWidgetRepresentation.h.


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