VTK  9.3.20240718
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Static 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.
 
vtkImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
VTK_UNBLOCKTHREADS bool Update ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow and return if it was sucessful of not.
 
void Read ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow.
 
virtual std::string GetOutputsDescription ()
 Recover a printable string that let importer implementation Describe their outputs.
 
virtual vtkIdType GetNumberOfAnimations ()
 Get the number of available animations.
 
virtual std::string GetAnimationName (vtkIdType vtkNotUsed(animationIndex))
 Get the name of an animation.
 
virtual vtkIdType GetNumberOfCameras ()
 Get the number of available cameras.
 
virtual std::string GetCameraName (vtkIdType vtkNotUsed(camIndex))
 Get the name of a camera.
 
virtual void SetCamera (vtkIdType vtkNotUsed(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 void UpdateTimeStep (double timeValue)
 Import the actors, camera, lights and properties at a specific time value.
 
virtual bool UpdateAtTimeValue (double timeValue)
 Import the actors, camera, lights and properties at a specific time value.
 
virtual vtkRendererGetRenderer ()
 Get the renderer that contains the imported actors, cameras and lights.
 
virtual vtkDataAssemblyGetSceneHierarchy ()
 Get the hierarchy of actors, cameras and lights in the renderer.
 
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 vtkRenderWindowGetRenderWindow ()
 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 vtkNotUsed(animationIndex))
 Enable/Disable/Get the status of specific animations.
 
virtual void DisableAnimation (vtkIdType vtkNotUsed(animationIndex))
 Enable/Disable/Get the status of specific animations.
 
virtual bool IsAnimationEnabled (vtkIdType vtkNotUsed(animationIndex))
 Enable/Disable/Get the status of specific animations.
 
- 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.
 
vtkCommandGetCommand (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 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkImporter ()=default
 
 ~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

vtkRendererRenderer = nullptr
 
vtkRenderWindowRenderWindow = nullptr
 
vtkSmartPointer< vtkDataAssemblySceneHierarchy
 
- 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

Definition at line 51 of file vtkImporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 54 of file vtkImporter.h.

Member Enumeration Documentation

◆ UpdateStatusEnum

enum class vtkImporter::UpdateStatusEnum : bool
strongprotected
Enumerator
SUCCESS 
FAILURE 

Definition at line 184 of file vtkImporter.h.

Constructor & Destructor Documentation

◆ vtkImporter()

vtkImporter::vtkImporter ( )
protecteddefault

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

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

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

VTK_UNBLOCKTHREADS bool vtkImporter::Update ( )

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

◆ Read()

void vtkImporter::Read ( )
inline

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

Definition at line 98 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 104 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 116 of file vtkImporter.h.

◆ EnableAnimation()

virtual void vtkImporter::EnableAnimation ( vtkIdType   vtkNotUsedanimationIndex)
inlinevirtual

Enable/Disable/Get the status of specific animations.

Definition at line 122 of file vtkImporter.h.

◆ DisableAnimation()

virtual void vtkImporter::DisableAnimation ( vtkIdType   vtkNotUsedanimationIndex)
inlinevirtual

Enable/Disable/Get the status of specific animations.

Definition at line 123 of file vtkImporter.h.

◆ IsAnimationEnabled()

virtual bool vtkImporter::IsAnimationEnabled ( vtkIdType   vtkNotUsedanimationIndex)
inlinevirtual

Enable/Disable/Get the status of specific animations.

Definition at line 124 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 131 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 137 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 144 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.

◆ UpdateTimeStep()

virtual void vtkImporter::UpdateTimeStep ( double  timeValue)
virtual

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

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

◆ ImportBegin()

virtual int vtkImporter::ImportBegin ( )
inlineprotectedvirtual

Reimplemented in vtk3DSImporter, vtkGLTFImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 176 of file vtkImporter.h.

◆ ImportEnd()

virtual void vtkImporter::ImportEnd ( )
inlineprotectedvirtual

Reimplemented in vtk3DSImporter, vtkOBJImporter, and vtkVRMLImporter.

Definition at line 177 of file vtkImporter.h.

◆ ImportActors()

virtual void vtkImporter::ImportActors ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 178 of file vtkImporter.h.

◆ ImportCameras()

virtual void vtkImporter::ImportCameras ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 179 of file vtkImporter.h.

◆ ImportLights()

virtual void vtkImporter::ImportLights ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, vtk3DSImporter, and vtkGLTFImporter.

Definition at line 180 of file vtkImporter.h.

◆ ImportProperties()

virtual void vtkImporter::ImportProperties ( vtkRenderer )
inlineprotectedvirtual

Reimplemented in vtkVRMLImporter, and vtk3DSImporter.

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

◆ GetUpdateStatus()

UpdateStatusEnum vtkImporter::GetUpdateStatus ( )
inlineprotected

Get the update status.

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

◆ RenderWindow

vtkRenderWindow* vtkImporter::RenderWindow = nullptr
protected

Definition at line 212 of file vtkImporter.h.

◆ SceneHierarchy

vtkSmartPointer<vtkDataAssembly> vtkImporter::SceneHierarchy
protected

Definition at line 213 of file vtkImporter.h.


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