ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkXMLMaterialParser Class Reference

vtkXMLMaterialParser - Parses VTK Material file More...

Inheritance diagram for Kitware.VTK.vtkXMLMaterialParser:
[legend]
Collaboration diagram for Kitware.VTK.vtkXMLMaterialParser:
[legend]

List of all members.

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.

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.

Static Public Attributes

static new readonly string MRClassNameKey = "20vtkXMLMaterialParser"
 Automatically generated type registration mechanics.

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.

Private Member Functions

static internal IntPtr vtkXMLMaterialParser_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal IntPtr vtkXMLMaterialParser_GetMaterial_01 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkXMLMaterialParser_InitializeParser_02 (HandleRef pThis)
static internal int vtkXMLMaterialParser_IsA_03 (HandleRef pThis, string type)
static internal int vtkXMLMaterialParser_IsTypeOf_04 (string type)
static internal IntPtr vtkXMLMaterialParser_NewInstance_06 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal int vtkXMLMaterialParser_Parse_07 (HandleRef pThis)
static internal int vtkXMLMaterialParser_Parse_08 (HandleRef pThis, string inputString)
static internal int vtkXMLMaterialParser_Parse_09 (HandleRef pThis, string inputString, uint length)
static internal IntPtr vtkXMLMaterialParser_SafeDownCast_10 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkXMLMaterialParser_SetMaterial_11 (HandleRef pThis, HandleRef arg0)

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

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.

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.

Set/Get the vtkXMLMaterial representation of the parsed material.

Here is the call graph for this function:

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkXMLParser.

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.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkXMLParser.

Here is the call graph for this function:

Set/Get the vtkXMLMaterial representation of the parsed material.

static internal IntPtr Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_GetMaterial_01 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_InitializeParser_02 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_IsA_03 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_IsTypeOf_04 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_NewInstance_06 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal int Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_Parse_07 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_Parse_08 ( HandleRef  pThis,
string  inputString 
) [private]
static internal int Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_Parse_09 ( HandleRef  pThis,
string  inputString,
uint  length 
) [private]
static internal IntPtr Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_SafeDownCast_10 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkXMLMaterialParser.vtkXMLMaterialParser_SetMaterial_11 ( HandleRef  pThis,
HandleRef  arg0 
) [private]

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: