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

singleton used to keep track of options for vtkPVRenderView. More...

#include <vtkPVRenderViewSettings.h>

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

Public Types

enum  { DO_NOTHING = 0, OFFSET_FACES = 1, OFFSET_LINES_AND_VERTS = 2, ZSHIFT = 3 }
 
enum  { AUTOMATIC = 0, ALWAYS_2D = 1, ALWAYS_3D = 2 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetResolveCoincidentTopology (int mode)
 vtkMapper settings. More...
 
void SetPolygonOffsetParameters (double factor, double units)
 vtkMapper settings. More...
 
void SetLineOffsetParameters (double factor, double units)
 vtkMapper settings. More...
 
void SetPointOffsetParameter (double units)
 vtkMapper settings. More...
 
void SetZShift (double a)
 vtkMapper settings. More...
 
virtual void SetOutlineThreshold (vtkIdType)
 Set the number of cells (in millions) when the representations show try to use outline by default. More...
 
virtual vtkIdType GetOutlineThreshold ()
 Set the number of cells (in millions) when the representations show try to use outline by default. More...
 
virtual void SetTwoSidedLighting (bool)
 When rendering a volume, this option simulates light coming from both its direction and its opposite for all lights in the scene. More...
 
virtual bool GetTwoSidedLighting ()
 When rendering a volume, this option simulates light coming from both its direction and its opposite for all lights in the scene. More...
 
virtual void SetDefaultInteractionMode (int)
 Set the default interaction mode. More...
 
virtual int GetDefaultInteractionMode ()
 Set the default interaction mode. More...
 
virtual void SetPointPickingRadius (int)
 Set the radius in pixels to include for finding the closet point when selecting a point on render view. More...
 
virtual int GetPointPickingRadius ()
 Set the radius in pixels to include for finding the closet point when selecting a point on render view. More...
 
virtual void SetDisableIceT (bool)
 EXPERIMENTAL: Add ability to disable IceT. More...
 
virtual bool GetDisableIceT ()
 EXPERIMENTAL: Add ability to disable IceT. More...
 
virtual void SetEnableFastPreselection (bool)
 Enable fast preselection. More...
 
virtual bool GetEnableFastPreselection ()
 Enable fast preselection. More...
 
virtual void SetBackgroundColor (double, double, double)
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void SetBackgroundColor (double [3])
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual doubleGetBackgroundColor ()
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void GetBackgroundColor (double &, double &, double &)
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void GetBackgroundColor (double [3])
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void SetBackground2Color (double, double, double)
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void SetBackground2Color (double [3])
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual doubleGetBackground2Color ()
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void GetBackground2Color (double &, double &, double &)
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void GetBackground2Color (double [3])
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual void SetBackgroundColorMode (int)
 Used by vtkPVRenderView and other views to determine background color. More...
 
virtual int GetBackgroundColorMode ()
 Used by vtkPVRenderView and other views to determine background color. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkPVRenderViewSettingsNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVRenderViewSettingsSafeDownCast (vtkObject *o)
 
static vtkPVRenderViewSettingsGetInstance ()
 Access the singleton. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkPVRenderViewSettings ()
 
