importer abstract class More...

#include <vtkImporter.h>

Inheritance diagram for vtkImporter:

Collaboration diagram for vtkImporter:

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...

vtkImporter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual std::string	GetOutputsDescription ()
	Recover a printable string that let importer implementation Describe their outputs. More...

virtual vtkIdType	GetNumberOfAnimations ()
	Get the number of available animations. More...

virtual std::string	GetAnimationName (vtkIdType vtkNotUsed(animationIndex))
	Get the name of an animation. More...

virtual vtkIdType	GetNumberOfCameras ()
	Get the number of available cameras. More...

virtual std::string	GetCameraName (vtkIdType vtkNotUsed(camIndex))
	Get the name of a camera. More...

virtual void	SetCamera (vtkIdType vtkNotUsed(camIndex))
	Enable a specific camera. More...

virtual bool	GetTemporalInformation (vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps)
	Get temporal informations for the currently enabled animations. More...

virtual void	UpdateTimeStep (double timeStep)
	Import the actors, camera, lights and properties at a specific timestep. More...


virtual vtkRenderer *	GetRenderer ()
	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 vtkRenderWindow *	GetRenderWindow ()
	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...


void	Read ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow. More...

void	Update ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow. More...


virtual void	EnableAnimation (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations. More...

virtual void	DisableAnimation (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations. More...

virtual bool	IsAnimationEnabled (vtkIdType vtkNotUsed(animationIndex))
	Enable/Disable/Get the status of specific animations. More...

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...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). 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	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...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkImporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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 vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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 ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Static Protected Member Functions
static std::string	GetDataSetDescription (vtkDataSet *ds, vtkIndent indent)

static std::string	GetArrayDescription (vtkAbstractArray *array, vtkIndent indent)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkRenderer *	Renderer

vtkRenderWindow *	RenderWindow

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

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 59 of file vtkImporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkImporter::Superclass

Definition at line 62 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 vtk3DSImporter, vtkGLTFImporter, vtkOBJImporter, and vtkVRMLImporter.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkImporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtk3DSImporter, vtkGLTFImporter, vtkOBJImporter, and vtkVRMLImporter.

◆ 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 vtkOBJImporter, and vtkVRMLImporter.

◆ 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

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.

◆ Read()

void vtkImporter::Read ( )

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

◆ Update()

void vtkImporter::Update ( )

inline

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

Definition at line 91 of file vtkImporter.h.

◆ GetOutputsDescription()

virtual std::string vtkImporter::GetOutputsDescription ( )

inlinevirtual

Recover a printable string that let importer implementation Describe their outputs.

Reimplemented in vtk3DSImporter, vtkGLTFImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 98 of file vtkImporter.h.

◆ GetNumberOfAnimations()

virtual vtkIdType vtkImporter::GetNumberOfAnimations ( )

virtual

Get the number of available animations.

Return -1 if not provided by implementation.

Reimplemented in vtkGLTFImporter.

◆ GetAnimationName()

virtual std::string vtkImporter::GetAnimationName ( vtkIdType vtkNotUsedanimationIndex )

inlinevirtual

Get the name of an animation.

Return an empty if not provided by implementation.

Definition at line 110 of file vtkImporter.h.

◆ EnableAnimation()

virtual void vtkImporter::EnableAnimation ( vtkIdType vtkNotUsedanimationIndex )

inlinevirtual

Enable/Disable/Get the status of specific animations.

Definition at line 116 of file vtkImporter.h.

◆ DisableAnimation()

virtual void vtkImporter::DisableAnimation ( vtkIdType vtkNotUsedanimationIndex )

inlinevirtual

Enable/Disable/Get the status of specific animations.

Definition at line 117 of file vtkImporter.h.

◆ IsAnimationEnabled()

virtual bool vtkImporter::IsAnimationEnabled ( vtkIdType vtkNotUsedanimationIndex )

inlinevirtual

Enable/Disable/Get the status of specific animations.

Definition at line 118 of file vtkImporter.h.

◆ GetNumberOfCameras()

virtual vtkIdType vtkImporter::GetNumberOfCameras ( )

inlinevirtual

Get the number of available cameras.

Return 0 if not provided by implementation.

Reimplemented in vtkGLTFImporter.

Definition at line 125 of file vtkImporter.h.

◆ GetCameraName()

virtual std::string vtkImporter::GetCameraName ( vtkIdType vtkNotUsedcamIndex )

inlinevirtual

Get the name of a camera.

Return an empty string if not provided by implementation.

Definition at line 131 of file vtkImporter.h.

◆ SetCamera()

virtual void vtkImporter::SetCamera ( vtkIdType vtkNotUsedcamIndex )

inlinevirtual

Enable a specific camera.

If a negative index is provided, no camera from the importer is used. Does nothing if not provided by implementation.

Definition at line 138 of file vtkImporter.h.

◆ GetTemporalInformation()

virtual bool vtkImporter::GetTemporalInformation	(	vtkIdType	animationIndex,
		double	frameRate,
		int &	nbTimeSteps,
		double	timeRange[2],
		vtkDoubleArray *	timeSteps
	)

virtual

Get temporal informations for the currently enabled animations.

the three return arguments can be defined or not. Return true in case of success, false otherwise.

Reimplemented in vtkGLTFImporter.

◆ UpdateTimeStep()

virtual void vtkImporter::UpdateTimeStep ( double timeStep )

virtual

Import the actors, camera, lights and properties at a specific timestep.

If not reimplemented, only call Update().

Reimplemented in vtkGLTFImporter.

◆ ImportBegin()

virtual int vtkImporter::ImportBegin ( )

inlineprotectedvirtual

Reimplemented in vtk3DSImporter, vtkGLTFImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 158 of file vtkImporter.h.

◆ ImportEnd()

virtual void vtkImporter::ImportEnd ( )

inlineprotectedvirtual

Reimplemented in vtk3DSImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 159 of file vtkImporter.h.

◆ ImportActors()

virtual void vtkImporter::ImportActors ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 160 of file vtkImporter.h.

◆ ImportCameras()

virtual void vtkImporter::ImportCameras ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 161 of file vtkImporter.h.

◆ ImportLights()

virtual void vtkImporter::ImportLights ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 162 of file vtkImporter.h.

◆ ImportProperties()

virtual void vtkImporter::ImportProperties ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

Definition at line 163 of file vtkImporter.h.

◆ GetDataSetDescription()

static std::string vtkImporter::GetDataSetDescription	(	vtkDataSet *	ds,
		vtkIndent	indent
	)

staticprotected

◆ GetArrayDescription()

static std::string vtkImporter::GetArrayDescription	(	vtkAbstractArray *	array,
		vtkIndent	indent
	)

staticprotected

◆ ReadData()

virtual void vtkImporter::ReadData ( )

protectedvirtual

Reimplemented in vtkOBJImporter.

Member Data Documentation

◆ Renderer

vtkRenderer* vtkImporter::Renderer

protected

Definition at line 168 of file vtkImporter.h.

◆ RenderWindow

vtkRenderWindow* vtkImporter::RenderWindow

protected

Definition at line 169 of file vtkImporter.h.

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

IO/Import/vtkImporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkImporter()

◆ ~vtkImporter()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetRenderer()

◆ SetRenderWindow()

◆ GetRenderWindow()

◆ Read()

◆ Update()

◆ GetOutputsDescription()

◆ GetNumberOfAnimations()

◆ GetAnimationName()

◆ EnableAnimation()

◆ DisableAnimation()

◆ IsAnimationEnabled()

◆ GetNumberOfCameras()

◆ GetCameraName()

◆ SetCamera()

◆ GetTemporalInformation()

◆ UpdateTimeStep()

◆ ImportBegin()

◆ ImportEnd()

◆ ImportActors()

◆ ImportCameras()

◆ ImportLights()

◆ ImportProperties()

◆ GetDataSetDescription()

◆ GetArrayDescription()

◆ ReadData()

Member Data Documentation

◆ Renderer

◆ RenderWindow