importer abstract class More...

#include <vtkImporter.h>

Inheritance diagram for vtkImporter:

Collaboration diagram for vtkImporter:

Public Types
enum class	AnimationSupportLevel : unsigned char { NONE , UNIQUE , SINGLE , MULTI }

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.

vtkImporter *	NewInstance () const

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

bool	Update ()
	Import the actors, cameras, lights and properties into a vtkRenderWindow and return if it was successful of not.

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

virtual AnimationSupportLevel	GetAnimationSupportLevel ()
	Get the level of animation support, this is coming either from the file format or as a limitation of the implementation.

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

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

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

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

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

virtual bool	GetTemporalInformation (vtkIdType animationIndex, double frameRate, int &nbTimeSteps, double timeRange[2], vtkDoubleArray *timeSteps)
	Get temporal information for the provided animationIndex and frameRate.

virtual bool	UpdateAtTimeValue (double timeValue)
	Import the actors, camera, lights and properties at a specific time value.


virtual vtkRenderer *	GetRenderer ()
	Get the renderer that contains the imported actors, cameras and lights.


virtual vtkDataAssembly *	GetSceneHierarchy ()
	Get the hierarchy of actors, cameras and lights in the renderer.


vtkActorCollection *	GetImportedActors ()
	Get collection of actors, cameras and lights that were imported by this importer.

vtkCollection *	GetImportedCameras ()
	Get collection of actors, cameras and lights that were imported by this importer.

vtkLightCollection *	GetImportedLights ()
	Get collection of actors, cameras and lights that were imported by this importer.


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.

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.


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

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

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


virtual void	SetImportArmature (bool)
	Enable/Disable armature actors import if supported.

virtual bool	GetImportArmature ()
	Enable/Disable armature actors import if supported.

virtual void	ImportArmatureOn ()
	Enable/Disable armature actors import if supported.

virtual void	ImportArmatureOff ()
	Enable/Disable armature actors import if supported.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

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

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

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

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

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

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

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

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

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

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

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.

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

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

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

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.

Protected Types
enum class	UpdateStatusEnum : bool { SUCCESS , FAILURE }

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 ()

void	SetUpdateStatus (UpdateStatusEnum updateStatus)
	Set the update status.

UpdateStatusEnum	GetUpdateStatus ()
	Get the update status.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

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 *)

virtual void	ObjectFinalize ()

	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 = nullptr

vtkRenderWindow *	RenderWindow = nullptr

vtkSmartPointer< vtkDataAssembly >	SceneHierarchy

vtkNew< vtkActorCollection >	ActorCollection

vtkNew< vtkCollection >	CameraCollection

vtkNew< vtkLightCollection >	LightCollection

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

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

Tests:: vtkImporter (Tests)

Definition at line 58 of file vtkImporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkImporter::Superclass

Definition at line 61 of file vtkImporter.h.

Member Enumeration Documentation

◆ AnimationSupportLevel

enum class vtkImporter::AnimationSupportLevel : unsigned char

strong

Enumerator
NONE
UNIQUE
SINGLE
MULTI

Definition at line 118 of file vtkImporter.h.

◆ UpdateStatusEnum

enum class vtkImporter::UpdateStatusEnum : bool

strongprotected

Enumerator
SUCCESS
FAILURE

Definition at line 221 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 vtkObjectBase.

Reimplemented in vtkOBJImporter, and vtkVRMLImporter.

◆ GetRenderer()

virtual vtkRenderer * vtkImporter::GetRenderer ( )

virtual

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

◆ GetSceneHierarchy()

virtual vtkDataAssembly * vtkImporter::GetSceneHierarchy ( )

virtual

Get the hierarchy of actors, cameras and lights in the renderer.

Implementations should strive to pack the hierarchy information from the file in to a vtkDataAssembly using node names from the file.

◆ GetImportedActors()

vtkActorCollection * vtkImporter::GetImportedActors ( )

inline

Get collection of actors, cameras and lights that were imported by this importer.

Note that this may return empty collections if not used in the concrete importer.

Definition at line 87 of file vtkImporter.h.

