vtkSMDisplayProxy Class Reference

proxy for any entity that must be rendered. More...

#include <vtkSMDisplayProxy.h>

Inheritance diagram for vtkSMDisplayProxy:

[legend]Collaboration diagram for vtkSMDisplayProxy:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkSMDisplayProxy, vtkSMProxy)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkPVGeometryInformation *	GetGeometryInformation ()
virtual void	Update ()
virtual void	SaveInBatchScript (ofstream *file)
virtual void	AddToRenderModule (vtkSMRenderModuleProxy *)
virtual void	RemoveFromRenderModule (vtkSMRenderModuleProxy *)
void	SetVisibilityCM (int v)
int	GetVisibilityCM ()
Static Public Member Functions
vtkSMDisplayProxy *	New ()
Protected Member Functions
	vtkSMDisplayProxy ()
	~vtkSMDisplayProxy ()
vtkSMProxy *	GetInteractorProxy (vtkSMRenderModuleProxy *ren)
vtkSMProxy *	GetRendererProxy (vtkSMRenderModuleProxy *ren)
vtkSMProxy *	GetRenderer2DProxy (vtkSMRenderModuleProxy *ren)
void	AddPropToRenderer (vtkSMProxy *proxy, vtkSMRenderModuleProxy *ren)
void	AddPropToRenderer2D (vtkSMProxy *proxy, vtkSMRenderModuleProxy *ren)
void	RemovePropFromRenderer (vtkSMProxy *proxy, vtkSMRenderModuleProxy *ren)
void	RemovePropFromRenderer2D (vtkSMProxy *proxy, vtkSMRenderModuleProxy *ren)

---

Detailed Description

proxy for any entity that must be rendered.

vtkSMDisplayProxy is a sink for display objects. Anything that can be rendered has to be a vtkSMDisplayProxy, otherwise it can't be added be added to the vtkSMRenderModule, and hence cannot be rendered. This can have inputs (but not required, for displays such as 3Dwidgets/ Scalarbar). This is an abstract class, merely defining the interface. This class (or subclasses) has a bunch of "convenience methods" (method names appended with CM). These methods do the equivalent of getting the property by the name and setting/getting its value. They are there to simplify using the property interface for display objects. When adding a method to the proxies that merely sets some property on the proxy, make sure to append the method name with "CM" - implying it's a convenience method. That way, one knows its purpose and will not be confused with a update-self property method.

Definition at line 40 of file vtkSMDisplayProxy.h.

---

Constructor & Destructor Documentation

vtkSMDisplayProxy::vtkSMDisplayProxy (   )  [protected]

vtkSMDisplayProxy::~vtkSMDisplayProxy (   )  [protected]

---

Member Function Documentation

vtkSMDisplayProxy* vtkSMDisplayProxy::New (   )  [static]

Reimplemented from vtkSMProxy. Reimplemented in vtkSMAxesProxy, vtkSMBoxWidgetProxy, vtkSMCompositeDisplayProxy, vtkSMCubeAxesDisplayProxy, vtkSMDataObjectDisplayProxy, vtkSMIceTMultiDisplayProxy, vtkSMImplicitPlaneWidgetProxy, vtkSMLineWidgetProxy, vtkSMLODDisplayProxy, vtkSMMultiDisplayProxy, vtkSMPickBoxWidgetProxy, vtkSMPickLineWidgetProxy, vtkSMPickPointWidgetProxy, vtkSMPickSphereWidgetProxy, vtkSMPointLabelDisplayProxy, vtkSMPointWidgetProxy, vtkSMScalarBarWidgetProxy, vtkSMSphereWidgetProxy, and vtkSMXYPlotDisplayProxy.

vtkSMDisplayProxy::vtkTypeRevisionMacro (  vtkSMDisplayProxy  , vtkSMProxy  )

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

Reimplemented from vtkSMProxy. Reimplemented in vtkSM3DWidgetProxy, vtkSMAxesProxy, vtkSMBoxWidgetProxy, vtkSMCompositeDisplayProxy, vtkSMConsumerDisplayProxy, vtkSMCubeAxesDisplayProxy, vtkSMDataObjectDisplayProxy, vtkSMIceTMultiDisplayProxy, vtkSMImplicitPlaneWidgetProxy, vtkSMLineWidgetProxy, vtkSMLODDisplayProxy, vtkSMMultiDisplayProxy, vtkSMPickBoxWidgetProxy, vtkSMPickLineWidgetProxy, vtkSMPickPointWidgetProxy, vtkSMPickSphereWidgetProxy, vtkSMPointLabelDisplayProxy, vtkSMPointWidgetProxy, vtkSMScalarBarWidgetProxy, vtkSMSphereWidgetProxy, and vtkSMXYPlotDisplayProxy.

