vtkPVSource Class Reference

A super class for filter objects. More...

#include <vtkPVSource.h>

Inheritance diagram for vtkPVSource:

[legend]Collaboration diagram for vtkPVSource:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVSource, vtkPVTracedWidget)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkPVWindow *	GetPVWindow ()
virtual void	CreateProperties ()
void	Update ()
void	SetPVColorMap (vtkPVColorMap *colorMap)
void	SetDefaultColorParameters ()
void	SetPointLabelFontSize (int val)
void	SetPointLabelFontSizeNoTrace (int val)
virtual int	GetPointLabelFontSize ()
vtkPVSource *	GetPVInput (int idx)
void	RemoveAllPVInputs ()
vtkPVDisplayGUI *	GetPVOutput ()
vtkPVApplication *	GetPVApplication ()
virtual int	IsDeletable ()
void	ResetCallback ()
virtual void	DeleteCallback ()
virtual void	Reset ()
void	UpdateProperties ()
virtual void	UpdateVTKSourceParameters ()
int	GetNumberOfVTKSources ()
virtual vtkPVWidgetCollection *	GetWidgets ()
virtual void	SaveInBatchScript (ofstream *file)
vtkPVWidget *	GetPVWidget (const char *name)
vtkPVSource **	GetPVInputs ()
void	AddPVWidget (vtkPVWidget *pvw)
int	CloneAndInitialize (int makeCurrent, vtkPVSource *&clone)
int	ClonePrototype (vtkPVSource *&clone)
virtual int	InitializeClone (int makeCurrent)
virtual int	InitializeData ()
virtual void	InitializePrototype ()
int	GetNumberOfProcessorsValid ()
vtkPVDataInformation *	GetDataInformation ()
void	InvalidateDataInformation ()
vtkPVRenderView *	GetPVRenderView ()
virtual void	UpdateEnableState ()
void	RegisterProxy (const char *sourceList, vtkPVSource *clone)
virtual void	UpdateVTKObjects ()
void	VolumeRenderByArray (const char *arrayname, int field)
void	ColorByArray (const char *arrayname, int field)
void	SetAcceptButtonColorToModified ()
void	MarkSourcesForUpdate ()
virtual void	Select ()
virtual void	Deselect (int doPackForget=1)
virtual void	Pack ()
void	SetVisibility (int v)
int	GetVisibility ()
virtual void	SetVisibilityNoTrace (int v)
void	SetCubeAxesVisibility (int val)
void	SetCubeAxesVisibilityNoTrace (int val)
virtual int	GetCubeAxesVisibility ()
void	SetPointLabelVisibility (int val)
void	SetPointLabelVisibilityNoTrace (int val)
virtual int	GetPointLabelVisibility ()
void	AddPVInput (vtkPVSource *input)
void	SetPVInput (const char *name, int idx, vtkPVSource *input)
virtual int	GetNumberOfPVInputs ()
virtual int	GetNumberOfPVConsumers ()
void	AddPVConsumer (vtkPVSource *c)
void	RemovePVConsumer (vtkPVSource *c)
vtkPVSource *	GetPVConsumer (int i)
int	IsPVConsumer (vtkPVSource *c)
virtual vtkPVColorMap *	GetPVColorMap ()
virtual void	SetName (const char *name)
char *	GetName ()
virtual void	SetOverideAutoAccept (int)
virtual int	GetOverideAutoAccept ()
virtual void	SetLabelNoTrace (const char *label)
virtual void	SetLabel (const char *label)
virtual char *	GetLabel ()
virtual void	SetLabelOnce (const char *label)
void	AcceptCallback ()
virtual void	PreAcceptCallback ()
virtual void	Accept ()
virtual void	Accept (int hideFlag)
virtual void	Accept (int hideFlag, int hideSource)
void	AddVTKSource (vtkClientServerID)
vtkClientServerID	GetVTKSourceID (int idx)
unsigned int	GetVTKSourceIDAsInt (int idx)
virtual void	SaveState (ofstream *file)
virtual void	SaveStateVisibility (ofstream *file)
virtual void	SaveStateDisplay (ofstream *file)
virtual void	SetReplaceInput (int)
virtual int	GetReplaceInput ()
virtual void	ReplaceInputOn ()
virtual void	ReplaceInputOff ()
void	SetNotebook (vtkPVSourceNotebook *notebook)
virtual vtkPVSourceNotebook *	GetNotebook ()
virtual void	SetVisitedFlag (int)
virtual int	GetVisitedFlag ()
virtual void	SetSourceClassName (const char *)
virtual char *	GetSourceClassName ()
vtkSMPart *	GetPart ()
vtkSMPart *	GetPart (int idx)
int	GetNumberOfParts ()
vtkIdType	GetNumberOfInputProperties ()
vtkPVInputProperty *	GetInputProperty (int idx)
vtkPVInputProperty *	GetInputProperty (const char *name)
virtual void	SetVTKMultipleInputsFlag (int)
virtual int	GetVTKMultipleInputsFlag ()
virtual void	SetVTKMultipleProcessFlag (int)
virtual int	GetVTKMultipleProcessFlag ()
virtual void	SetIsPermanent (int)
virtual int	GetIsPermanent ()
virtual void	IsPermanentOn ()
virtual void	IsPermanentOff ()
virtual void	SetModuleName (const char *)
virtual char *	GetModuleName ()
virtual void	SetMenuName (const char *)
virtual char *	GetMenuName ()
virtual void	SetShortHelp (const char *)
virtual char *	GetShortHelp ()
virtual void	SetLongHelp (const char *)
virtual char *	GetLongHelp ()
virtual int	GetInitialized ()
virtual void	SetToolbarModule (int)
virtual int	GetToolbarModule ()
virtual void	ToolbarModuleOn ()
virtual void	ToolbarModuleOff ()
void	GrabFocus ()
void	UnGrabFocus ()
virtual vtkPVNumberOfOutputsInformation *	GetNumberOfOutputsInformation ()
virtual int	GetSourceGrabbed ()
void	SetProxy (vtkSMSourceProxy *proxy)
virtual vtkSMSourceProxy *	GetProxy ()
void	SetDisplayProxy (vtkSMDataObjectDisplayProxy *pdisp)
virtual vtkSMDataObjectDisplayProxy *	GetDisplayProxy ()
virtual vtkSMPointLabelDisplayProxy *	GetPointLabelDisplayProxy ()
void	SetLookmark (vtkPVLookmark *lookmark)
virtual vtkPVLookmark *	GetLookmark ()
Static Public Member Functions
vtkPVSource *	New ()
Protected Member Functions
	vtkPVSource ()
	~vtkPVSource ()
