VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkVRMLImporter Class Reference

imports VRML 2.0 files. More...

#include <vtkVRMLImporter.h>

Inheritance diagram for vtkVRMLImporter:
[legend]
Collaboration diagram for vtkVRMLImporter:
[legend]

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...
 
vtkVRMLImporterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetFileName (const char *)
 Specify the name of the file to read. More...
 
virtual char * GetFileName ()
 
virtual void SetShapeResolution (int)
 Specify the resolution for Sphere, Cone and Cylinder shape sources. More...
 
virtual int GetShapeResolution ()
 
vtkObjectGetVRMLDEFObject (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...
 
- Public Member Functions inherited from vtkImporter
vtkImporterNewInstance () const
 
virtual vtkRendererGetRenderer ()
 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 vtkRenderWindowGetRenderWindow ()
 
void Read ()
 Import the actors, cameras, lights and properties into a vtkRenderWindow. More...
 
void Update ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkVRMLImporterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVRMLImporterSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkImporter
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. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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
 
virtual void enterNode (const char *)
 Needed by the yacc/lex grammar used. More...
 
virtual void exitNode ()
 
virtual void enterField (const char *)
 
virtual void exitField ()
 
virtual void useNode (const char *)
 
FILE * GetFileFD ()
 Return the file pointer to the open file. More...
 
- Protected Member Functions inherited from vtkImporter
 vtkImporter ()
 
 ~vtkImporter () override
 
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 ()
 
- 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

char * FileName
 
FILE * FileFD
 
int ShapeResolution
 
- Protected Attributes inherited from vtkImporter
vtkRendererRenderer
 
vtkRenderWindowRenderWindow
 
- 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
 

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

Definition at line 74 of file vtkVRMLImporter.h.

Member Typedef Documentation

◆ Superclass

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

◆ SetFileName()

virtual void vtkVRMLImporter::SetFileName ( const char *  )
virtual

Specify the name of the file to read.

◆ GetFileName()

virtual char* vtkVRMLImporter::GetFileName ( )
virtual

◆ 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

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

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

◆ ImportCameras()

void vtkVRMLImporter::ImportCameras ( vtkRenderer )
inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 117 of file vtkVRMLImporter.h.

◆ ImportLights()

void vtkVRMLImporter::ImportLights ( vtkRenderer )
inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 118 of file vtkVRMLImporter.h.

◆ ImportProperties()

void vtkVRMLImporter::ImportProperties ( vtkRenderer )
inlineoverrideprotectedvirtual

Reimplemented from vtkImporter.

Definition at line 119 of file vtkVRMLImporter.h.

◆ enterNode()

virtual void vtkVRMLImporter::enterNode ( const char *  )
protectedvirtual

Needed by the yacc/lex grammar used.

◆ exitNode()

virtual void vtkVRMLImporter::exitNode ( )
protectedvirtual

◆ enterField()

virtual void vtkVRMLImporter::enterField ( const char *  )
protectedvirtual

◆ exitField()

virtual void vtkVRMLImporter::exitField ( )
protectedvirtual

◆ useNode()

virtual void vtkVRMLImporter::useNode ( const char *  )
protectedvirtual

◆ GetFileFD()

FILE* vtkVRMLImporter::GetFileFD ( )
inlineprotected

Return the file pointer to the open file.

Definition at line 135 of file vtkVRMLImporter.h.

Friends And Related Function Documentation

◆ vtkVRMLYaccData

friend class vtkVRMLYaccData
friend

Definition at line 141 of file vtkVRMLImporter.h.

Member Data Documentation

◆ FileName

char* vtkVRMLImporter::FileName
protected

Definition at line 137 of file vtkVRMLImporter.h.

◆ FileFD

FILE* vtkVRMLImporter::FileFD
protected

Definition at line 138 of file vtkVRMLImporter.h.

◆ ShapeResolution

int vtkVRMLImporter::ShapeResolution
protected

Definition at line 139 of file vtkVRMLImporter.h.


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