vtkVRMLImporter - imports VRML 2.0 files. More...

Inheritance diagram for Kitware.VTK.vtkVRMLImporter:

Collaboration diagram for Kitware.VTK.vtkVRMLImporter:

Public Member Functions
	vtkVRMLImporter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkVRMLImporter ()
	*Undocumented Block
virtual string	GetFileName ()
	Specify the name of the file to read.
vtkObject	GetVRMLDEFObject (string 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.
override int	IsA (string type)
	*Undocumented Block
new vtkVRMLImporter	NewInstance ()
	*Undocumented Block
virtual void	SetFileName (string _arg)
	Specify the name of the file to read.
void	enterField (string arg0)
	Needed by the yacc/lex grammar used.
void	enterNode (string arg0)
	Needed by the yacc/lex grammar used.
void	exitField ()
	Needed by the yacc/lex grammar used.
void	exitNode ()
	Needed by the yacc/lex grammar used.
void	useNode (string arg0)
	Needed by the yacc/lex grammar used.
Public Member Functions inherited from Kitware.VTK.vtkImporter
	vtkImporter (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
virtual vtkRenderWindow	GetRenderWindow ()
	Description 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.
virtual vtkRenderer	GetRenderer ()
	Description Get the renderer that contains the imported actors, cameras and lights.
void	Read ()
	Description Import the actors, cameras, lights and properties into a vtkRenderWindow.
virtual void	SetRenderWindow (vtkRenderWindow arg0)
	Description 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.
void	Update ()
	Description Import the actors, cameras, lights and properties into a vtkRenderWindow.
Public Member Functions inherited from Kitware.VTK.vtkObject
	vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObject ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
uint	AddObserver (uint arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
uint	AddObserver (string arg0, vtkCommand arg1, float priority)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	DebugOff ()
	Turn debugging output off.
virtual void	DebugOn ()
	Turn debugging output on.
vtkCommand	GetCommand (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
byte	GetDebug ()
	Get the value of the debug flag.
virtual uint	GetMTime ()
	Return this object's modified time.
int	HasObserver (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	HasObserver (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0, IntPtr callData)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
int	InvokeEvent (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
virtual void	Modified ()
	Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer.
void	RemoveAllObservers ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (vtkCommand arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObserver (uint tag)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0, vtkCommand arg1)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (uint arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	RemoveObservers (string arg0)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
void	SetDebug (byte debugFlag)
	Set the value of the debug flag. A non-zero value turns debugging on.
override string	ToString ()
	Returns the result of calling vtkObject::Print as a C# string.
delegate void	vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e)
	Generic signature for all vtkObject events.
void	RemoveAllHandlersForAllEvents ()
	Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen...
Public Member Functions inherited from Kitware.VTK.vtkObjectBase
	vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkObjectBase ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
virtual void	Register (vtkObjectBase o)
	Increase the reference count (mark as used by another object).
virtual void	FastDelete ()
	Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done.
string	GetClassName ()
	Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h.
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int arg0)
	Sets the reference count. (This is very dangerous, use with care.)

Static Public Member Functions
static new vtkVRMLImporter	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkVRMLImporter	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkVRMLImporter"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkImporter
Public Attributes inherited from Kitware.VTK.vtkObject
Public Attributes inherited from Kitware.VTK.vtkObjectBase
Public Attributes inherited from Kitware.VTK.WrappedObject
const string	vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so"
	Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable.
const string	vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so"
	Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable.
const string	vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so"
	Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so"
	Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable.
const string	vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so"
	Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable.
const string	vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so"
	Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable.
const string	vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so"
	Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable.
const string	vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so"
	Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable.
const string	vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so"
	Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable.
const string	vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so"
	Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable.
const string	vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so"
	Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable.
const string	vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so"
	Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable.
const string	vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so"
	Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable.
const string	vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so"
	Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable.
const string	vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so"
	Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable.

Static Public Attributes
static new readonly string	MRClassNameKey = "15vtkVRMLImporter"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkImporter
Static Public Attributes inherited from Kitware.VTK.vtkObject
Static Public Attributes inherited from Kitware.VTK.vtkObjectBase

Protected Member Functions
override void	Dispose (bool disposing)
	Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Static Private Member Functions
static	vtkVRMLImporter ()
	Automatically generated type registration mechanics.

Detailed Description

vtkVRMLImporter - imports VRML 2.0 files.

Description

vtkVRMLImporter imports VRML 2.0 files into vtk. Caveats

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.

vtkImporter

Constructor & Destructor Documentation

static Kitware.VTK.vtkVRMLImporter.vtkVRMLImporter ( )

staticprivate

Automatically generated type registration mechanics.

Kitware.VTK.vtkVRMLImporter.vtkVRMLImporter	(	IntPtr	rawCppThis,
		bool	callDisposalMethod,
		bool	strong
	)

Automatically generated constructor - called from generated code. DO NOT call directly.

Kitware.VTK.vtkVRMLImporter.vtkVRMLImporter ( )

*Undocumented Block

Member Function Documentation

override void Kitware.VTK.vtkVRMLImporter.Dispose ( bool disposing )

protected

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkImporter.

void Kitware.VTK.vtkVRMLImporter.enterField ( string arg0 )

Needed by the yacc/lex grammar used.

void Kitware.VTK.vtkVRMLImporter.enterNode ( string arg0 )

Needed by the yacc/lex grammar used.

void Kitware.VTK.vtkVRMLImporter.exitField ( )

Needed by the yacc/lex grammar used.

void Kitware.VTK.vtkVRMLImporter.exitNode ( )

Needed by the yacc/lex grammar used.

virtual string Kitware.VTK.vtkVRMLImporter.GetFileName ( )

virtual

Specify the name of the file to read.

vtkObject Kitware.VTK.vtkVRMLImporter.GetVRMLDEFObject ( string 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.

Here is the call graph for this function:

override int Kitware.VTK.vtkVRMLImporter.IsA ( string type )

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImporter.

static new int Kitware.VTK.vtkVRMLImporter.IsTypeOf ( string type )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkImporter.

static new vtkVRMLImporter Kitware.VTK.vtkVRMLImporter.New ( )

static

*Undocumented Block