importer abstract class More...

#include <vtkImporter.h>

Inheritance diagram for vtkImporter:

Collaboration diagram for vtkImporter:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkImporter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)


virtual vtkRenderer *	GetRenderer ()


virtual void	SetRenderWindow (vtkRenderWindow *)

virtual vtkRenderWindow *	GetRenderWindow ()


void	Read ()

void	Update ()

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 vtkImporter *	SafeDownCast (vtkObjectBase *o)

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

	vtkImporter ()

	~vtkImporter ()

virtual int	ImportBegin ()

virtual void	ImportEnd ()

virtual void	ImportActors (vtkRenderer *)

virtual void	ImportCameras (vtkRenderer *)

virtual void	ImportLights (vtkRenderer *)

virtual void	ImportProperties (vtkRenderer *)

virtual void	ReadData ()

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
vtkRenderer *	Renderer

vtkRenderWindow *	RenderWindow

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

importer abstract class

vtkImporter is an abstract class that specifies the protocol for importing actors, cameras, lights and properties into a vtkRenderWindow. The following takes place: 1) Create a RenderWindow and Renderer if none is provided. 2) Call ImportBegin, if ImportBegin returns False, return 3) Call ReadData, which calls: a) Import the Actors b) Import the cameras c) Import the lights d) Import the Properties 7) Call ImportEnd

Subclasses optionally implement the ImportActors, ImportCameras, ImportLights and ImportProperties or ReadData methods. An ImportBegin and ImportEnd can optionally be provided to perform Importer-specific initialization and termination. The Read method initiates the import process. If a RenderWindow is provided, its Renderer will contained the imported objects. If the RenderWindow has no Renderer, one is created. If no RenderWindow is provided, both a RenderWindow and Renderer will be created. Both the RenderWindow and Renderer can be accessed using Get methods.

See also: vtk3DSImporter vtkExporter

Definition at line 53 of file vtkImporter.h.

Member Typedef Documentation

typedef vtkObject vtkImporter::Superclass

Definition at line 56 of file vtkImporter.h.

Constructor & Destructor Documentation

vtkImporter::vtkImporter ( )

protected

vtkImporter::~vtkImporter ( )

protected

Member Function Documentation

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

static

virtual int vtkImporter::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.

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

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

static

virtual vtkObjectBase* vtkImporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

vtkImporter* vtkImporter::NewInstance ( ) const

void vtkImporter::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.

Reimplemented in vtkVRMLImporter, and vtkOBJImporter.

virtual vtkRenderer* vtkImporter::GetRenderer ( )

virtual

Get the renderer that contains the imported actors, cameras and lights.

virtual void vtkImporter::SetRenderWindow ( vtkRenderWindow * )

virtual

Set the vtkRenderWindow to contain the imported actors, cameras and lights, If no vtkRenderWindow is set, one will be created and can be obtained with the GetRenderWindow method. If the vtkRenderWindow has been specified, the first vtkRenderer it has will be used to import the objects. If the vtkRenderWindow has no Renderer, one will be created and can be accessed using GetRenderer.

virtual vtkRenderWindow* vtkImporter::GetRenderWindow ( )

virtual

Set the vtkRenderWindow to contain the imported actors, cameras and lights, If no vtkRenderWindow is set, one will be created and can be obtained with the GetRenderWindow method. If the vtkRenderWindow has been specified, the first vtkRenderer it has will be used to import the objects. If the vtkRenderWindow has no Renderer, one will be created and can be accessed using GetRenderer.

void vtkImporter::Read ( )

Import the actors, cameras, lights and properties into a vtkRenderWindow.

void vtkImporter::Update ( )

inline

Import the actors, cameras, lights and properties into a vtkRenderWindow.

Definition at line 82 of file vtkImporter.h.

virtual int vtkImporter::ImportBegin ( )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

Definition at line 90 of file vtkImporter.h.

virtual void vtkImporter::ImportEnd ( )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

Definition at line 91 of file vtkImporter.h.

virtual void vtkImporter::ImportActors ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

Definition at line 92 of file vtkImporter.h.

virtual void vtkImporter::ImportCameras ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

Definition at line 93 of file vtkImporter.h.

virtual void vtkImporter::ImportLights ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

Definition at line 94 of file vtkImporter.h.

virtual void vtkImporter::ImportProperties ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

Definition at line 95 of file vtkImporter.h.

virtual void vtkImporter::ReadData ( )

protectedvirtual

Reimplemented in vtkOBJImporter.

Member Data Documentation

vtkRenderer* vtkImporter::Renderer

protected

Definition at line 97 of file vtkImporter.h.

vtkRenderWindow* vtkImporter::RenderWindow

protected

Definition at line 98 of file vtkImporter.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/IO/Import/vtkImporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation