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

#include <vtkRenderWidget.h>

Inheritance diagram for vtkRenderWidget:
[legend]
Collaboration diagram for vtkRenderWidget:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkRenderWidgetNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetPosition (const vtkVector2i &pos)
 Set the widget position in screen coordinates. More...
 
vtkVector2i GetPosition () const
 Get the widget position in screen coordinates. More...
 
void SetSize (const vtkVector2i &size)
 Set the widget size in screen coordinates. More...
 
vtkVector2i GetSize () const
 Get the widget size in screen coordinates. More...
 
void SetName (const std::string &name)
 Set the name of the widget. More...
 
std::string GetName () const
 Get the name of the widget. More...
 
virtual void Render ()
 Render everything in the current widget. More...
 
virtual void MakeCurrent ()
 Make the widget's context current, this will defer to the OS specific methods, and calls should be kept to a minimum as they are quite expensive. More...
 
void Initialize ()
 
void Start ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderWidgetSafeDownCast (vtkObjectBase *o)
 
static vtkRenderWidgetNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderWidget ()
 
 ~vtkRenderWidget () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
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

vtkVector2i Position
 
vtkVector2i Size
 
std::string Name
 
vtkNew< vtkAbstractInteractionDeviceInteractionDevice
 
vtkNew< vtkAbstractRenderDeviceRenderDevice
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Definition at line 26 of file vtkRenderWidget.h.

Member Typedef Documentation

◆ Superclass

Definition at line 29 of file vtkRenderWidget.h.

Constructor & Destructor Documentation

◆ vtkRenderWidget()

vtkRenderWidget::vtkRenderWidget ( )
protected

◆ ~vtkRenderWidget()

vtkRenderWidget::~vtkRenderWidget ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkRenderWidget::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkRenderWidget::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkRenderWidget* vtkRenderWidget::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkRenderWidget::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRenderWidget* vtkRenderWidget::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ New()

static vtkRenderWidget* vtkRenderWidget::New ( )
static

◆ SetPosition()

void vtkRenderWidget::SetPosition ( const vtkVector2i pos)

Set the widget position in screen coordinates.

Parameters
posThe position of the widget in screen coordinates.

◆ GetPosition()

vtkVector2i vtkRenderWidget::GetPosition ( ) const
inline

Get the widget position in screen coordinates.

Returns
The position of the widget in screen coordinates, default of 0, 0.

Definition at line 43 of file vtkRenderWidget.h.

◆ SetSize()

void vtkRenderWidget::SetSize ( const vtkVector2i size)

Set the widget size in screen coordinates.

Parameters
sizeThe width and height of the widget in screen coordinates

◆ GetSize()

vtkVector2i vtkRenderWidget::GetSize ( ) const
inline

Get the widget size in screen coordinates.

Returns
The width and height of the widget in screen coordinates, default of 300x300.

Definition at line 56 of file vtkRenderWidget.h.

◆ SetName()

void vtkRenderWidget::SetName ( const std::string &  name)

Set the name of the widget.

Parameters
nameThe name to set to the window.

◆ GetName()

std::string vtkRenderWidget::GetName ( ) const
inline

Get the name of the widget.

Returns
The current name of the widget.

Definition at line 68 of file vtkRenderWidget.h.

◆ Render()

virtual void vtkRenderWidget::Render ( )
virtual

Render everything in the current widget.

◆ MakeCurrent()

virtual void vtkRenderWidget::MakeCurrent ( )
virtual

Make the widget's context current, this will defer to the OS specific methods, and calls should be kept to a minimum as they are quite expensive.

◆ Initialize()

void vtkRenderWidget::Initialize ( )

◆ Start()

void vtkRenderWidget::Start ( )

Member Data Documentation

◆ Position

vtkVector2i vtkRenderWidget::Position
protected

Definition at line 89 of file vtkRenderWidget.h.

◆ Size

vtkVector2i vtkRenderWidget::Size
protected

Definition at line 90 of file vtkRenderWidget.h.

◆ Name

std::string vtkRenderWidget::Name
protected

Definition at line 91 of file vtkRenderWidget.h.

◆ InteractionDevice

vtkNew<vtkAbstractInteractionDevice> vtkRenderWidget::InteractionDevice
protected

Definition at line 93 of file vtkRenderWidget.h.

◆ RenderDevice

vtkNew<vtkAbstractRenderDevice> vtkRenderWidget::RenderDevice
protected

Definition at line 94 of file vtkRenderWidget.h.


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