An interface to access VTK Importers from ParaView server manager. More...

#include <vtkMetaImporter.h>

Inheritance diagram for vtkMetaImporter:

Collaboration diagram for vtkMetaImporter:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	UpdateInformation ()
	Imports the scene and populates scene hierarchy as well as scene description. More...

virtual int	GetAssemblyTag ()
	Whenever the assembly is changed, this tag gets changed. More...


void	SetFileName (const char *filename)
	Set/Get the file name. More...

const char *	GetFileName ()
	Set/Get the file name. More...


vtkDataAssembly *	GetAssembly ()
	The hierarchy of actors in the renderer is encoded in a vtkDataAssembly. More...


virtual void	SetActiveAssembly (const char *)
	Get/Set the name of the assembly to use for mapping block visibilities, colors and opacities. More...

virtual char *	GetActiveAssembly ()
	Get/Set the name of the assembly to use for mapping block visibilities, colors and opacities. More...


void	AddNodeSelector (const char *selector)
	Update list of selectors that determine the selected nodes. More...

void	RemoveAllNodeSelectors ()
	Update list of selectors that determine the selected nodes. More...

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

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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 )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

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)

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)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkMetaImporter *	New ()

static int	IsTypeOf (const char *type)

static vtkMetaImporter *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkMetaImporter ()

	~vtkMetaImporter () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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
int	AssemblyTag = 0

char *	ActiveAssembly = nullptr

std::string	FileName

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

using	PayloadType = vtkAOSDataArrayTemplate< vtkTypeUInt8 >
	The scene description i.e, material, texture, transformation matrices for actors, cameras and lights is serialized to JSON and transformed into CBOR (Consise Binary Object Representation) stored in a vtkTypeUInt8Array for easier transmission across the network. More...

vtkVariant	GetSerializedSceneDescription ()
	The scene description i.e, material, texture, transformation matrices for actors, cameras and lights is serialized to JSON and transformed into CBOR (Consise Binary Object Representation) stored in a vtkTypeUInt8Array for easier transmission across the network. More...

Detailed Description

An interface to access VTK Importers from ParaView server manager.

This class creates the correct vtkImporter subclass based on the file extension. It provides common metadata like scene hierarchy and a description of the scene. The metadata is accessible after calling UpdatePipelineInformation.

Definition at line 28 of file vtkMetaImporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkMetaImporter::Superclass

Definition at line 32 of file vtkMetaImporter.h.

◆ PayloadType

using vtkMetaImporter::PayloadType = vtkAOSDataArrayTemplate<vtkTypeUInt8>

The scene description i.e, material, texture, transformation matrices for actors, cameras and lights is serialized to JSON and transformed into CBOR (Consise Binary Object Representation) stored in a vtkTypeUInt8Array for easier transmission across the network.

Definition at line 55 of file vtkMetaImporter.h.

Constructor & Destructor Documentation

◆ vtkMetaImporter()

vtkMetaImporter::vtkMetaImporter ( )

protected

◆ ~vtkMetaImporter()

vtkMetaImporter::~vtkMetaImporter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkMetaImporter* vtkMetaImporter::New ( )

static

◆ GetClassName()

virtual const char* vtkMetaImporter::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

virtual int vtkMetaImporter::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkMetaImporter* vtkMetaImporter::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkMetaImporter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ SetFileName()

void vtkMetaImporter::SetFileName ( const char * filename )

Set/Get the file name.

◆ GetFileName()

const char* vtkMetaImporter::GetFileName ( )

Set/Get the file name.

◆ UpdateInformation()

void vtkMetaImporter::UpdateInformation ( )

Imports the scene and populates scene hierarchy as well as scene description.

◆ GetSerializedSceneDescription()

vtkVariant vtkMetaImporter::GetSerializedSceneDescription ( )

The scene description i.e, material, texture, transformation matrices for actors, cameras and lights is serialized to JSON and transformed into CBOR (Consise Binary Object Representation) stored in a vtkTypeUInt8Array for easier transmission across the network.

◆ GetAssembly()

vtkDataAssembly* vtkMetaImporter::GetAssembly ( )

The hierarchy of actors in the renderer is encoded in a vtkDataAssembly.

◆ SetActiveAssembly()

virtual void vtkMetaImporter::SetActiveAssembly ( const char * )

virtual

Get/Set the name of the assembly to use for mapping block visibilities, colors and opacities.

The default is Hierarchy.

◆ GetActiveAssembly()

virtual char* vtkMetaImporter::GetActiveAssembly ( )

virtual

Get/Set the name of the assembly to use for mapping block visibilities, colors and opacities.

The default is Hierarchy.

◆ GetAssemblyTag()

virtual int vtkMetaImporter::GetAssemblyTag ( )

virtual

Whenever the assembly is changed, this tag gets changed.

Note, users should not assume that this is monotonically increasing but instead simply rely on its value to determine if the assembly may have changed since last time.

It is set to 0 whenever there's no valid assembly available.

◆ AddNodeSelector()

void vtkMetaImporter::AddNodeSelector ( const char * selector )

Update list of selectors that determine the selected nodes.

◆ RemoveAllNodeSelectors()

void vtkMetaImporter::RemoveAllNodeSelectors ( )

Update list of selectors that determine the selected nodes.

Member Data Documentation

◆ AssemblyTag

int vtkMetaImporter::AssemblyTag = 0

protected

Definition at line 98 of file vtkMetaImporter.h.

◆ ActiveAssembly

char* vtkMetaImporter::ActiveAssembly = nullptr

protected

Definition at line 99 of file vtkMetaImporter.h.

◆ FileName

std::string vtkMetaImporter::FileName

protected

Definition at line 100 of file vtkMetaImporter.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/IOImport/vtkMetaImporter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ PayloadType

Constructor & Destructor Documentation

◆ vtkMetaImporter()

◆ ~vtkMetaImporter()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetFileName()

◆ GetFileName()

◆ UpdateInformation()

◆ GetSerializedSceneDescription()

◆ GetAssembly()

◆ SetActiveAssembly()

◆ GetActiveAssembly()

◆ GetAssemblyTag()

◆ AddNodeSelector()

◆ RemoveAllNodeSelectors()

Member Data Documentation

◆ AssemblyTag

◆ ActiveAssembly

◆ FileName