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

object for general options. More...

#include <vtkPVGeneralSettings.h>

Inherits vtkObject.

Public Types

enum  { DEFAULT_TIME_STEP_UNCHANGED, DEFAULT_TIME_STEP_FIRST, DEFAULT_TIME_STEP_LAST }
 Enum for DefaultTimeStep. More...
 
enum  { GROW_ON_APPLY = 0, GROW_ON_APPLY_AND_TIMESTEP = 1, RESET_ON_APPLY = 2, RESET_ON_APPLY_AND_TIMESTEP = 3 }
 Enum for TransferFunctionResetMode. More...
 
enum  { ALL_IN_ONE = 0, SEPARATE_DISPLAY_PROPERTIES = 1, SEPARATE_VIEW_PROPERTIES = 2, ALL_SEPARATE = 3 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetInheritRepresentationProperties (bool val)
 Forwarded for vtkSMParaViewPipelineControllerWithRendering. More...
 
void SetTransparentBackground (bool val)
 Forwarded to vtkSMViewProxy. More...
 
void SetAutoConvertProperties (bool val)
 Automatically convert data arrays as needed by filters including converting cell arrays to point arrays, or vice versa, and extracting single components from multi-component arrays. More...
 
bool GetAutoConvertProperties ()
 Automatically convert data arrays as needed by filters including converting cell arrays to point arrays, or vice versa, and extracting single components from multi-component arrays. More...
 
virtual int GetBlockColorsDistinctValues ()
 Determines the number of distinct values in vtkBlockColors. More...
 
virtual void SetBlockColorsDistinctValues (int)
 Determines the number of distinct values in vtkBlockColors. More...
 
virtual bool GetAutoApply ()
 Automatically apply changes in the 'Properties' panel. More...
 
virtual void SetAutoApply (bool)
 Automatically apply changes in the 'Properties' panel. More...
 
virtual bool GetAutoApplyActiveOnly ()
 Automatically apply changes in the 'Properties' panel. More...
 
virtual void SetAutoApplyActiveOnly (bool)
 Automatically apply changes in the 'Properties' panel. More...
 
void SetEnableAutoMPI (bool)
 Enable auto-mpi. More...
 
bool GetEnableAutoMPI ()
 Enable auto-mpi. More...
 
void SetAutoMPILimit (int val)
 Set the core limit for auto-mpi. More...
 
int GetAutoMPILimit ()
 Set the core limit for auto-mpi. More...
 
virtual char * GetDefaultViewType ()
 Get/Set the default view type. More...
 
virtual void SetDefaultViewType (const char *)
 Get/Set the default view type. More...
 
virtual int GetTransferFunctionResetMode ()
 Get/Set the transfer function reset mode. More...
 
virtual void SetTransferFunctionResetMode (int)
 Get/Set the transfer function reset mode. More...
 
void SetCacheGeometryForAnimation (bool val)
 Set when animation geometry caching is enabled. More...
 
virtual bool GetCacheGeometryForAnimation ()
 Set when animation geometry caching is enabled. More...
 
void SetAnimationGeometryCacheLimit (unsigned long val)
 Set the animation cache limit in KBs. More...
 
virtual unsigned long GetAnimationGeometryCacheLimit ()
 Set the animation cache limit in KBs. More...
 
virtual void SetAnimationTimePrecision (int)
 Set the precision of the animation time toolbar. More...
 
virtual int GetAnimationTimePrecision ()
 Set the precision of the animation time toolbar. More...
 
virtual void SetPropertiesPanelMode (int)
 Properties panel configuration. More...
 
virtual int GetPropertiesPanelMode ()
 Properties panel configuration. More...
 
virtual void SetLockPanels (bool)
 Set whether to dock widgets into place. More...
 
virtual bool GetLockPanels ()
 Set whether to dock widgets into place. More...
 
void SetMultiViewImageBorderColor (double r, double g, double b)
 Forwarded to vtkSMViewLayoutProxy. More...
 
void SetMultiViewImageBorderWidth (int width)
 Forwarded to vtkSMViewLayoutProxy. More...
 
void SetLoadAllVariables (bool val)
 Load all variables when loading a data set. More...
 
bool GetLoadAllVariables ()
 Load all variables when loading a data set. More...
 
void SetLoadNoChartVariables (bool val)
 Load no variables when showing a 2D chart. More...
 
bool GetLoadNoChartVariables ()
 Load no variables when showing a 2D chart. More...
 

Static Public Member Functions

static vtkPVGeneralSettingsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVGeneralSettingsSafeDownCast (vtkObject *o)
 
static vtkPVGeneralSettingsGetInstance ()
 Access the singleton. More...
 

Protected Member Functions