◆ GetImportedCameras()

vtkCollection * vtkImporter::GetImportedCameras ( )

inline

Get collection of actors, cameras and lights that were imported by this importer.

Note that this may return empty collections if not used in the concrete importer.

Definition at line 88 of file vtkImporter.h.

◆ GetImportedLights()

vtkLightCollection * vtkImporter::GetImportedLights ( )

inline

Get collection of actors, cameras and lights that were imported by this importer.

Note that this may return empty collections if not used in the concrete importer.

Definition at line 89 of file vtkImporter.h.

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

◆ Update()

bool vtkImporter::Update ( )

Import the actors, cameras, lights and properties into a vtkRenderWindow and return if it was successful of not.

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

◆ GetAnimationSupportLevel()

virtual AnimationSupportLevel vtkImporter::GetAnimationSupportLevel ( )

inlinevirtual

Get the level of animation support, this is coming either from the file format or as a limitation of the implementation.

NONE: There is no support for animation, GetNumberOfAnimations() return -1. UNIQUE: There will always will ever be, at most, a single animation, with any file, GetNumberOfAnimations() returns 0 or 1. SINGLE: There can be multiple available animations, but only one can be enable. Calling EnableAnimation(i) will disable other animations. MULTI: There can be multiple animations and multiple ones can be enabled at the same time. Calling EnableAnimation(i) will not disable other animation.

In this base implementation, this method returns NONE.

Reimplemented in vtkGLTFImporter.

Definition at line 138 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 animationIndex )

inlinevirtual

Get the name of an animation.

Return an empty if not provided by implementation.

Reimplemented in vtkGLTFImporter.

Definition at line 150 of file vtkImporter.h.

◆ EnableAnimation()

virtual void vtkImporter::EnableAnimation ( vtkIdType animationIndex )

inlinevirtual

Enable/Disable/Get the status of specific animations.

Reimplemented in vtkGLTFImporter.

Definition at line 156 of file vtkImporter.h.

◆ DisableAnimation()

virtual void vtkImporter::DisableAnimation ( vtkIdType animationIndex )

inlinevirtual

Enable/Disable/Get the status of specific animations.

Reimplemented in vtkGLTFImporter.

Definition at line 157 of file vtkImporter.h.

◆ IsAnimationEnabled()

virtual bool vtkImporter::IsAnimationEnabled ( vtkIdType animationIndex )

inlinevirtual

Enable/Disable/Get the status of specific animations.

Reimplemented in vtkGLTFImporter.

Definition at line 158 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 165 of file vtkImporter.h.

◆ GetCameraName()

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

inlinevirtual

Get the name of a camera.

Return an empty string if not provided by implementation.

Reimplemented in vtkGLTFImporter.

Definition at line 171 of file vtkImporter.h.

◆ SetCamera()

virtual void vtkImporter::SetCamera ( vtkIdType camIndex )

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.

Reimplemented in vtkGLTFImporter.

Definition at line 178 of file vtkImporter.h.

◆ GetTemporalInformation()

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

virtual

Get temporal information for the provided animationIndex and frameRate.

This implementation return false, but concrete class implementation behavior is as follows. frameRate is used to define the number of frames for one second of simulation, set to zero if timeSteps are not needed. If animation is present in the dataset, timeRange should be set by this method, return true. If animation is present and frameRate > 0, nbTimeSteps and timeSteps should also be set, return true. If animation is not present, return false.

Reimplemented in vtkGLTFImporter.

◆ UpdateAtTimeValue()

virtual bool vtkImporter::UpdateAtTimeValue ( double timeValue )

virtual

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

Returns if successful or not. If not reimplemented, only call Update() and return its output.

Reimplemented in vtkGLTFImporter.

◆ SetImportArmature()

virtual void vtkImporter::SetImportArmature ( bool )

virtual

Enable/Disable armature actors import if supported.

◆ GetImportArmature()

virtual bool vtkImporter::GetImportArmature ( )

virtual

Enable/Disable armature actors import if supported.

◆ ImportArmatureOn()

virtual void vtkImporter::ImportArmatureOn ( )

virtual