 ~vtkPVRenderViewSettings () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int DefaultInteractionMode
 
vtkIdType OutlineThreshold
 
bool TwoSidedLighting = true
 
int PointPickingRadius
 
bool DisableIceT
 
bool EnableFastPreselection
 
double BackgroundColor [3]
 
double Background2Color [3]
 
int BackgroundColorMode
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

singleton used to keep track of options for vtkPVRenderView.

vtkPVRenderViewSettings is a singleton used to keep track of selections for various configurable parameters used by vtkPVRenderView. All class to vtkPVRenderViewSettings::New() returns a reference to the singleton instance.

Definition at line 33 of file vtkPVRenderViewSettings.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkPVRenderViewSettings.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
DO_NOTHING 
OFFSET_FACES 
OFFSET_LINES_AND_VERTS 
ZSHIFT 

Definition at line 45 of file vtkPVRenderViewSettings.h.

◆ anonymous enum

anonymous enum
Enumerator
AUTOMATIC 
ALWAYS_2D 
ALWAYS_3D 

Definition at line 82 of file vtkPVRenderViewSettings.h.

Constructor & Destructor Documentation

◆ vtkPVRenderViewSettings()

vtkPVRenderViewSettings::vtkPVRenderViewSettings ( )
protected

◆ ~vtkPVRenderViewSettings()

vtkPVRenderViewSettings::~vtkPVRenderViewSettings ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVRenderViewSettings* vtkPVRenderViewSettings::New ( )
static

◆ GetClassName()

virtual const char* vtkPVRenderViewSettings::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkPVRenderViewSettings::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Reimplemented from vtkObject.

◆ GetInstance()

static vtkPVRenderViewSettings* vtkPVRenderViewSettings::GetInstance ( )
static

Access the singleton.

◆ SetResolveCoincidentTopology()

void vtkPVRenderViewSettings::SetResolveCoincidentTopology ( int  mode)

vtkMapper settings.

◆ SetPolygonOffsetParameters()

void vtkPVRenderViewSettings::SetPolygonOffsetParameters ( double  factor,
double  units 
)

vtkMapper settings.

◆ SetLineOffsetParameters()

void vtkPVRenderViewSettings::SetLineOffsetParameters ( double  factor,
double  units 
)

vtkMapper settings.

◆ SetPointOffsetParameter()

void vtkPVRenderViewSettings::SetPointOffsetParameter ( double  units)

vtkMapper settings.

◆ SetZShift()

void vtkPVRenderViewSettings::SetZShift ( double  a)

vtkMapper settings.

◆ SetOutlineThreshold()

virtual void vtkPVRenderViewSettings::SetOutlineThreshold ( vtkIdType  )
virtual

Set the number of cells (in millions) when the representations show try to use outline by default.

◆ GetOutlineThreshold()

virtual vtkIdType vtkPVRenderViewSettings::GetOutlineThreshold ( )
virtual

Set the number of cells (in millions) when the representations show try to use outline by default.

◆ SetTwoSidedLighting()

virtual void vtkPVRenderViewSettings::SetTwoSidedLighting ( bool  )
virtual

When rendering a volume, this option simulates light coming from both its direction and its opposite for all lights in the scene.

It is enabled by default.

◆ GetTwoSidedLighting()

virtual bool vtkPVRenderViewSettings::GetTwoSidedLighting ( )
virtual

When rendering a volume, this option simulates light coming from both its direction and its opposite for all lights in the scene.

It is enabled by default.

◆ SetDefaultInteractionMode()

virtual void vtkPVRenderViewSettings::SetDefaultInteractionMode ( int  )
virtual

Set the default interaction mode.

◆ GetDefaultInteractionMode()

virtual int vtkPVRenderViewSettings::GetDefaultInteractionMode ( )
virtual

Set the default interaction mode.

◆ SetPointPickingRadius()

virtual void vtkPVRenderViewSettings::SetPointPickingRadius ( int  )
virtual

Set the radius in pixels to include for finding the closet point when selecting a point on render view.

This only after single point selections i.e. when selecting a regions this radius is not respected.

◆ GetPointPickingRadius()

virtual int vtkPVRenderViewSettings::GetPointPickingRadius ( )
virtual

Set the radius in pixels to include for finding the closet point when selecting a point on render view.

This only after single point selections i.e. when selecting a regions this radius is not respected.

◆ SetDisableIceT()

virtual void vtkPVRenderViewSettings::SetDisableIceT ( bool  )
virtual

EXPERIMENTAL: Add ability to disable IceT.

◆ GetDisableIceT()

virtual bool vtkPVRenderViewSettings::GetDisableIceT ( )
virtual

EXPERIMENTAL: Add ability to disable IceT.

◆ SetEnableFastPreselection()

virtual void vtkPVRenderViewSettings::SetEnableFastPreselection ( bool  )
virtual

Enable fast preselection.

When enabled, the preselection is computed using the visible geometry. This avoids a call to the extract selection filter each time the mouse moves, improving a lot the preselection highlight display, especially for big datasets.

◆ GetEnableFastPreselection()

virtual bool vtkPVRenderViewSettings::GetEnableFastPreselection ( )
virtual

Enable fast preselection.

When enabled, the preselection is computed using the visible geometry. This avoids a call to the extract selection filter each time the mouse moves, improving a lot the preselection highlight display, especially for big datasets.

◆ SetBackgroundColor() [1/2]

virtual void vtkPVRenderViewSettings::SetBackgroundColor ( double  ,
double  ,
double   
)
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ SetBackgroundColor() [2/2]

virtual void vtkPVRenderViewSettings::SetBackgroundColor ( double  [3])
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackgroundColor() [1/3]

virtual double* vtkPVRenderViewSettings::GetBackgroundColor ( )
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackgroundColor() [2/3]

virtual void vtkPVRenderViewSettings::GetBackgroundColor ( double ,
double ,
double  
)
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackgroundColor() [3/3]

virtual void vtkPVRenderViewSettings::GetBackgroundColor ( double  [3])
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ SetBackground2Color() [1/2]

virtual void vtkPVRenderViewSettings::SetBackground2Color ( double  ,
double  ,
double   
)
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ SetBackground2Color() [2/2]

virtual void vtkPVRenderViewSettings::SetBackground2Color ( double  [3])
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackground2Color() [1/3]

virtual double* vtkPVRenderViewSettings::GetBackground2Color ( )
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackground2Color() [2/3]

virtual void vtkPVRenderViewSettings::GetBackground2Color ( double ,
double ,
double  
)
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackground2Color() [3/3]

virtual void vtkPVRenderViewSettings::GetBackground2Color ( double  [3])
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ SetBackgroundColorMode()

virtual void vtkPVRenderViewSettings::SetBackgroundColorMode ( int  )
virtual

Used by vtkPVRenderView and other views to determine background color.

◆ GetBackgroundColorMode()

virtual int vtkPVRenderViewSettings::GetBackgroundColorMode ( )
virtual

Used by vtkPVRenderView and other views to determine background color.

Member Data Documentation

◆ DefaultInteractionMode

int vtkPVRenderViewSettings::DefaultInteractionMode
protected

Definition at line 140 of file vtkPVRenderViewSettings.h.

◆ OutlineThreshold

vtkIdType vtkPVRenderViewSettings::OutlineThreshold
protected

Definition at line 141 of file vtkPVRenderViewSettings.h.

◆ TwoSidedLighting

bool vtkPVRenderViewSettings::TwoSidedLighting = true
protected

Definition at line 142 of file vtkPVRenderViewSettings.h.

◆ PointPickingRadius

int vtkPVRenderViewSettings::PointPickingRadius
protected

Definition at line 143 of file vtkPVRenderViewSettings.h.

◆ DisableIceT

bool vtkPVRenderViewSettings::DisableIceT
protected

Definition at line 144 of file vtkPVRenderViewSettings.h.

◆ EnableFastPreselection

bool vtkPVRenderViewSettings::EnableFastPreselection
protected

Definition at line 145 of file vtkPVRenderViewSettings.h.

◆ BackgroundColor

double vtkPVRenderViewSettings::BackgroundColor[3]
protected

Definition at line 147 of file vtkPVRenderViewSettings.h.

◆ Background2Color

double vtkPVRenderViewSettings::Background2Color[3]
protected

Definition at line 148 of file vtkPVRenderViewSettings.h.

◆ BackgroundColorMode

int vtkPVRenderViewSettings::BackgroundColorMode
protected

Definition at line 149 of file vtkPVRenderViewSettings.h.


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