vtkNew< T > Class Template Reference

Allocate and hold a VTK object. More...

#include <vtkNew.h>

Public Member Functions
	vtkNew ()
	Create a new T on construction. More...
T *	operator-> () const
	Enable pointer-like dereference syntax. More...
	~vtkNew ()
	Deletes reference to instance of T on destruction. More...
T *	GetPointer () const
	Get a raw pointer to the contained object. More...
T *	Get () const
	Get a raw pointer to the contained object. More...

Detailed Description

template<class T>
class vtkNew< T >

Allocate and hold a VTK object.

vtkNew is a class template that on construction allocates and initializes an instance of its template argument using T::New(). It assumes ownership of one reference during its lifetime, and calls T->Delete() on destruction.

Automatic casting is intentionally unavailable, calling GetPointer() will return a raw pointer. Users of this method should ensure that they do not return this pointer if the vtkNew will go out of scope without incrementing its reference count using vtkSmartPointer or similar.

vtkNew<vtkClass> a;
a->SomeMethod();

vtkSmartPointer<vtkClass> b = a.GetPointer();
b->SomeOtherMethod();

It should be noted that vtkNew is not a drop in replacement for vtkSmartPointer as it is not implicitly cast to a pointer in functions requiring a pointer. The GetPointer() method must be used, for example,

vtkNew<vtkRenderer> ren;
vtkNew<vtkRenderWindow> renWin;
renWin->AddRenderer(ren.GetPointer());
vtkNew<vtkRenderWindowInteractor> iren;
iren->SetRenderWindow(renWin.GetPointer());

See also

vtkSmartPointer vtkWeakPointer

Examples:

vtkNew (Examples)

Tests:

vtkNew (Tests)

Definition at line 67 of file vtkNew.h.

Constructor & Destructor Documentation

template<class T>

vtkNew< T >::vtkNew ( )

inline

Create a new T on construction.

Definition at line 77 of file vtkNew.h.

template<class T>

vtkNew< T >::~vtkNew ( )

inline

Deletes reference to instance of T on destruction.

Definition at line 86 of file vtkNew.h.

Member Function Documentation

template<class T>

T* vtkNew< T >::operator-> ( ) const

inline

Enable pointer-like dereference syntax.

Returns a pointer to the contained object.

Definition at line 101 of file vtkNew.h.

template<class T>

T* vtkNew< T >::GetPointer ( ) const

inline

Get a raw pointer to the contained object.

When using this function be careful that the reference count does not drop to 0 when using the pointer returned. This will happen when the vtkNew object goes out of scope for example.

Definition at line 113 of file vtkNew.h.

template<class T>

T* vtkNew< T >::Get ( ) const

inline

Get a raw pointer to the contained object.

When using this function be careful that the reference count does not drop to 0 when using the pointer returned. This will happen when the vtkNew object goes out of scope for example.

Definition at line 117 of file vtkNew.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Common/Core/vtkNew.h