a collection of materials for vtk apps to draw from More...

#include <vtkOSPRayMaterialLibrary.h>

Inheritance diagram for vtkOSPRayMaterialLibrary:

Collaboration diagram for vtkOSPRayMaterialLibrary:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkOSPRayMaterialLibrary *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	Fire ()
	Called to kick off events in all followers. More...

bool	ReadFile (const char *FileName)
	Reads the given file of materials and creates the in memory data structures needed to display objects with them. More...

const char *	WriteBuffer ()
	Serialize contents to an in memory buffer. More...

bool	ReadBuffer (const char *Buffer)
	DeSerialize contents from an in memory buffer as ReadFile does from a file or set of files. More...

std::set< std::string >	GetMaterialNames ()
	Returns the set of material nicknames. More...

std::string	LookupImplName (const std::string &nickname)
	Return an implementation name for the given material nickname. More...

std::vector< double >	GetDoubleShaderVariable (const std::string &nickname, const std::string &varname)
	Returns a unform variable, the name format is nickname:varname. More...

vtkTexture *	GetTexture (const std::string &nickname, const std::string &varname)
	Returns a texture, the name format is nickname:varname. More...

void	AddMaterial (const std::string &nickname, const std::string &implname)
	Add Material Adds a new material nickname to the set of known materials. More...

void	AddTexture (const std::string &nickname, const std::string &texturename, vtkTexture *tex)
	Add Texture Adds a new texture. More...


void	AddShaderVariable (const std::string &nickname, const std::string &variablename, int numVars, const double *x)
	Add control variable Adds a new control variable. More...

void	AddShaderVariable (const std::string &nickname, const std::string &variablename, const std::initializer_list< double > &data)
	Add control variable Adds a new control variable. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkOSPRayMaterialLibrary *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOSPRayMaterialLibrary *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkOSPRayMaterialLibrary ()

virtual	~vtkOSPRayMaterialLibrary ()

bool	InternalParse (const char *name, bool IsFile)

bool	InternalParseJSON (const char name, bool IsFile, std::istream doc)

bool	InternalParseMTL (const char name, bool IsFile, std::istream doc)

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

a collection of materials for vtk apps to draw from

A singleton instance of this class manages a collection of materials. The materials can be read in from disk or created programmatically.

See also: vtkOSPRayMaterialHelpers

Tests:: vtkOSPRayMaterialLibrary (Tests)

Definition at line 41 of file vtkOSPRayMaterialLibrary.h.

Member Typedef Documentation

typedef vtkObject vtkOSPRayMaterialLibrary::Superclass

Definition at line 45 of file vtkOSPRayMaterialLibrary.h.

Constructor & Destructor Documentation

vtkOSPRayMaterialLibrary::vtkOSPRayMaterialLibrary ( )

protected

virtual vtkOSPRayMaterialLibrary::~vtkOSPRayMaterialLibrary ( )

protectedvirtual

Member Function Documentation

static vtkOSPRayMaterialLibrary* vtkOSPRayMaterialLibrary::New ( )

static

static vtkTypeBool vtkOSPRayMaterialLibrary::IsTypeOf ( const char * type )

static

virtual vtkTypeBool vtkOSPRayMaterialLibrary::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 vtkObjectBase.

static vtkOSPRayMaterialLibrary* vtkOSPRayMaterialLibrary::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkOSPRayMaterialLibrary::NewInstanceInternal ( ) const

protectedvirtual

vtkOSPRayMaterialLibrary* vtkOSPRayMaterialLibrary::NewInstance ( ) const

void vtkOSPRayMaterialLibrary::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

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.

void vtkOSPRayMaterialLibrary::Fire ( )

Called to kick off events in all followers.

bool vtkOSPRayMaterialLibrary::ReadFile ( const char * FileName )

Reads the given file of materials and creates the in memory data structures needed to display objects with them.

Returns false only if file could not be meaningfully interpretted.

const char* vtkOSPRayMaterialLibrary::WriteBuffer ( )

Serialize contents to an in memory buffer.

bool vtkOSPRayMaterialLibrary::ReadBuffer ( const char * Buffer )

DeSerialize contents from an in memory buffer as ReadFile does from a file or set of files.

Returns false only if buffer could not be meaningfully interpretted.

std::set<std::string> vtkOSPRayMaterialLibrary::GetMaterialNames ( )

Returns the set of material nicknames.

std::string vtkOSPRayMaterialLibrary::LookupImplName ( const std::string & nickname )

Return an implementation name for the given material nickname.

std::vector<double> vtkOSPRayMaterialLibrary::GetDoubleShaderVariable	(	const std::string &	nickname,
		const std::string &	varname
	)

Returns a unform variable, the name format is nickname:varname.

vtkTexture* vtkOSPRayMaterialLibrary::GetTexture	(	const std::string &	nickname,
		const std::string &	varname
	)

Returns a texture, the name format is nickname:varname.

void vtkOSPRayMaterialLibrary::AddMaterial	(	const std::string &	nickname,
		const std::string &	implname
	)

Add Material Adds a new material nickname to the set of known materials.

If the name is a repeat, we replace the old one.

void vtkOSPRayMaterialLibrary::AddTexture	(	const std::string &	nickname,
		const std::string &	texturename,
		vtkTexture *	tex
	)

Add Texture Adds a new texture.

Replaces any previous content.

void vtkOSPRayMaterialLibrary::AddShaderVariable	(	const std::string &	nickname,
		const std::string &	variablename,
		int	numVars,
		const double *	x
	)

Add control variable Adds a new control variable.

Replaces any previous content.

void vtkOSPRayMaterialLibrary::AddShaderVariable	(	const std::string &	nickname,
		const std::string &	variablename,
		const std::initializer_list< double > &	data
	)

inline

Add control variable Adds a new control variable.

Replaces any previous content.

Definition at line 113 of file vtkOSPRayMaterialLibrary.h.

bool vtkOSPRayMaterialLibrary::InternalParse	(	const char *	name,
		bool	IsFile
	)

protected

bool vtkOSPRayMaterialLibrary::InternalParseJSON	(	const char *	name,
		bool	IsFile,
		std::istream *	doc
	)

protected

bool vtkOSPRayMaterialLibrary::InternalParseMTL	(	const char *	name,
		bool	IsFile,
		std::istream *	doc
	)

protected

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/OSPRay/vtkOSPRayMaterialLibrary.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation