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

Provide access to elements in Material files. More...

#include <vtkXMLMaterialReader.h>

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

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void ReadMaterial ()
 
virtual void SetFileName (const char *)
 
virtual char * GetFileName ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkXMLMaterialReaderSafeDownCast (vtkObject *o)
 
static vtkXMLMaterialReaderNew ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual void CreateXMLParser ()
 
virtual void DestroyXMLParser ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

char * FileName
 
vtkXMLMaterialParserXMLParser
 
vtkTimeStamp ParseTime
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
vtkXMLMaterialGetMaterial ()
 
 vtkXMLMaterialReader ()
 
 ~vtkXMLMaterialReader ()
 

Detailed Description

Provide access to elements in Material files.

vtkXMLMaterialReader provides access to three types of vtkXMLDataElement found in XML Material Files. This class sorts them by type and integer id from 0-N for N elements of a specific type starting with the first instance found.

Design:
This class is basically a Facade for vtkXMLMaterialParser. Currently functionality is to only provide access to vtkXMLDataElements but further extensions may return higher level data structures.
Design:
Having both an vtkXMLMaterialParser and a vtkXMLMaterialReader is consistent with VTK's design for handling xml file and provides for future flexibility, that is better data handlers and interfacing with a DOM xml parser.
Design:
vtkProperty - defines values for some or all data members of vtkProperty
Design:
vtkVertexShader - defines vertex shaders
Design:
vtkFragmentShader - defines fragment shaders
Thanks:
Shader support in VTK includes key contributions by Gary Templet at Sandia National Labs.

Definition at line 56 of file vtkXMLMaterialReader.h.

Member Typedef Documentation

Definition at line 59 of file vtkXMLMaterialReader.h.

Constructor & Destructor Documentation

vtkXMLMaterialReader::vtkXMLMaterialReader ( )
protected

Get the Material representation read by the reader.

vtkXMLMaterialReader::~vtkXMLMaterialReader ( )
protected

Get the Material representation read by the reader.

Member Function Documentation

virtual const char* vtkXMLMaterialReader::GetClassName ( )
virtual

Reimplemented from vtkObject.

static int vtkXMLMaterialReader::IsTypeOf ( const char *  type)
static
virtual int vtkXMLMaterialReader::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 vtkObject.

static vtkXMLMaterialReader* vtkXMLMaterialReader::SafeDownCast ( vtkObject o)
static
void vtkXMLMaterialReader::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 vtkObject.

static vtkXMLMaterialReader* vtkXMLMaterialReader::New ( )
static
virtual void vtkXMLMaterialReader::SetFileName ( const char *  )
virtual

Set and get file name.

virtual char* vtkXMLMaterialReader::GetFileName ( )
virtual

Set and get file name.

void vtkXMLMaterialReader::ReadMaterial ( )

Read the material file refered to in FileName. If the Reader hasn't changed since the last ReadMaterial(), it does not read the file again.

vtkXMLMaterial* vtkXMLMaterialReader::GetMaterial ( )

Get the Material representation read by the reader.

virtual void vtkXMLMaterialReader::CreateXMLParser ( )
protectedvirtual

Create and vtkXMLParser to read the file

virtual void vtkXMLMaterialReader::DestroyXMLParser ( )
protectedvirtual

Destroys the vtkXMLParser.

Member Data Documentation

char* vtkXMLMaterialReader::FileName
protected

Definition at line 88 of file vtkXMLMaterialReader.h.

vtkXMLMaterialParser* vtkXMLMaterialReader::XMLParser
protected

Definition at line 89 of file vtkXMLMaterialReader.h.

vtkTimeStamp vtkXMLMaterialReader::ParseTime
protected

Definition at line 90 of file vtkXMLMaterialReader.h.


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