void	ColorByArray (vtkPVColorMap *colorMap, int field)
void	SetPVInputInternal (const char *name, int idx, vtkPVSource *input, int doInit)
void	SaveFilterInBatchScript (ofstream *file)
virtual void	InitializeWidgets ()
void	SetNumberOfPVInputs (int num)
vtkPVSource *	GetNthPVInput (int idx)
void	SetNthPVInput (int idx, vtkPVSource *input)
virtual void	AcceptCallbackInternal ()
virtual void	SetSourceList (const char *)
virtual char *	GetSourceList ()
virtual int	ClonePrototypeInternal (vtkPVSource *&clone)
void	SetInputsInBatchScript (ofstream *file)
int	ColorByScalars (vtkPVDataSetAttributesInformation *attrInfo, vtkPVDataSetAttributesInformation *inAttrInfo, int field)
virtual void	SetupDisplays ()
virtual void	CleanupDisplays ()
void	AddDisplayToRenderModule (vtkSMDisplayProxy *pDisp)
void	RemoveDisplayFromRenderModule (vtkSMDisplayProxy *pDisp)
Protected Attributes
vtkPVColorMap *	PVColorMap
int	DataInformationValid
vtkPVNumberOfOutputsInformation *	NumberOfOutputsInformation
int	Initialized
int	CubeAxesVisibility
int	PointLabelVisibility
int	PointLabelFontSize
vtkKWFrameWithScrollbar *	ParameterFrame
vtkSMDataObjectDisplayProxy *	DisplayProxy
vtkPVSource **	PVInputs
int	NumberOfPVInputs
vtkPVSource **	PVConsumers
int	NumberOfPVConsumers
vtkPVSourceNotebook *	Notebook
int	SavedRaisedNotebookPageId
char *	SourceList
char *	Name
char *	MenuName
char *	Label
char *	ShortHelp
char *	LongHelp
int	OverideAutoAccept
char *	ModuleName
vtkPVWidgetCollection *	Widgets
char *	SourceClassName
vtkSMSourceProxy *	Proxy
int	ReplaceInput
int	VisitedFlag
int	PrototypeInstanceCount
int	IsPermanent
int	AcceptCallbackFlag
int	SourceGrabbed
int	ToolbarModule
int	RequiredNumberOfInputParts
int	VTKMultipleInputsFlag
vtkCollection *	InputProperties
int	VTKMultipleProcessFlag
int	UpdateSourceInBatch
int	LabelSetByUser
int	ResetInSelect
vtkSMCubeAxesDisplayProxy *	CubeAxesDisplayProxy
vtkSMPointLabelDisplayProxy *	PointLabelDisplayProxy
vtkPVLookmark *	Lookmark
Friends
class	vtkPVWindow

---

Detailed Description

A super class for filter objects.

This is a parallel object. It needs to be cloned to work correctly. After cloning, the parallel nature of the object is transparent. This class should probably be merged with vtkPVComposite.

Definition at line 56 of file vtkPVSource.h.

---

Constructor & Destructor Documentation

vtkPVSource::vtkPVSource (   )  [protected]

vtkPVSource::~vtkPVSource (   )  [protected]

---

Member Function Documentation

vtkPVSource* vtkPVSource::New (   )  [static]

Reimplemented from vtkPVTracedWidget. Reimplemented in vtkPVAdvancedReaderModule, vtkPVAttributeEditor, vtkPVDataSetReaderModule, vtkPVDReaderModule, vtkPVEnSightReaderModule, vtkPVPick, vtkPVPLOT3DReaderModule, vtkPVProbe, vtkPVRawReaderModule, vtkPVReaderModule, and vtkXDMFReaderModule.