virtual vtkPVGeometryInformation* vtkSMDisplayProxy::GetGeometryInformation (   )  [inline, virtual]

Get information about the geometry. Some displays (like Scalar bar, 3DWidgets), may return NULL. Reimplemented in vtkSMDataObjectDisplayProxy. Definition at line 49 of file vtkSMDisplayProxy.h.

virtual void vtkSMDisplayProxy::AddToRenderModule (  vtkSMRenderModuleProxy *   )  [virtual]

Called when the display is added/removed to/from a RenderModule. Default implementation searches for a subproxies with name Prop/Prop2D. If found, they are added/removed to/from the Renderer/2DRenderer respectively. If such subproxies are not found no error is raised. Reimplemented in vtkSM3DWidgetProxy, vtkSMCubeAxesDisplayProxy, vtkSMDataObjectDisplayProxy, vtkSMPickLineWidgetProxy, vtkSMPickPointWidgetProxy, vtkSMScalarBarWidgetProxy, and vtkSMXYPlotDisplayProxy.

virtual void vtkSMDisplayProxy::RemoveFromRenderModule (  vtkSMRenderModuleProxy *   )  [virtual]

Called when the display is added/removed to/from a RenderModule. Default implementation searches for a subproxies with name Prop/Prop2D. If found, they are added/removed to/from the Renderer/2DRenderer respectively. If such subproxies are not found no error is raised. Reimplemented in vtkSM3DWidgetProxy, vtkSMCubeAxesDisplayProxy, vtkSMDataObjectDisplayProxy, vtkSMPickLineWidgetProxy, vtkSMPickPointWidgetProxy, vtkSMScalarBarWidgetProxy, and vtkSMXYPlotDisplayProxy.

virtual void vtkSMDisplayProxy::Update (   )  [inline, virtual]

Called to update the Display. Default implementation does nothing. Reimplemented in vtkSMCompositeDisplayProxy, vtkSMCubeAxesDisplayProxy, vtkSMDataObjectDisplayProxy, vtkSMLODDisplayProxy, vtkSMMultiDisplayProxy, vtkSMPointLabelDisplayProxy, and vtkSMXYPlotDisplayProxy. Definition at line 62 of file vtkSMDisplayProxy.h.

void vtkSMDisplayProxy::SetVisibilityCM (  int  v  )

Convenience method to get/set Visibility property.

int vtkSMDisplayProxy::GetVisibilityCM (   )

Convenience method to get/set Visibility property.

virtual void vtkSMDisplayProxy::SaveInBatchScript (  ofstream *  file  )  [virtual]

Save the display in batch script. This will eventually get removed as we will generate batch script from ServerManager state. However, until then. Reimplemented in vtkSM3DWidgetProxy, vtkSMAxesProxy, vtkSMBoxWidgetProxy, vtkSMImplicitPlaneWidgetProxy, vtkSMLineWidgetProxy, vtkSMPointWidgetProxy, vtkSMScalarBarWidgetProxy, and vtkSMSphereWidgetProxy.

vtkSMProxy* vtkSMDisplayProxy::GetInteractorProxy (  vtkSMRenderModuleProxy *  ren  )  [protected]

vtkSMProxy* vtkSMDisplayProxy::GetRendererProxy (  vtkSMRenderModuleProxy *  ren  )  [protected]

vtkSMProxy* vtkSMDisplayProxy::GetRenderer2DProxy (  vtkSMRenderModuleProxy *  ren  )  [protected]

void vtkSMDisplayProxy::AddPropToRenderer (  vtkSMProxy *  proxy, vtkSMRenderModuleProxy *  ren )  [protected]

void vtkSMDisplayProxy::AddPropToRenderer2D (  vtkSMProxy *  proxy, vtkSMRenderModuleProxy *  ren )  [protected]

void vtkSMDisplayProxy::RemovePropFromRenderer (  vtkSMProxy *  proxy, vtkSMRenderModuleProxy *  ren )  [protected]

void vtkSMDisplayProxy::RemovePropFromRenderer2D (  vtkSMProxy *  proxy, vtkSMRenderModuleProxy *  ren )  [protected]

---

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

• Servers/ServerManager/vtkSMDisplayProxy.h

---