vtkVRMLImporter Class Reference

#include <vtkVRMLImporter.h>

Inheritance diagram for vtkVRMLImporter:

Inheritance graph
[legend]
Collaboration diagram for vtkVRMLImporter:

Collaboration graph
[legend]

List of all members.


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 (Tcl, 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).

Thanks:
Thanks to Russ Coucher of Areva for numerous bug fixes and a new test.
See also:
vtkImporter
Tests:
vtkVRMLImporter (Tests)

Definition at line 73 of file vtkVRMLImporter.h.


Public Types

typedef vtkImporter Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
vtkObjectGetVRMLDEFObject (const char *name)
FILE * GetFileFD ()
void enterNode (const char *)
void exitNode ()
void enterField (const char *)
void exitField ()
void useNode (const char *)
virtual void SetFileName (const char *)
virtual char * GetFileName ()

Static Public Member Functions

static vtkVRMLImporterNew ()
static int IsTypeOf (const char *type)
static vtkVRMLImporterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkVRMLImporter ()
 ~vtkVRMLImporter ()
virtual int ImportBegin ()
virtual void ImportEnd ()
virtual void ImportActors (vtkRenderer *)
virtual void ImportCameras (vtkRenderer *)
virtual void ImportLights (vtkRenderer *)
virtual void ImportProperties (vtkRenderer *)
int OpenImportFile ()

Protected Attributes

char * FileName
FILE * FileFD

Friends

int yylex (vtkVRMLImporter *)

Member Typedef Documentation

Reimplemented from vtkImporter.

Definition at line 78 of file vtkVRMLImporter.h.


Constructor & Destructor Documentation

vtkVRMLImporter::vtkVRMLImporter (  )  [protected]

vtkVRMLImporter::~vtkVRMLImporter (  )  [protected]


Member Function Documentation

static vtkVRMLImporter* vtkVRMLImporter::New (  )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkVRMLImporter::GetClassName (  )  [virtual]

Reimplemented from vtkImporter.

static int vtkVRMLImporter::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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.

virtual int 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.

static vtkVRMLImporter* vtkVRMLImporter::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkImporter.

void vtkVRMLImporter::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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.

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.

void vtkVRMLImporter::enterNode ( const char *   ) 

Needed by the yacc/lex grammar used

void vtkVRMLImporter::exitNode (  ) 

Needed by the yacc/lex grammar used

void vtkVRMLImporter::enterField ( const char *   ) 

Needed by the yacc/lex grammar used

void vtkVRMLImporter::exitField (  ) 

Needed by the yacc/lex grammar used

void vtkVRMLImporter::useNode ( const char *   ) 

Needed by the yacc/lex grammar used

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

Specify the name of the file to read.

virtual char* vtkVRMLImporter::GetFileName (  )  [virtual]

Specify the name of the file to read.

FILE* vtkVRMLImporter::GetFileFD (  )  [inline]

Return the file pointer to the open file.

Definition at line 104 of file vtkVRMLImporter.h.

virtual int vtkVRMLImporter::ImportBegin (  )  [protected, virtual]

Reimplemented from vtkImporter.

virtual void vtkVRMLImporter::ImportEnd (  )  [protected, virtual]

Reimplemented from vtkImporter.

virtual void vtkVRMLImporter::ImportActors ( vtkRenderer  )  [inline, protected, virtual]

Reimplemented from vtkImporter.

Definition at line 118 of file vtkVRMLImporter.h.

virtual void vtkVRMLImporter::ImportCameras ( vtkRenderer  )  [inline, protected, virtual]

Reimplemented from vtkImporter.

Definition at line 119 of file vtkVRMLImporter.h.

virtual void vtkVRMLImporter::ImportLights ( vtkRenderer  )  [inline, protected, virtual]

Reimplemented from vtkImporter.

Definition at line 120 of file vtkVRMLImporter.h.

virtual void vtkVRMLImporter::ImportProperties ( vtkRenderer  )  [inline, protected, virtual]

Reimplemented from vtkImporter.

Definition at line 121 of file vtkVRMLImporter.h.

int vtkVRMLImporter::OpenImportFile (  )  [protected]


Friends And Related Function Documentation

int yylex ( vtkVRMLImporter  )  [friend]


Member Data Documentation

char* vtkVRMLImporter::FileName [protected]

Definition at line 124 of file vtkVRMLImporter.h.

FILE* vtkVRMLImporter::FileFD [protected]

Definition at line 125 of file vtkVRMLImporter.h.


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

Generated on Mon Sep 27 19:01:13 2010 for VTK by  doxygen 1.5.6