vtkPVSource::vtkTypeRevisionMacro (  vtkPVSource  , vtkPVTracedWidget  )

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

Reimplemented from vtkPVTracedWidget. Reimplemented in vtkPVAdvancedReaderModule, vtkPVAttributeEditor, vtkPVDataSetReaderModule, vtkPVDReaderModule, vtkPVEnSightReaderModule, vtkPVPick, vtkPVPLOT3DReaderModule, vtkPVProbe, vtkPVRawReaderModule, vtkPVReaderModule, and vtkXDMFReaderModule.

vtkPVWindow* vtkPVSource::GetPVWindow (   )

Get the Window for this class. This is used for creating input menus. The PVSource list is in the window.

virtual void vtkPVSource::CreateProperties (   )  [virtual]

Create the properties object, called by InitializeProperties. Reimplemented in vtkPVAttributeEditor, vtkPVDataSetReaderModule, vtkPVEnSightReaderModule, vtkPVPick, vtkPVProbe, vtkPVRawReaderModule, and vtkPVReaderModule.

void vtkPVSource::Update (   )

This method updates the piece that has been assigned to this process. It update all parts and gathers data information.

virtual void vtkPVSource::Select (   )  [virtual]

Methods to indicate when this source is selected in the window.. The second version of Deselect allows to user to specify whether the main frame of the source parameters should be unpacked or not. It was necessary to add this option to work around some Tk packing problems. Reimplemented in vtkPVAttributeEditor, and vtkPVPick.

virtual void vtkPVSource::Deselect (  int  doPackForget = 1  )  [virtual]

Methods to indicate when this source is selected in the window.. The second version of Deselect allows to user to specify whether the main frame of the source parameters should be unpacked or not. It was necessary to add this option to work around some Tk packing problems.

virtual void vtkPVSource::Pack (   )  [virtual]

Methods to indicate when this source is selected in the window.. The second version of Deselect allows to user to specify whether the main frame of the source parameters should be unpacked or not. It was necessary to add this option to work around some Tk packing problems.

void vtkPVSource::SetVisibility (  int  v  )

This flag turns the visibility of the prop on and off. These methods transmit the state change to all of the satellite processes.

int vtkPVSource::GetVisibility (   )

This flag turns the visibility of the prop on and off. These methods transmit the state change to all of the satellite processes.

virtual void vtkPVSource::SetVisibilityNoTrace (  int  v  )  [virtual]

This flag turns the visibility of the prop on and off. These methods transmit the state change to all of the satellite processes. Reimplemented in vtkPVProbe.

void vtkPVSource::SetPVColorMap (  vtkPVColorMap *  colorMap  )

If we are the last source to unregister a color map, this method will turn its scalar bar visibility off.

void vtkPVSource::SetDefaultColorParameters (   )

This method sets the color mode based on arrays set in scalars and the input color mode. The source must be current to call this method. The rules are: If the source created a NEW point scalar array, use it. Else if the source created a NEW cell scalar array, use it. Else if the input clolor by array exists in this source, use it. Else color by property.

void vtkPVSource::SetCubeAxesVisibility (  int  val  )

Actual cube axis visibility is a combination of this variable and overall visibility.

void vtkPVSource::SetCubeAxesVisibilityNoTrace (  int  val  )

Actual cube axis visibility is a combination of this variable and overall visibility.

virtual int vtkPVSource::GetCubeAxesVisibility (   )  [virtual]

Actual cube axis visibility is a combination of this variable and overall visibility.

void vtkPVSource::SetPointLabelVisibility (  int  val  )

Using a display for point labels.

void vtkPVSource::SetPointLabelVisibilityNoTrace (  int  val  )

Using a display for point labels.

virtual int vtkPVSource::GetPointLabelVisibility (   )  [virtual]

Using a display for point labels.

void vtkPVSource::SetPointLabelFontSize (  int  val  )

void vtkPVSource::SetPointLabelFontSizeNoTrace (  int  val  )

virtual int vtkPVSource::GetPointLabelFontSize (   )  [virtual]

void vtkPVSource::AddPVInput (  vtkPVSource *  input  )

Connect an input to this pvsource. Note: SetPVInput() first disconnects all inputs of the internal VTK filter whereas AddPVInput() does not. See vtkPVGroupInputsWidgets for an example of how AddPVInput() is used.

void vtkPVSource::SetPVInput (  const char *  name, int  idx, vtkPVSource *  input )

Connect an input to this pvsource. Note: SetPVInput() first disconnects all inputs of the internal VTK filter whereas AddPVInput() does not. See vtkPVGroupInputsWidgets for an example of how AddPVInput() is used.

vtkPVSource* vtkPVSource::GetPVInput (  int  idx  )  [inline]

Return an input given idx. Definition at line 133 of file vtkPVSource.h.

virtual int vtkPVSource::GetNumberOfPVInputs (   )  [virtual]

Return the number of inputs.

void vtkPVSource::RemoveAllPVInputs (   )

Remove all inputs of this pvsource and disconnect all the inputs of all VTK filters in this pvsource.

virtual int vtkPVSource::GetNumberOfPVConsumers (   )  [virtual]

Get the number of consumers

void vtkPVSource::AddPVConsumer (  vtkPVSource *  c  )

Add, remove, get, or check a consumer.

void vtkPVSource::RemovePVConsumer (  vtkPVSource *  c  )

Add, remove, get, or check a consumer.

vtkPVSource* vtkPVSource::GetPVConsumer (  int  i  )

Add, remove, get, or check a consumer.

int vtkPVSource::IsPVConsumer (  vtkPVSource *  c  )

Add, remove, get, or check a consumer.

vtkPVDisplayGUI* vtkPVSource::GetPVOutput (   )

For legacy scripts

virtual vtkPVColorMap* vtkPVSource::GetPVColorMap (   )  [virtual]

Access to this object from a script.

virtual void vtkPVSource::SetName (  const char *  name  )  [virtual]

This name is used in the source list to identify this source. This name is passed to vtkPVWindow::GetPVSource() to get a particular source.

char* vtkPVSource::GetName (   )

This name is used in the source list to identify this source. This name is passed to vtkPVWindow::GetPVSource() to get a particular source.

virtual void vtkPVSource::SetOverideAutoAccept (  int   )  [virtual]

Overrides the AutoAccept. Very usefull for class like vtkArrayCalculator

virtual int vtkPVSource::GetOverideAutoAccept (   )  [virtual]

Overrides the AutoAccept. Very usefull for class like vtkArrayCalculator

virtual void vtkPVSource::SetLabelNoTrace (  const char *  label  )  [virtual]

The (short) label that can be used to give a more descriptive name to the object. Note that if the label is empty when GetLabel() is called, the Ivar is automatically initialized to the name of the composite (GetName()).

virtual void vtkPVSource::SetLabel (  const char *  label  )  [virtual]

The (short) label that can be used to give a more descriptive name to the object. Note that if the label is empty when GetLabel() is called, the Ivar is automatically initialized to the name of the composite (GetName()).

virtual char* vtkPVSource::GetLabel (   )  [virtual]

The (short) label that can be used to give a more descriptive name to the object. Note that if the label is empty when GetLabel() is called, the Ivar is automatically initialized to the name of the composite (GetName()).

virtual void vtkPVSource::SetLabelOnce (  const char *  label  )  [virtual]

The (short) label that can be used to give a more descriptive name to the object. Note that if the label is empty when GetLabel() is called, the Ivar is automatically initialized to the name of the composite (GetName()).

vtkPVApplication* vtkPVSource::GetPVApplication (   )

This just returns the application typecast correctly.

void vtkPVSource::AcceptCallback (   )

Called when the accept button is pressed.

virtual void vtkPVSource::PreAcceptCallback (   )  [virtual]

Called when the accept button is pressed.

virtual int vtkPVSource::IsDeletable (   )  [virtual]

Determine if this source can be deleted. This depends on two conditions: 1. Does the source have any consumers, 2. Is it permanent (for example, a glyph source is permanent)

virtual void vtkPVSource::Accept (   )  [inline, virtual]

Internal method; called by AcceptCallbackInternal. Hide flag is used for hiding creation of the glyph sources from the user. Reimplemented in vtkPVPLOT3DReaderModule. Definition at line 208 of file vtkPVSource.h. Referenced by vtkPVPLOT3DReaderModule::Accept().

virtual void vtkPVSource::Accept (  int  hideFlag  )  [inline, virtual]

Internal method; called by AcceptCallbackInternal. Hide flag is used for hiding creation of the glyph sources from the user. Reimplemented in vtkPVPLOT3DReaderModule. Definition at line 209 of file vtkPVSource.h.

virtual void vtkPVSource::Accept (  int  hideFlag, int  hideSource )  [virtual]

Internal method; called by AcceptCallbackInternal. Hide flag is used for hiding creation of the glyph sources from the user. Reimplemented in vtkPVPLOT3DReaderModule.

void vtkPVSource::ResetCallback (   )

Called when the reset button is pressed.

virtual void vtkPVSource::DeleteCallback (   )  [virtual]

Called when the delete button is pressed. Reimplemented in vtkPVPick.

virtual void vtkPVSource::Reset (   )  [virtual]

This method resets the UI values (Widgets added with the following methods). It uses the GetCommand supplied to the interface.

void vtkPVSource::UpdateProperties (   )

Updates delete button and description frame.

virtual void vtkPVSource::UpdateVTKSourceParameters (   )  [virtual]

This method gets called to set the VTK source parameters from the widget values.

void vtkPVSource::AddVTKSource (  vtkClientServerID   )

Given and ID, add a VTK source to the list of maintained VTK sources.

int vtkPVSource::GetNumberOfVTKSources (   )

Returns the number of VTK sources referenced by the PVSource.

vtkClientServerID vtkPVSource::GetVTKSourceID (  int  idx  )

Given an index, return the ID of a VTK source.

unsigned int vtkPVSource::GetVTKSourceIDAsInt (  int  idx  )

Given an index, return the ID of a VTK source.

virtual vtkPVWidgetCollection* vtkPVSource::GetWidgets (   )  [virtual]

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

Save the pipeline to a batch file which can be run without a user interface. Reimplemented in vtkPVEnSightReaderModule, vtkPVPick, vtkPVProbe, and vtkXDMFReaderModule.

