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

This is a helper class for vtkIceTRenderManager and vtkOpenGLIceTRenderer. More...

#include <vtkIceTContext.h>

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

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual void MakeCurrent ()
 Make this context the current one. More...
 
virtual void CopyState (vtkIceTContext *src)
 Copy the state from the given context to this context. More...
 
virtual int IsValid ()
 Returns true if the current state is valid. More...
 
virtual void SetController (vtkMultiProcessController *controller)
 Associate the context with the given controller. More...
 
virtual vtkMultiProcessControllerGetController ()
 Associate the context with the given controller. More...
 
virtual int GetUseOpenGL ()
 Turn this on to enable the OpenGL layer in IceT. More...
 
virtual void SetUseOpenGL (int flag)
 Turn this on to enable the OpenGL layer in IceT. More...
 
virtual void UseOpenGLOn ()
 Turn this on to enable the OpenGL layer in IceT. More...
 
virtual void UseOpenGLOff ()
 Turn this on to enable the OpenGL layer in IceT. 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 int IsTypeOf (const char *type)
 
static vtkIceTContextSafeDownCast (vtkObject *o)
 
static vtkIceTContextNew ()
 
- 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

 vtkIceTContext ()
 
 ~vtkIceTContext () 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

vtkMultiProcessControllerController
 
int UseOpenGL
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

This is a helper class for vtkIceTRenderManager and vtkOpenGLIceTRenderer.

Most users will never need this class.

This class was conceived to pass IceT contexts between vtkIceTRenderManager and vtkOpenGLIceTRenderer without having to include the IceT header file in either class. Along the way, some functionality was added.

Bug:
If you set the communicator to nullptr and then to a valid value, the IceT state will be lost.
See also
vtkIceTRenderManager

Definition at line 51 of file vtkIceTContext.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkIceTContext.h.

Constructor & Destructor Documentation

◆ vtkIceTContext()

vtkIceTContext::vtkIceTContext ( )
protected

◆ ~vtkIceTContext()

vtkIceTContext::~vtkIceTContext ( )
overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkIceTContext::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

◆ New()

static vtkIceTContext* vtkIceTContext::New ( )
static

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ SetController()

virtual void vtkIceTContext::SetController ( vtkMultiProcessController controller)
virtual

Associate the context with the given controller.

Currently, this must be a vtkMPIController. The context is not valid until a controller is set.

◆ GetController()

virtual vtkMultiProcessController* vtkIceTContext::GetController ( )
virtual

Associate the context with the given controller.

Currently, this must be a vtkMPIController. The context is not valid until a controller is set.

◆ MakeCurrent()

virtual void vtkIceTContext::MakeCurrent ( )
virtual

Make this context the current one.

◆ GetUseOpenGL()

virtual int vtkIceTContext::GetUseOpenGL ( )
virtual

Turn this on to enable the OpenGL layer in IceT.

By default this is off. Unless you explicitly plan to use the OpenGL layer, it should probably remain off to ensure that you don't accidentally use a feature you did not intend to use.

◆ SetUseOpenGL()

virtual void vtkIceTContext::SetUseOpenGL ( int  flag)
virtual

Turn this on to enable the OpenGL layer in IceT.

By default this is off. Unless you explicitly plan to use the OpenGL layer, it should probably remain off to ensure that you don't accidentally use a feature you did not intend to use.

◆ UseOpenGLOn()

virtual void vtkIceTContext::UseOpenGLOn ( )
virtual

Turn this on to enable the OpenGL layer in IceT.

By default this is off. Unless you explicitly plan to use the OpenGL layer, it should probably remain off to ensure that you don't accidentally use a feature you did not intend to use.

◆ UseOpenGLOff()

virtual void vtkIceTContext::UseOpenGLOff ( )
virtual

Turn this on to enable the OpenGL layer in IceT.

By default this is off. Unless you explicitly plan to use the OpenGL layer, it should probably remain off to ensure that you don't accidentally use a feature you did not intend to use.

◆ CopyState()

virtual void vtkIceTContext::CopyState ( vtkIceTContext src)
virtual

Copy the state from the given context to this context.

◆ IsValid()

virtual int vtkIceTContext::IsValid ( )
virtual

Returns true if the current state is valid.

Member Data Documentation

◆ Controller

vtkMultiProcessController* vtkIceTContext::Controller
protected

Definition at line 99 of file vtkIceTContext.h.

◆ UseOpenGL

int vtkIceTContext::UseOpenGL
protected

Definition at line 101 of file vtkIceTContext.h.


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