vtkRenderWidget Class Reference

#include <vtkRenderWidget.h>

Inheritance diagram for vtkRenderWidget:

Collaboration diagram for vtkRenderWidget:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)
vtkRenderWidget *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
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
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (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 *)
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)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
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)
int	InvokeEvent (unsigned long event, void *callData)
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
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkRenderWidget *	SafeDownCast (vtkObjectBase *o)
static vtkRenderWidget *	New ()
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkRenderWidget ()
	~vtkRenderWidget ()
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
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
vtkVector2i	Position
vtkVector2i	Size
std::string	Name
vtkNew< vtkAbstractInteractionDevice >	InteractionDevice
vtkNew< vtkAbstractRenderDevice >	RenderDevice
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 26 of file vtkRenderWidget.h.

Member Typedef Documentation

typedef vtkObject vtkRenderWidget::Superclass

Definition at line 29 of file vtkRenderWidget.h.

Constructor & Destructor Documentation

vtkRenderWidget::vtkRenderWidget ( )

protected

vtkRenderWidget::~vtkRenderWidget ( )

protected

Member Function Documentation

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

static

virtual int 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 vtkObject.

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

static

virtual vtkObjectBase* vtkRenderWidget::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkRenderWidget* vtkRenderWidget::NewInstance

(

)

const

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

virtual

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.

static vtkRenderWidget* vtkRenderWidget::New ( )

static

void vtkRenderWidget::SetPosition

(

const vtkVector2i &

pos

)

Set the widget position in screen coordinates.

Parameters

pos	The position of the widget in screen coordinates.

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.

void vtkRenderWidget::SetSize

(

const vtkVector2i &

size

)

Set the widget size in screen coordinates.

Parameters

size	The width and height of the widget in screen coordinates

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.

void vtkRenderWidget::SetName

(

const std::string &

name

)

Set the name of the widget.

Parameters

name	The name to set to the window.

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.

virtual void vtkRenderWidget::Render ( )

virtual

Render everything in the current widget.

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.

void vtkRenderWidget::Initialize

(

)

void vtkRenderWidget::Start

(

)

Member Data Documentation

vtkVector2i vtkRenderWidget::Position

protected

Definition at line 89 of file vtkRenderWidget.h.

vtkVector2i vtkRenderWidget::Size

protected

Definition at line 90 of file vtkRenderWidget.h.

std::string vtkRenderWidget::Name

protected

Definition at line 91 of file vtkRenderWidget.h.

vtkNew<vtkAbstractInteractionDevice> vtkRenderWidget::InteractionDevice

protected

Definition at line 93 of file vtkRenderWidget.h.

vtkNew<vtkAbstractRenderDevice> vtkRenderWidget::RenderDevice

protected

Definition at line 94 of file vtkRenderWidget.h.

---

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

• dox/Rendering/Core/vtkRenderWidget.h