virtual void vtkPVSource::SaveState (  ofstream *  file  )  [virtual]

Saves the pipeline in a ParaView script. This is similar to saveing a trace, except only the last state is stored. Reimplemented in vtkPVPick, vtkPVProbe, vtkPVReaderModule, and vtkXDMFReaderModule.

virtual void vtkPVSource::SaveStateVisibility (  ofstream *  file  )  [virtual]

Saves the pipeline in a ParaView script. This is similar to saveing a trace, except only the last state is stored.

virtual void vtkPVSource::SaveStateDisplay (  ofstream *  file  )  [virtual]

Saves the pipeline in a ParaView script. This is similar to saveing a trace, except only the last state is stored.

virtual void vtkPVSource::SetReplaceInput (  int   )  [virtual]

This flag determines whether a source will make its input invisible or not. By default, this flag is on.

virtual int vtkPVSource::GetReplaceInput (   )  [virtual]

This flag determines whether a source will make its input invisible or not. By default, this flag is on.

virtual void vtkPVSource::ReplaceInputOn (   )  [virtual]

This flag determines whether a source will make its input invisible or not. By default, this flag is on.

virtual void vtkPVSource::ReplaceInputOff (   )  [virtual]

This flag determines whether a source will make its input invisible or not. By default, this flag is on.

vtkPVWidget* vtkPVSource::GetPVWidget (  const char *  name  )

Access to PVWidgets indexed by their name.

vtkPVSource** vtkPVSource::GetPVInputs (   )  [inline]

These are used for drawing the navigation window. Definition at line 278 of file vtkPVSource.h.

void vtkPVSource::SetNotebook (  vtkPVSourceNotebook *  notebook  )

The notebook that is displayed when the source is selected.

virtual vtkPVSourceNotebook* vtkPVSource::GetNotebook (   )  [virtual]

The notebook that is displayed when the source is selected.

virtual void vtkPVSource::SetVisitedFlag (  int   )  [virtual]

This is just a flag that is used to mark that the source has been saved into the tcl script (visited) during the recursive saving process.

virtual int vtkPVSource::GetVisitedFlag (   )  [virtual]

This is just a flag that is used to mark that the source has been saved into the tcl script (visited) during the recursive saving process.

void vtkPVSource::AddPVWidget (  vtkPVWidget *  pvw  )

This adds the PVWidget and sets up the callbacks to initialize its trace.

int vtkPVSource::CloneAndInitialize (  int  makeCurrent, vtkPVSource *&  clone )

Convenience methid which calls ClonePrototype() and InitializeClone()

int vtkPVSource::ClonePrototype (  vtkPVSource *&  clone  )

Creates and returns (by reference) a copy of this source. It will create a new instance of the same type as the current object using NewInstance() and then call ClonePrototype() on all widgets and add these clones to it's widget list. The return value is VTK_OK is the cloning was successful.

virtual int vtkPVSource::InitializeClone (  int  makeCurrent  )  [virtual]

This method is usually called on a clone created using ClonePrototype(). It: 1. sets the input, 2. calls CreateProperties(), 3. make the source current (if makeCurrent is true), 4. creates output (vtkPVDisplayGUI) which contains a vtk data object of type outputDataType, 5. assigns or creates an extent translator to the output.

virtual int vtkPVSource::InitializeData (   )  [virtual]

This sets up the PVData. This method is called when the accept button is pressed for the first time. Reimplemented in vtkPVEnSightReaderModule.

virtual void vtkPVSource::InitializePrototype (   )  [inline, virtual]

This method can be used by subclasses of PVSource to do special initialization (for example creating widgets). It is called by PVWindow before adding a prototype to the main list. Reimplemented in vtkPVDataSetReaderModule. Definition at line 323 of file vtkPVSource.h.

virtual void vtkPVSource::SetSourceClassName (  const char *   )  [virtual]

Description of the VTK filter.

virtual char* vtkPVSource::GetSourceClassName (   )  [virtual]

Description of the VTK filter.

vtkSMPart* vtkPVSource::GetPart (   )  [inline]

Access to individual parts. Definition at line 333 of file vtkPVSource.h.

vtkSMPart* vtkPVSource::GetPart (  int  idx  )

Access to individual parts.

int vtkPVSource::GetNumberOfParts (   )

Access to individual parts.

vtkIdType vtkPVSource::GetNumberOfInputProperties (   )

Properties that describe the inputs to the filter of type "SourceCLassName". Name is the string used to format Set/Add/Get methods. "Input" or "Source" ... First you get the input property using the name, then you and fill it in (name is already set). The first get creates the property and returns it. The order the properties are created are important. The first one will be the default input.

vtkPVInputProperty* vtkPVSource::GetInputProperty (  int  idx  )

Properties that describe the inputs to the filter of type "SourceCLassName". Name is the string used to format Set/Add/Get methods. "Input" or "Source" ... First you get the input property using the name, then you and fill it in (name is already set). The first get creates the property and returns it. The order the properties are created are important. The first one will be the default input.

vtkPVInputProperty* vtkPVSource::GetInputProperty (  const char *  name  )