 vtkPVGeneralSettings ()
 
 ~vtkPVGeneralSettings ()
 

Protected Attributes

int BlockColorsDistinctValues
 
bool AutoApply
 
bool AutoApplyActiveOnly
 
char * DefaultViewType
 
int TransferFunctionResetMode
 
int ScalarBarMode
 
bool CacheGeometryForAnimation
 
unsigned long AnimationGeometryCacheLimit
 
int AnimationTimePrecision
 
int PropertiesPanelMode
 
bool LockPanels
 
enum  { AUTOMATICALLY_SHOW_AND_HIDE_SCALAR_BARS = 0, AUTOMATICALLY_HIDE_SCALAR_BARS = 1, MANUAL_SCALAR_BARS = 2 }
 Enum for ScalarBarMode. More...
 
virtual int GetScalarBarMode ()
 Enum for ScalarBarMode. More...
 
void SetScalarBarMode (int)
 Enum for ScalarBarMode. More...
 

Detailed Description

object for general options.

vtkPVGeneralSettings keeps track of general options in a ParaView application. This is a singleton. All calls to vtkPVGeneralSettings::New() return a pointer to the same global instance (with reference count incremented as expected).

Definition at line 33 of file vtkPVGeneralSettings.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkPVGeneralSettings.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enum for DefaultTimeStep.

Enumerator
DEFAULT_TIME_STEP_UNCHANGED 
DEFAULT_TIME_STEP_FIRST 
DEFAULT_TIME_STEP_LAST 

Definition at line 110 of file vtkPVGeneralSettings.h.

◆ anonymous enum

anonymous enum

Enum for TransferFunctionResetMode.

Enumerator
GROW_ON_APPLY 
GROW_ON_APPLY_AND_TIMESTEP 
RESET_ON_APPLY 
RESET_ON_APPLY_AND_TIMESTEP 

Definition at line 120 of file vtkPVGeneralSettings.h.

◆ anonymous enum

anonymous enum

Enum for ScalarBarMode.

Enumerator
AUTOMATICALLY_SHOW_AND_HIDE_SCALAR_BARS 
AUTOMATICALLY_HIDE_SCALAR_BARS 
MANUAL_SCALAR_BARS 

Definition at line 140 of file vtkPVGeneralSettings.h.

◆ anonymous enum

anonymous enum
Enumerator
ALL_IN_ONE 
SEPARATE_DISPLAY_PROPERTIES 
SEPARATE_VIEW_PROPERTIES 
ALL_SEPARATE 

Definition at line 179 of file vtkPVGeneralSettings.h.

Constructor & Destructor Documentation

◆ vtkPVGeneralSettings()

vtkPVGeneralSettings::vtkPVGeneralSettings ( )
protected

◆ ~vtkPVGeneralSettings()

vtkPVGeneralSettings::~vtkPVGeneralSettings ( )
protected

Member Function Documentation

◆ New()

static vtkPVGeneralSettings* vtkPVGeneralSettings::New ( )
static

◆ GetClassName()

virtual const char* vtkPVGeneralSettings::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

◆ GetInstance()

static vtkPVGeneralSettings* vtkPVGeneralSettings::GetInstance ( )
static

Access the singleton.

◆ SetAutoConvertProperties()

void vtkPVGeneralSettings::SetAutoConvertProperties ( bool  val)

Automatically convert data arrays as needed by filters including converting cell arrays to point arrays, or vice versa, and extracting single components from multi-component arrays.

Forwards the call to vtkSMInputArrayDomain::SetAutomaticPropertyConversion.

◆ GetAutoConvertProperties()

bool vtkPVGeneralSettings::GetAutoConvertProperties ( )

Automatically convert data arrays as needed by filters including converting cell arrays to point arrays, or vice versa, and extracting single components from multi-component arrays.

Forwards the call to vtkSMInputArrayDomain::SetAutomaticPropertyConversion.

◆ GetBlockColorsDistinctValues()

virtual int vtkPVGeneralSettings::GetBlockColorsDistinctValues ( )
virtual

Determines the number of distinct values in vtkBlockColors.

This array is added to each block if the dataset is a composite dataset. The array has one value set to (blockIndex % BlockColorsDistinctValues)

◆ SetBlockColorsDistinctValues()

virtual void vtkPVGeneralSettings::SetBlockColorsDistinctValues ( int  )
virtual

Determines the number of distinct values in vtkBlockColors.

This array is added to each block if the dataset is a composite dataset. The array has one value set to (blockIndex % BlockColorsDistinctValues)

◆ GetAutoApply()

virtual bool vtkPVGeneralSettings::GetAutoApply ( )
virtual

Automatically apply changes in the 'Properties' panel.

◆ SetAutoApply()

virtual void vtkPVGeneralSettings::SetAutoApply ( bool  )
virtual

Automatically apply changes in the 'Properties' panel.

◆ GetAutoApplyActiveOnly()

virtual bool vtkPVGeneralSettings::GetAutoApplyActiveOnly ( )
virtual

Automatically apply changes in the 'Properties' panel.

◆ SetAutoApplyActiveOnly()

virtual void vtkPVGeneralSettings::SetAutoApplyActiveOnly ( bool  )
virtual

Automatically apply changes in the 'Properties' panel.

◆ SetEnableAutoMPI()

void vtkPVGeneralSettings::SetEnableAutoMPI ( bool  )

Enable auto-mpi.

Forwarded to vtkProcessModuleAutoMPI.

◆ GetEnableAutoMPI()

bool vtkPVGeneralSettings::GetEnableAutoMPI ( )

Enable auto-mpi.

Forwarded to vtkProcessModuleAutoMPI.

◆ SetAutoMPILimit()

void vtkPVGeneralSettings::SetAutoMPILimit ( int  val)

Set the core limit for auto-mpi.

◆ GetAutoMPILimit()

int vtkPVGeneralSettings::GetAutoMPILimit ( )

Set the core limit for auto-mpi.

◆ GetDefaultViewType()

virtual char* vtkPVGeneralSettings::GetDefaultViewType ( )
virtual

Get/Set the default view type.

◆ SetDefaultViewType()

virtual void vtkPVGeneralSettings::SetDefaultViewType ( const char *  )
virtual

Get/Set the default view type.

◆ GetTransferFunctionResetMode()

virtual int vtkPVGeneralSettings::GetTransferFunctionResetMode ( )
virtual

Get/Set the transfer function reset mode.

◆ SetTransferFunctionResetMode()

virtual void vtkPVGeneralSettings::SetTransferFunctionResetMode ( int  )
virtual

Get/Set the transfer function reset mode.

◆ GetScalarBarMode()

virtual int vtkPVGeneralSettings::GetScalarBarMode ( )
virtual

Enum for ScalarBarMode.

◆ SetScalarBarMode()

void vtkPVGeneralSettings::SetScalarBarMode ( int  )

Enum for ScalarBarMode.

◆ SetCacheGeometryForAnimation()

void vtkPVGeneralSettings::SetCacheGeometryForAnimation ( bool  val)

Set when animation geometry caching is enabled.

◆ GetCacheGeometryForAnimation()

virtual bool vtkPVGeneralSettings::GetCacheGeometryForAnimation ( )
virtual

Set when animation geometry caching is enabled.

◆ SetAnimationGeometryCacheLimit()

void vtkPVGeneralSettings::SetAnimationGeometryCacheLimit ( unsigned long  val)

Set the animation cache limit in KBs.

◆ GetAnimationGeometryCacheLimit()

virtual unsigned long vtkPVGeneralSettings::GetAnimationGeometryCacheLimit ( )
virtual

Set the animation cache limit in KBs.

◆ SetAnimationTimePrecision()

virtual void vtkPVGeneralSettings::SetAnimationTimePrecision ( int  )
virtual

Set the precision of the animation time toolbar.

◆ GetAnimationTimePrecision()

virtual int vtkPVGeneralSettings::GetAnimationTimePrecision ( )
virtual

Set the precision of the animation time toolbar.

◆ SetInheritRepresentationProperties()

void vtkPVGeneralSettings::SetInheritRepresentationProperties ( bool  val)

◆ SetPropertiesPanelMode()

virtual void vtkPVGeneralSettings::SetPropertiesPanelMode ( int  )
virtual

Properties panel configuration.

◆ GetPropertiesPanelMode()

virtual int vtkPVGeneralSettings::GetPropertiesPanelMode ( )
virtual

Properties panel configuration.

◆ SetLockPanels()

virtual void vtkPVGeneralSettings::SetLockPanels ( bool  )
virtual

Set whether to dock widgets into place.

◆ GetLockPanels()

virtual bool vtkPVGeneralSettings::GetLockPanels ( )
virtual

Set whether to dock widgets into place.

◆ SetMultiViewImageBorderColor()

void vtkPVGeneralSettings::SetMultiViewImageBorderColor ( double  r,
double  g,
double  b 
)

Forwarded to vtkSMViewLayoutProxy.

◆ SetMultiViewImageBorderWidth()

void vtkPVGeneralSettings::SetMultiViewImageBorderWidth ( int  width)

Forwarded to vtkSMViewLayoutProxy.

◆ SetTransparentBackground()

void vtkPVGeneralSettings::SetTransparentBackground ( bool  val)

Forwarded to vtkSMViewProxy.

◆ SetLoadAllVariables()

void vtkPVGeneralSettings::SetLoadAllVariables ( bool  val)

Load all variables when loading a data set.

◆ GetLoadAllVariables()

bool vtkPVGeneralSettings::GetLoadAllVariables ( )

Load all variables when loading a data set.

◆ SetLoadNoChartVariables()

void vtkPVGeneralSettings::SetLoadNoChartVariables ( bool  val)

Load no variables when showing a 2D chart.

◆ GetLoadNoChartVariables()

bool vtkPVGeneralSettings::GetLoadNoChartVariables ( )

Load no variables when showing a 2D chart.

Member Data Documentation

◆ BlockColorsDistinctValues

int vtkPVGeneralSettings::BlockColorsDistinctValues
protected

Definition at line 235 of file vtkPVGeneralSettings.h.

◆ AutoApply

bool vtkPVGeneralSettings::AutoApply
protected

Definition at line 236 of file vtkPVGeneralSettings.h.

◆ AutoApplyActiveOnly

bool vtkPVGeneralSettings::AutoApplyActiveOnly
protected

Definition at line 237 of file vtkPVGeneralSettings.h.

◆ DefaultViewType

char* vtkPVGeneralSettings::DefaultViewType
protected

Definition at line 238 of file vtkPVGeneralSettings.h.

◆ TransferFunctionResetMode

int vtkPVGeneralSettings::TransferFunctionResetMode
protected

Definition at line 239 of file vtkPVGeneralSettings.h.

◆ ScalarBarMode

int vtkPVGeneralSettings::ScalarBarMode
protected

Definition at line 240 of file vtkPVGeneralSettings.h.

◆ CacheGeometryForAnimation

bool vtkPVGeneralSettings::CacheGeometryForAnimation
protected

Definition at line 241 of file vtkPVGeneralSettings.h.

◆ AnimationGeometryCacheLimit

unsigned long vtkPVGeneralSettings::AnimationGeometryCacheLimit
protected

Definition at line 242 of file vtkPVGeneralSettings.h.

◆ AnimationTimePrecision

int vtkPVGeneralSettings::AnimationTimePrecision
protected

Definition at line 243 of file vtkPVGeneralSettings.h.

◆ PropertiesPanelMode

int vtkPVGeneralSettings::PropertiesPanelMode
protected

Definition at line 244 of file vtkPVGeneralSettings.h.

◆ LockPanels

bool vtkPVGeneralSettings::LockPanels
protected

Definition at line 245 of file vtkPVGeneralSettings.h.


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