vtkXMLMaterial Class Reference

encapsulates a VTK Material description. More...

#include <vtkXMLMaterial.h>

Inheritance diagram for vtkXMLMaterial:

Collaboration diagram for vtkXMLMaterial:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkXMLMaterial *	NewInstance () const
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 *)
Static Public Member Functions
static vtkXMLMaterial *	New ()
static int	IsTypeOf (const char *type)
static vtkXMLMaterial *	SafeDownCast (vtkObjectBase *o)
static vtkXMLMaterial *	CreateInstance (const char *name)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkXMLMaterial ()
	~vtkXMLMaterial ()
Protected Attributes
vtkXMLDataElement *	RootElement
vtkXMLMaterialInternals *	Internals

---

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 36 of file vtkXMLMaterial.h.

---

Member Typedef Documentation

typedef vtkObject vtkXMLMaterial::Superclass

Reimplemented from vtkObject.

Definition at line 40 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.

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

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkXMLMaterial::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkXMLMaterial* vtkXMLMaterial::NewInstance

(

)

const

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 90 of file vtkXMLMaterial.h.

vtkXMLMaterialInternals* vtkXMLMaterial::Internals [protected]

Definition at line 91 of file vtkXMLMaterial.h.

---

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

• dox/Rendering/Core/vtkXMLMaterial.h