Properties that describe the inputs to the filter of type "SourceCLassName". Name is the string used to format Set/Add/Get methods. "Input" or "Source" ... First you get the input property using the name, then you and fill it in (name is already set). The first get creates the property and returns it. The order the properties are created are important. The first one will be the default input.

virtual void vtkPVSource::SetVTKMultipleInputsFlag (  int   )  [virtual]

Option set by the xml filter input element "quantity". When 1 (xml: Multiple), then VTK source takes one input which has multiple inputs (uses AddInput). If 0, then PVSource Inputs match each VTK filter inputs.

virtual int vtkPVSource::GetVTKMultipleInputsFlag (   )  [virtual]

Option set by the xml filter input element "quantity". When 1 (xml: Multiple), then VTK source takes one input which has multiple inputs (uses AddInput). If 0, then PVSource Inputs match each VTK filter inputs.

virtual void vtkPVSource::SetVTKMultipleProcessFlag (  int   )  [virtual]

Option set by the xml filter input element "multiprocess_support". When 0 (xml: single_process), the VTK source only runs in a single process. If 1, (xml: multiple_processes), the VTK source only runs in parallel. If 2, (xml: both), the VTK source runs in either mode.

virtual int vtkPVSource::GetVTKMultipleProcessFlag (   )  [virtual]

Option set by the xml filter input element "multiprocess_support". When 0 (xml: single_process), the VTK source only runs in a single process. If 1, (xml: multiple_processes), the VTK source only runs in parallel. If 2, (xml: both), the VTK source runs in either mode.

int vtkPVSource::GetNumberOfProcessorsValid (   )

Determine whether the single- or multi-process support for this filter matches the current state of ParaView. Returns 1 if this source can run with the current number of processors; if not, returns 0.

virtual void vtkPVSource::SetIsPermanent (  int   )  [virtual]

Certain modules are not deletable (for example, glyph sources). Such modules should be marked as such (IsPermanent = 1).

virtual int vtkPVSource::GetIsPermanent (   )  [virtual]

Certain modules are not deletable (for example, glyph sources). Such modules should be marked as such (IsPermanent = 1).

virtual void vtkPVSource::IsPermanentOn (   )  [virtual]

Certain modules are not deletable (for example, glyph sources). Such modules should be marked as such (IsPermanent = 1).

virtual void vtkPVSource::IsPermanentOff (   )  [virtual]

Certain modules are not deletable (for example, glyph sources). Such modules should be marked as such (IsPermanent = 1).

virtual void vtkPVSource::SetModuleName (  const char *   )  [virtual]

Set or get the module name. This name is used to store the prototype in the sources/filters/readers maps. It is passed to CreatePVSource when creating a new instance.

virtual char* vtkPVSource::GetModuleName (   )  [virtual]

Set or get the module name. This name is used to store the prototype in the sources/filters/readers maps. It is passed to CreatePVSource when creating a new instance.

virtual void vtkPVSource::SetMenuName (  const char *   )  [virtual]

Set or get the label to be used in the Source/Filter menus.

virtual char* vtkPVSource::GetMenuName (   )  [virtual]

Set or get the label to be used in the Source/Filter menus.

virtual void vtkPVSource::SetShortHelp (  const char *   )  [virtual]

A short help string describing the module.

virtual char* vtkPVSource::GetShortHelp (   )  [virtual]

A short help string describing the module.

virtual void vtkPVSource::SetLongHelp (  const char *   )  [virtual]

A longer help string describing the module.

virtual char* vtkPVSource::GetLongHelp (   )  [virtual]

A longer help string describing the module.

virtual int vtkPVSource::GetInitialized (   )  [virtual]

Check whether the source has been initialized (Accept has been called at least one)

virtual void vtkPVSource::SetToolbarModule (  int   )  [virtual]

If ToolbarModule is true, the instances of this module can be created by using a button on the toolbar. This variable is used mainly to prevent the addition of such modules to Advanced->(Filter/Source) menus.

virtual int vtkPVSource::GetToolbarModule (   )  [virtual]

If ToolbarModule is true, the instances of this module can be created by using a button on the toolbar. This variable is used mainly to prevent the addition of such modules to Advanced->(Filter/Source) menus.

virtual void vtkPVSource::ToolbarModuleOn (   )  [virtual]

If ToolbarModule is true, the instances of this module can be created by using a button on the toolbar. This variable is used mainly to prevent the addition of such modules to Advanced->(Filter/Source) menus.

virtual void vtkPVSource::ToolbarModuleOff (   )  [virtual]

If ToolbarModule is true, the instances of this module can be created by using a button on the toolbar. This variable is used mainly to prevent the addition of such modules to Advanced->(Filter/Source) menus.

void vtkPVSource::GrabFocus (   )

When a module is first created, the user should not be able to use certain menus, buttons etc. before accepting the first time or deleting the module. GrabFocus() is used to tell the module to disable certain things in the window.

void vtkPVSource::UnGrabFocus (   )

When a module is first created, the user should not be able to use certain menus, buttons etc. before accepting the first time or deleting the module. GrabFocus() is used to tell the module to disable certain things in the window.

vtkPVDataInformation* vtkPVSource::GetDataInformation (   )

Moving away from direct access to VTK data objects.

void vtkPVSource::InvalidateDataInformation (   )

