vtkXMLMaterialParser - Parses VTK Material file More...

Inheritance diagram for Kitware.VTK.vtkXMLMaterialParser:

Collaboration diagram for Kitware.VTK.vtkXMLMaterialParser:

Public Member Functions
	vtkXMLMaterialParser (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkXMLMaterialParser ()
	*Undocumented Block
virtual vtkXMLMaterial	GetMaterial ()
	Set/Get the vtkXMLMaterial representation of the parsed material.
override int	InitializeParser ()
	Overridden to clean up internal structures before the chunk-parsing begins.
override int	IsA (string type)
	*Undocumented Block
new vtkXMLMaterialParser	NewInstance ()
	*Undocumented Block
override int	Parse ()
	Overridden to initialize the internal structures before the parsing begins.
override int	Parse (string inputString)
	Overridden to initialize the internal structures before the parsing begins.
override int	Parse (string inputString, uint length)
	Overridden to initialize the internal structures before the parsing begins.
void	SetMaterial (vtkXMLMaterial arg0)
	Set/Get the vtkXMLMaterial representation of the parsed material.
Public Member Functions inherited from Kitware.VTK.vtkXMLParser
	vtkXMLParser (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
	Automatically generated constructor - called from generated code. DO NOT call directly.
	vtkXMLParser ()
	*Undocumented Block
virtual int	CleanupParser ()
	When parsing fragments of XML or streaming XML, use the following three methods. InitializeParser method initialize parser but does not perform any actual parsing. ParseChunk parses framgent of XML. This has to match to what was already parsed. CleanupParser finishes parsing. If there were errors, CleanupParser will report them.
virtual string	GetEncoding ()
	Set and get the encoding the parser should expect (NULL defaults to Expat's own default encoder, i.e UTF-8). This should be set before parsing (i.e. a call to Parse()) or even initializing the parser (i.e. a call to InitializeParser())
virtual string	GetFileName ()
	Set and get file name.
virtual int	GetIgnoreCharacterData ()
	If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. If this is on, the text will be ignored.
virtual int	ParseChunk (string inputString, uint length)
	When parsing fragments of XML or streaming XML, use the following three methods. InitializeParser method initialize parser but does not perform any actual parsing. ParseChunk parses framgent of XML. This has to match to what was already parsed. CleanupParser finishes parsing. If there were errors, CleanupParser will report them.
void	SeekG (int position)
	Used by subclasses and their supporting classes. These methods wrap around the tellg and seekg methods of the input stream to work-around stream bugs on various platforms.
virtual void	SetEncoding (string _arg)
	Set and get the encoding the parser should expect (NULL defaults to Expat's own default encoder, i.e UTF-8). This should be set before parsing (i.e. a call to Parse()) or even initializing the parser (i.e. a call to InitializeParser())
virtual void	SetFileName (string _arg)
	Set and get file name.
virtual void	SetIgnoreCharacterData (int _arg)
	If this is off (the default), CharacterDataHandler will be called to process text within XML Elements. If this is on, the text will be ignored.
int	TellG ()
	Used by subclasses and their supporting classes. These methods wrap around the tellg and seekg methods of the input stream to work-around stream bugs on various platforms.
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 vtkXMLMaterialParser	New ()
	*Undocumented Block
static new int	IsTypeOf (string type)
	*Undocumented Block
static new vtkXMLMaterialParser	SafeDownCast (vtkObjectBase o)
	*Undocumented Block

Public Attributes
new const string	MRFullTypeName = "Kitware.VTK.vtkXMLMaterialParser"
	Automatically generated type registration mechanics.
Public Attributes inherited from Kitware.VTK.vtkXMLParser
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 = "20vtkXMLMaterialParser"
	Automatically generated type registration mechanics.
Static Public Attributes inherited from Kitware.VTK.vtkXMLParser
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	vtkXMLMaterialParser ()
	Automatically generated type registration mechanics.

Detailed Description

vtkXMLMaterialParser - Parses VTK Material file

Description vtkXMLMaterialParser parses a VTK Material file and provides that file's description of a number of vertex and fragment shaders along with data values specified for data members of vtkProperty. This material is to be applied to an actor through it's vtkProperty and augments VTK's concept of a vtkProperty to include explicitly include vertex and fragment shaders and parameter settings for those shaders. This effectively makes reflectance models and other shaders a material property. If no shaders are specified VTK should default to standard rendering.

Design vtkXMLMaterialParser provides access to 3 distinct types of first-level vtkXMLDataElements that describe a VTK material. These elements are as follows:

vtkProperty - describe values for vtkProperty data members

vtkVertexShader - a vertex shader and enough information to install it into the hardware rendering pipeline including values for specific shader parameters and structures.

vtkFragmentShader - a fragment shader and enough information to install it into the hardware rendering pipeline including values for specific shader parameters and structures.

The design of the material file closely follows that of vtk's xml descriptions of it's data sets. This allows use of the very handy vtkXMLDataElement which provides easy access to an xml element's attribute values. Inlined data is currently not handled.

Ideally this class would be a Facade to a DOM parser, but VTK only provides access to expat, a SAX parser. Other vtk classes that parse xml files are tuned to read vtkDataSets and don't provide the functionality to handle generic xml data. As such they are of little use here.

This class may be extended for better data handling or may become a Facade to a DOM parser should on become part of the VTK code base. Thanks Shader support in VTK includes key contributions by Gary Templet at Sandia National Labs.

Constructor & Destructor Documentation

static Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser ( )

staticprivate

Automatically generated type registration mechanics.

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

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

Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser ( )

*Undocumented Block

Member Function Documentation

override void Kitware.VTK.vtkXMLMaterialParser.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.vtkXMLParser.

virtual vtkXMLMaterial Kitware.VTK.vtkXMLMaterialParser.GetMaterial ( )

virtual

Set/Get the vtkXMLMaterial representation of the parsed material.

Here is the call graph for this function:

override int Kitware.VTK.vtkXMLMaterialParser.InitializeParser ( )

virtual

Overridden to clean up internal structures before the chunk-parsing begins.

Reimplemented from Kitware.VTK.vtkXMLParser.

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

virtual

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

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

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

new vtkXMLMaterialParser Kitware.VTK.vtkXMLMaterialParser.NewInstance ( )

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

override int Kitware.VTK.vtkXMLMaterialParser.Parse ( )

virtual

Overridden to initialize the internal structures before the parsing begins.

Reimplemented from Kitware.VTK.vtkXMLParser.

override int Kitware.VTK.vtkXMLMaterialParser.Parse ( string inputString )

virtual

Overridden to initialize the internal structures before the parsing begins.

Reimplemented from Kitware.VTK.vtkXMLParser.

override int Kitware.VTK.vtkXMLMaterialParser.Parse	(	string	inputString,
		uint	length
	)

virtual

Overridden to initialize the internal structures before the parsing begins.

Reimplemented from Kitware.VTK.vtkXMLParser.

static new vtkXMLMaterialParser Kitware.VTK.vtkXMLMaterialParser.SafeDownCast ( vtkObjectBase o )

static

*Undocumented Block

Reimplemented from Kitware.VTK.vtkXMLParser.

Here is the call graph for this function:

void Kitware.VTK.vtkXMLMaterialParser.SetMaterial ( vtkXMLMaterial arg0 )

Set/Get the vtkXMLMaterial representation of the parsed material.

Member Data Documentation

new readonly string Kitware.VTK.vtkXMLMaterialParser.MRClassNameKey = "20vtkXMLMaterialParser"

static

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkXMLParser.

new const string Kitware.VTK.vtkXMLMaterialParser.MRFullTypeName = "Kitware.VTK.vtkXMLMaterialParser"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkXMLParser.

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

csharp/vtkXMLMaterialParser.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation