encapsulates a VTK Material description. More...

#include <vtkXMLMaterial.h>

Inheritance diagram for vtkXMLMaterial:

Collaboration diagram for vtkXMLMaterial:

Public Types
typedef vtkObject	Superclass
Public Types inherited from vtkObject

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
int	GetNumberOfProperties ()
int	GetNumberOfTextures ()
int	GetNumberOfVertexShaders ()
int	GetNumberOfFragmentShaders ()
vtkXMLDataElement *	GetProperty (int id=0)
vtkXMLDataElement *	GetTexture (int id=0)
vtkXMLShader *	GetVertexShader (int id=0)
vtkXMLShader *	GetFragmentShader (int id=0)
int	GetShaderLanguage ()
int	GetShaderStyle ()

virtual vtkXMLDataElement *	GetRootElement ()
void	SetRootElement (vtkXMLDataElement *)
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)
vtkCommand *	GetCommand (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 vtkXMLMaterial *	New ()
static int	IsTypeOf (const char *type)
static vtkXMLMaterial *	SafeDownCast (vtkObject *o)
static vtkXMLMaterial *	CreateInstance (const char *name)
Static Public Member Functions inherited from vtkObject
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()

Protected Member Functions
	vtkXMLMaterial ()
	~vtkXMLMaterial ()
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
vtkXMLDataElement *	RootElement
vtkXMLMaterialInternals *	Internals
Protected Attributes inherited from vtkObject
unsigned char	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
int	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

encapsulates a VTK Material description.

vtkXMLMaterial encapsulates VTK Material description. It keeps a pointer to vtkXMLDataElement that defines the material and provides access to Shaders/Properties defined in it.

Thanks:: Shader support in VTK includes key contributions by Gary Templet at Sandia National Labs.

Definition at line 35 of file vtkXMLMaterial.h.

Member Typedef Documentation

typedef vtkObject vtkXMLMaterial::Superclass

Reimplemented from vtkObject.

Definition at line 39 of file vtkXMLMaterial.h.

Constructor & Destructor Documentation

vtkXMLMaterial::vtkXMLMaterial ( )

protected

vtkXMLMaterial::~vtkXMLMaterial ( )

protected

Member Function Documentation

static vtkXMLMaterial* vtkXMLMaterial::New ( )

static

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

Reimplemented from vtkObject.

virtual const char* vtkXMLMaterial::GetClassName ( )

virtual

Reimplemented from vtkObject.

static int vtkXMLMaterial::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 vtkObject.

virtual int vtkXMLMaterial::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 vtkXMLMaterial* vtkXMLMaterial::SafeDownCast ( vtkObject * o )

static

Reimplemented from vtkObject.

void vtkXMLMaterial::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 vtkXMLMaterial* vtkXMLMaterial::CreateInstance ( const char * name )

static

Create a new instance. It searches for the material using the following order: first, check the MaterialLibrary; second, treat the name as an absolute path and try to locate it; third, search the Material repository. Returns null is it fails to locate the material.

int vtkXMLMaterial::GetNumberOfProperties ( )

Get number of elements of type Property.

int vtkXMLMaterial::GetNumberOfTextures ( )

Get number of elements of type Texture.

int vtkXMLMaterial::GetNumberOfVertexShaders ( )

Get number of Vertex shaders.

int vtkXMLMaterial::GetNumberOfFragmentShaders ( )

Get number of fragment shaders.

vtkXMLDataElement* vtkXMLMaterial::GetProperty ( int id = 0 )

Get the ith vtkXMLDataElement of type <Property>.

vtkXMLDataElement* vtkXMLMaterial::GetTexture ( int id = 0 )

Get the ith vtkXMLDataElement of type <Texture>.

vtkXMLShader* vtkXMLMaterial::GetVertexShader ( int id = 0 )

Get the ith vtkXMLDataElement of type <VertexShader>.

vtkXMLShader* vtkXMLMaterial::GetFragmentShader ( int id = 0 )

Get the ith vtkXMLDataElement of type <FragmentShader>.

virtual vtkXMLDataElement* vtkXMLMaterial::GetRootElement ( )

virtual

Get/Set the XML root element that describes this material.

void vtkXMLMaterial::SetRootElement ( vtkXMLDataElement * )

Get/Set the XML root element that describes this material.

int vtkXMLMaterial::GetShaderLanguage ( )

Get the Language used by the shaders in this Material. The Language of a vtkXMLMaterial is based on the Language of it's shaders.

int vtkXMLMaterial::GetShaderStyle ( )

Get the style the shaders.

Postcondition:: valid_result: result==1 || result==2

Member Data Documentation

vtkXMLDataElement* vtkXMLMaterial::RootElement

protected

Definition at line 89 of file vtkXMLMaterial.h.

vtkXMLMaterialInternals* vtkXMLMaterial::Internals

protected

Definition at line 90 of file vtkXMLMaterial.h.

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

dox/IO/vtkXMLMaterial.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation