imports VRML 2.0 files. More...

#include <vtkVRMLImporter.h>

Inheritance diagram for vtkVRMLImporter:

Collaboration diagram for vtkVRMLImporter:

Public Types
typedef vtkImporter	Superclass

Public Types inherited from vtkImporter
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...

vtkVRMLImporter *	NewInstance () const

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

vtkObject *	GetVRMLDEFObject (const char *name)
	In the VRML spec you can DEF and USE nodes (name them), This routine will return the associated VTK object which was created as a result of the DEF mechanism Send in the name from the VRML file, get the VTK object. More...

std::string	GetOutputsDescription () override
	Get a printable string describing the outputs. More...


	vtkSetFilePathMacro (FileName)
	Specify the name of the file to read. More...

	vtkGetFilePathMacro (FileName)
	Specify the name of the file to read. More...


virtual void	SetShapeResolution (int)
	Specify the resolution for Sphere, Cone and Cylinder shape sources. More...

virtual int	GetShapeResolution ()
	Specify the resolution for Sphere, Cone and Cylinder shape sources. More...

Public Member Functions inherited from vtkImporter
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 vtkVRMLImporter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkVRMLImporter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkImporter
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

	vtkVRMLImporter ()

	~vtkVRMLImporter () override

int	OpenImportFile ()

int	ImportBegin () override

void	ImportEnd () override

void	ImportActors (vtkRenderer *) override

void	ImportCameras (vtkRenderer *) override

void	ImportLights (vtkRenderer *) override

void	ImportProperties (vtkRenderer *) override

FILE *	GetFileFD ()
	Return the file pointer to the open file. More...


virtual void	enterNode (const char *)
	Needed by the yacc/lex grammar used. More...

virtual void	exitNode ()
	Needed by the yacc/lex grammar used. More...

virtual void	enterField (const char *)
	Needed by the yacc/lex grammar used. More...

virtual void	exitField ()
	Needed by the yacc/lex grammar used. More...

virtual void	useNode (const char *)
	Needed by the yacc/lex grammar used. More...

Protected Member Functions inherited from vtkImporter
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 &)

Protected Attributes
char *	FileName

FILE *	FileFD

int	ShapeResolution

Protected Attributes inherited from vtkImporter
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

Friends
class	vtkVRMLYaccData

Additional Inherited Members
Static Protected Member Functions inherited from vtkImporter
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 ()

Detailed Description

imports VRML 2.0 files.

vtkVRMLImporter imports VRML 2.0 files into VTK.

Warning: These nodes are currently supported: Appearance IndexedFaceSet Box IndexedLineSet Color Material Cone Shape Coordinate Sphere Cylinder Transform DirectionalLight; As you can see this implementation focuses on getting the geometry translated. The routes and scripting nodes are ignored since they deal with directly accessing a nodes internal structure based on the VRML spec. Since this is a translation the internal data structures differ greatly from the VRML spec and the External Authoring Interface (see the VRML spec). The DEF/USE mechanism does allow the VTK user to extract objects from the scene and directly manipulate them using the native language (Python, Java, or whatever language VTK is wrapped in). This, in a way, removes the need for the route and script mechanism (not completely though). Texture coordinates are attached to the mesh is available but image textures are not loaded. Viewpoints (camera presets) are not imported.

Thanks:: Thanks to Russ Coucher of Areva for numerous bug fixes and a new test.

See also: vtkImporter

Online Examples:

CombineImportedActors

FireFlow

FireFlowDemo

Definition at line 153 of file vtkVRMLImporter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkImporter vtkVRMLImporter::Superclass

Definition at line 158 of file vtkVRMLImporter.h.

Constructor & Destructor Documentation

◆ vtkVRMLImporter()

vtkVRMLImporter::vtkVRMLImporter ( )

protected

◆ ~vtkVRMLImporter()

vtkVRMLImporter::~vtkVRMLImporter ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkVRMLImporter * vtkVRMLImporter::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkVRMLImporter::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 vtkImporter.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkVRMLImporter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImporter.

◆ NewInstance()

vtkVRMLImporter * vtkVRMLImporter::NewInstance ( ) const

◆ PrintSelf()

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

◆ vtkSetFilePathMacro()

vtkVRMLImporter::vtkSetFilePathMacro ( FileName )

Specify the name of the file to read.

◆ vtkGetFilePathMacro()

vtkVRMLImporter::vtkGetFilePathMacro ( FileName )

Specify the name of the file to read.

◆ SetShapeResolution()

virtual void vtkVRMLImporter::SetShapeResolution ( int )

virtual

Specify the resolution for Sphere, Cone and Cylinder shape sources.

Default is 12.

◆ GetShapeResolution()

virtual int vtkVRMLImporter::GetShapeResolution ( )

virtual

Specify the resolution for Sphere, Cone and Cylinder shape sources.

Default is 12.

◆ GetVRMLDEFObject()

vtkObject * vtkVRMLImporter::GetVRMLDEFObject ( const char * name )

In the VRML spec you can DEF and USE nodes (name them), This routine will return the associated VTK object which was created as a result of the DEF mechanism Send in the name from the VRML file, get the VTK object.

You will have to check and correctly cast the object since this only returns vtkObjects.

◆ GetOutputsDescription()

std::string vtkVRMLImporter::GetOutputsDescription ( )

overridevirtual

Get a printable string describing the outputs.

Reimplemented from vtkImporter.

◆ OpenImportFile()

int vtkVRMLImporter::OpenImportFile ( )

protected

◆ ImportBegin()

int vtkVRMLImporter::ImportBegin ( )

overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportEnd()

void vtkVRMLImporter::ImportEnd ( )

overrideprotectedvirtual

Reimplemented from vtkImporter.

◆ ImportActors()

void vtkVRMLImporter::ImportActors ( vtkRenderer * )

inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 200 of file vtkVRMLImporter.h.

◆ ImportCameras()

void vtkVRMLImporter::ImportCameras ( vtkRenderer * )

inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 201 of file vtkVRMLImporter.h.

◆ ImportLights()

void vtkVRMLImporter::ImportLights ( vtkRenderer * )

inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 202 of file vtkVRMLImporter.h.

◆ ImportProperties()

void vtkVRMLImporter::ImportProperties ( vtkRenderer * )

inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 203 of file vtkVRMLImporter.h.