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

importer abstract class More...

#include <vtkImporter.h>

Inheritance diagram for vtkImporter:
[legend]
Collaboration diagram for vtkImporter:
[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...
 
vtkImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkRendererGetRenderer ()
 Get the renderer that contains the imported actors, cameras and lights. More...
 
virtual void SetRenderWindow (vtkRenderWindow *)
 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. More...
 
virtual vtkRenderWindowGetRenderWindow ()
 
void Read ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow. More...
 
void Update ()
 
- 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 vtkImporterSafeDownCast (vtkObjectBase *o)
 
- 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
 
 vtkImporter ()
 
 ~vtkImporter () override
 
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 ()
 
 ~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

vtkRendererRenderer
 
vtkRenderWindowRenderWindow
 
- 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 54 of file vtkImporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file vtkImporter.h.

Constructor & Destructor Documentation

◆ vtkImporter()

vtkImporter::vtkImporter ( )
protected

◆ ~vtkImporter()

vtkImporter::~vtkImporter ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool 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 vtkObjectBase.

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImporter::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkImporter* vtkImporter::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkVRMLImporter, and vtkOBJImporter.

◆ GetRenderer()

virtual vtkRenderer* vtkImporter::GetRenderer ( )
virtual

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

◆ SetRenderWindow()

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.

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkImporter::GetRenderWindow ( )
virtual

◆ Read()

void vtkImporter::Read ( )

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

◆ Update()

void vtkImporter::Update ( )
inline

Definition at line 88 of file vtkImporter.h.

◆ ImportBegin()

virtual int vtkImporter::ImportBegin ( )
inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

Definition at line 96 of file vtkImporter.h.

◆ ImportEnd()

virtual void vtkImporter::ImportEnd ( )
inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtkOBJImporter, and vtk3DSImporter.

Definition at line 97 of file vtkImporter.h.

◆ ImportActors()

virtual void vtkImporter::ImportActors ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtk3DSImporter, and vtkVRMLImporter.

Definition at line 98 of file vtkImporter.h.

◆ ImportCameras()

virtual void vtkImporter::ImportCameras ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtk3DSImporter, and vtkVRMLImporter.

Definition at line 99 of file vtkImporter.h.

◆ ImportLights()

virtual void vtkImporter::ImportLights ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtk3DSImporter, and vtkVRMLImporter.

Definition at line 100 of file vtkImporter.h.

◆ ImportProperties()

virtual void vtkImporter::ImportProperties ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtk3DSImporter, and vtkVRMLImporter.

Definition at line 101 of file vtkImporter.h.

◆ ReadData()

virtual void vtkImporter::ReadData ( )
protectedvirtual

Reimplemented in vtkOBJImporter.

Member Data Documentation

◆ Renderer

vtkRenderer* vtkImporter::Renderer
protected

Definition at line 103 of file vtkImporter.h.

◆ RenderWindow

vtkRenderWindow* vtkImporter::RenderWindow
protected

Definition at line 104 of file vtkImporter.h.


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