Called by source EndEvent to schedule another Gather.

vtkPVRenderView* vtkPVSource::GetPVRenderView (   )

Convenience method for rendering.

virtual vtkPVNumberOfOutputsInformation* vtkPVSource::GetNumberOfOutputsInformation (   )  [virtual]

Access to the vtkPVNumberOfOutputsInformation object.

virtual void vtkPVSource::UpdateEnableState (   )  [virtual]

Update the "enable" state of the object and its internal parts. Depending on different Ivars (this->Enabled, the application's Limited Edition Mode, etc.), the "enable" state of the object is updated and propagated to its internal parts/subwidgets. This will, for example, enable/disable parts of the widget UI, enable/disable the visibility of 3D widgets, etc. Reimplemented from vtkKWWidget. Reimplemented in vtkPVPLOT3DReaderModule.

virtual int vtkPVSource::GetSourceGrabbed (   )  [virtual]

Is the source grabbed.

void vtkPVSource::SetProxy (  vtkSMSourceProxy *  proxy  )

Returns the proxy object (server manager) used by PVSource.

virtual vtkSMSourceProxy* vtkPVSource::GetProxy (   )  [virtual]

Returns the proxy object (server manager) used by PVSource.

void vtkPVSource::RegisterProxy (  const char *  sourceList, vtkPVSource *  clone )

virtual void vtkPVSource::UpdateVTKObjects (   )  [virtual]

Calls UpdateVTKObjects on the proxy as well as on all widgets.

void vtkPVSource::SetDisplayProxy (  vtkSMDataObjectDisplayProxy *  pdisp  )

This is the Display for this source.

virtual vtkSMDataObjectDisplayProxy* vtkPVSource::GetDisplayProxy (   )  [virtual]

This is the Display for this source.

virtual vtkSMPointLabelDisplayProxy* vtkPVSource::GetPointLabelDisplayProxy (   )  [virtual]

Accessor to the point label text display.

void vtkPVSource::VolumeRenderByArray (  const char *  arrayname, int  field )

Set the volume rendering array and Scalar Mode.

void vtkPVSource::ColorByArray (  const char *  arrayname, int  field )

Sets the array name and field type to color with. This also sets the LUT on the mapper. field (3 == PointFieldData, 4==CellFieldData) enums in vtkSMDataObjectDisplayProxy

void vtkPVSource::SetAcceptButtonColorToModified (   )

This method is now in the vtkPVSourceNotebook. This legacy method is for backward compatibility.

void vtkPVSource::MarkSourcesForUpdate (   )

void vtkPVSource::SetLookmark (  vtkPVLookmark *  lookmark  )

If this source was created from a lookmark (state script), need to delete it from the lookmark's source collection when manually deleted by user (otherwise we end up with some funky residual images in render window as well as crashes when modifying an input of this source).

virtual vtkPVLookmark* vtkPVSource::GetLookmark (   )  [virtual]

If this source was created from a lookmark (state script), need to delete it from the lookmark's source collection when manually deleted by user (otherwise we end up with some funky residual images in render window as well as crashes when modifying an input of this source).

virtual void vtkPVSource::SetupDisplays (   )  [protected, virtual]

Setups up the displays for this source

virtual void vtkPVSource::CleanupDisplays (   )  [protected, virtual]

Setups up the displays for this source

void vtkPVSource::ColorByArray (  vtkPVColorMap *  colorMap, int  field )  [protected]

Set the color map and the field to use.

void vtkPVSource::SetPVInputInternal (  const char *  name, int  idx, vtkPVSource *  input, int  doInit )  [protected]

void vtkPVSource::SaveFilterInBatchScript (  ofstream *  file  )  [protected]

virtual void vtkPVSource::InitializeWidgets (   )  [protected, virtual]

void vtkPVSource::AddDisplayToRenderModule (  vtkSMDisplayProxy *  pDisp  )  [protected]

Helper methods for subclasses to add displays to the render module.

void vtkPVSource::RemoveDisplayFromRenderModule (  vtkSMDisplayProxy *  pDisp  )  [protected]

Helper methods for subclasses to add displays to the render module.

void vtkPVSource::SetNumberOfPVInputs (  int  num  )  [protected]

vtkPVSource* vtkPVSource::GetNthPVInput (  int  idx  )  [protected]

void vtkPVSource::SetNthPVInput (  int  idx, vtkPVSource *  input )  [protected]

virtual void vtkPVSource::AcceptCallbackInternal (   )  [protected, virtual]

Reimplemented in vtkPVAttributeEditor, vtkPVPick, and vtkPVProbe.

virtual void vtkPVSource::SetSourceList (  const char *   )  [protected, virtual]

virtual char* vtkPVSource::GetSourceList (   )  [protected, virtual]

virtual int vtkPVSource::ClonePrototypeInternal (  vtkPVSource *&  clone  )  [protected, virtual]

void vtkPVSource::SetInputsInBatchScript (  ofstream *  file  )  [protected]

int vtkPVSource::ColorByScalars (  vtkPVDataSetAttributesInformation *  attrInfo, vtkPVDataSetAttributesInformation *  inAttrInfo, int  field )  [protected]

---

Friends And Related Function Documentation

friend class vtkPVWindow [friend]

Definition at line 646 of file vtkPVSource.h.

---

Member Data Documentation

vtkPVColorMap* vtkPVSource::PVColorMap [protected]

Definition at line 531 of file vtkPVSource.h.

int vtkPVSource::DataInformationValid [protected]

Definition at line 533 of file vtkPVSource.h.

vtkPVNumberOfOutputsInformation* vtkPVSource::NumberOfOutputsInformation [protected]

Definition at line 535 of file vtkPVSource.h.

int vtkPVSource::Initialized [protected]

Definition at line 538 of file vtkPVSource.h.

int vtkPVSource::CubeAxesVisibility [protected]

Definition at line 543 of file vtkPVSource.h.

int vtkPVSource::PointLabelVisibility [protected]

Definition at line 548 of file vtkPVSource.h.

int vtkPVSource::PointLabelFontSize [protected]

Definition at line 549 of file vtkPVSource.h.

vtkKWFrameWithScrollbar* vtkPVSource::ParameterFrame [protected]

Definition at line 551 of file vtkPVSource.h.

vtkSMDataObjectDisplayProxy* vtkPVSource::DisplayProxy [protected]

Definition at line 552 of file vtkPVSource.h.

vtkPVSource** vtkPVSource::PVInputs [protected]

Definition at line 562 of file vtkPVSource.h.

int vtkPVSource::NumberOfPVInputs [protected]

Definition at line 563 of file vtkPVSource.h.

vtkPVSource** vtkPVSource::PVConsumers [protected]

Definition at line 568 of file vtkPVSource.h.

int vtkPVSource::NumberOfPVConsumers [protected]

Definition at line 569 of file vtkPVSource.h.

vtkPVSourceNotebook* vtkPVSource::Notebook [protected]

Definition at line 574 of file vtkPVSource.h.

int vtkPVSource::SavedRaisedNotebookPageId [protected]

Definition at line 578 of file vtkPVSource.h.

char* vtkPVSource::SourceList [protected]

Definition at line 580 of file vtkPVSource.h.

char* vtkPVSource::Name [protected]

Definition at line 585 of file vtkPVSource.h.

char* vtkPVSource::MenuName [protected]

Definition at line 586 of file vtkPVSource.h.

char* vtkPVSource::Label [protected]

Definition at line 587 of file vtkPVSource.h.

char* vtkPVSource::ShortHelp [protected]

Definition at line 588 of file vtkPVSource.h.

char* vtkPVSource::LongHelp [protected]

Definition at line 589 of file vtkPVSource.h.

int vtkPVSource::OverideAutoAccept [protected]

Definition at line 590 of file vtkPVSource.h.

char* vtkPVSource::ModuleName [protected]

Definition at line 593 of file vtkPVSource.h.

vtkPVWidgetCollection* vtkPVSource::Widgets [protected]

Definition at line 596 of file vtkPVSource.h.

char* vtkPVSource::SourceClassName [protected]

Definition at line 598 of file vtkPVSource.h.

vtkSMSourceProxy* vtkPVSource::Proxy [protected]

Definition at line 600 of file vtkPVSource.h.

int vtkPVSource::ReplaceInput [protected]

Definition at line 603 of file vtkPVSource.h.

int vtkPVSource::VisitedFlag [protected]

Definition at line 605 of file vtkPVSource.h.

int vtkPVSource::PrototypeInstanceCount [protected]

Definition at line 608 of file vtkPVSource.h.

int vtkPVSource::IsPermanent [protected]

Definition at line 610 of file vtkPVSource.h.

int vtkPVSource::AcceptCallbackFlag [protected]

Definition at line 613 of file vtkPVSource.h.

int vtkPVSource::SourceGrabbed [protected]

Definition at line 616 of file vtkPVSource.h.

int vtkPVSource::ToolbarModule [protected]

Definition at line 620 of file vtkPVSource.h.

int vtkPVSource::RequiredNumberOfInputParts [protected]

Definition at line 624 of file vtkPVSource.h.

int vtkPVSource::VTKMultipleInputsFlag [protected]

Definition at line 628 of file vtkPVSource.h.

vtkCollection* vtkPVSource::InputProperties [protected]

Definition at line 629 of file vtkPVSource.h.

int vtkPVSource::VTKMultipleProcessFlag [protected]

Definition at line 631 of file vtkPVSource.h.

int vtkPVSource::UpdateSourceInBatch [protected]

Definition at line 636 of file vtkPVSource.h.

int vtkPVSource::LabelSetByUser [protected]

Definition at line 638 of file vtkPVSource.h.

int vtkPVSource::ResetInSelect [protected]

Definition at line 639 of file vtkPVSource.h.

vtkSMCubeAxesDisplayProxy* vtkPVSource::CubeAxesDisplayProxy [protected]

Definition at line 642 of file vtkPVSource.h.

vtkSMPointLabelDisplayProxy* vtkPVSource::PointLabelDisplayProxy [protected]

Definition at line 643 of file vtkPVSource.h.

vtkPVLookmark* vtkPVSource::Lookmark [protected]

Definition at line 649 of file vtkPVSource.h.

---

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

• GUI/Client/vtkPVSource.h

---