Enable/Disable armature actors import if supported.

◆ ImportArmatureOff()

virtual void vtkImporter::ImportArmatureOff ( )

virtual

Enable/Disable armature actors import if supported.

◆ ImportBegin()

virtual int vtkImporter::ImportBegin ( )

inlineprotectedvirtual

Reimplemented in vtk3DSImporter, vtkGLTFImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 213 of file vtkImporter.h.

◆ ImportEnd()

virtual void vtkImporter::ImportEnd ( )

inlineprotectedvirtual

Reimplemented in vtk3DSImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 214 of file vtkImporter.h.

◆ ImportActors()

virtual void vtkImporter::ImportActors ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 215 of file vtkImporter.h.

◆ ImportCameras()

virtual void vtkImporter::ImportCameras ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 216 of file vtkImporter.h.

◆ ImportLights()

virtual void vtkImporter::ImportLights ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 217 of file vtkImporter.h.

◆ ImportProperties()

virtual void vtkImporter::ImportProperties ( vtkRenderer * )

inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

Definition at line 218 of file vtkImporter.h.

◆ ReadData()

virtual void vtkImporter::ReadData ( )

protectedvirtual

Reimplemented in vtkOBJImporter.

◆ SetUpdateStatus()

void vtkImporter::SetUpdateStatus ( UpdateStatusEnum updateStatus )

inlineprotected

Set the update status.

Importer implementation should set this during Import if import fails for any reason. vtkImporter::Update set this to SUCCESS on call. Default is SUCCESS;

Definition at line 234 of file vtkImporter.h.

◆ GetUpdateStatus()

UpdateStatusEnum vtkImporter::GetUpdateStatus ( )

inlineprotected

Get the update status.

Definition at line 243 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

Member Data Documentation

◆ Renderer

vtkRenderer* vtkImporter::Renderer = nullptr

protected

Definition at line 248 of file vtkImporter.h.

◆ RenderWindow

vtkRenderWindow* vtkImporter::RenderWindow = nullptr

protected

Definition at line 249 of file vtkImporter.h.

◆ SceneHierarchy

vtkSmartPointer<vtkDataAssembly> vtkImporter::SceneHierarchy

protected

Definition at line 250 of file vtkImporter.h.

◆ ActorCollection

vtkNew<vtkActorCollection> vtkImporter::ActorCollection

protected

Definition at line 252 of file vtkImporter.h.

◆ CameraCollection

vtkNew<vtkCollection> vtkImporter::CameraCollection

protected

Definition at line 253 of file vtkImporter.h.

◆ LightCollection

vtkNew<vtkLightCollection> vtkImporter::LightCollection

protected

Definition at line 254 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 Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ AnimationSupportLevel

◆ UpdateStatusEnum

Constructor & Destructor Documentation

◆ vtkImporter()

◆ ~vtkImporter()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetRenderer()

◆ GetSceneHierarchy()

◆ GetImportedActors()

◆ GetImportedCameras()

◆ GetImportedLights()

◆ SetRenderWindow()

◆ GetRenderWindow()

◆ Update()

◆ GetOutputsDescription()

◆ GetAnimationSupportLevel()

◆ GetNumberOfAnimations()

◆ GetAnimationName()

◆ EnableAnimation()

◆ DisableAnimation()

◆ IsAnimationEnabled()

◆ GetNumberOfCameras()

◆ GetCameraName()

◆ SetCamera()

◆ GetTemporalInformation()

◆ UpdateAtTimeValue()

◆ SetImportArmature()

◆ GetImportArmature()

◆ ImportArmatureOn()

◆ ImportArmatureOff()

◆ ImportBegin()

◆ ImportEnd()

◆ ImportActors()

◆ ImportCameras()

◆ ImportLights()

◆ ImportProperties()

◆ ReadData()

◆ SetUpdateStatus()

◆ GetUpdateStatus()

◆ GetDataSetDescription()

◆ GetArrayDescription()

Member Data Documentation

◆ Renderer

◆ RenderWindow

◆ SceneHierarchy

◆ ActorCollection

◆ CameraCollection

◆ LightCollection