a collection of materials for OSPRay-based rendering More...

#include <vtkOSPRayMaterialLibrary.h>

Inheritance diagram for vtkOSPRayMaterialLibrary:

Collaboration diagram for vtkOSPRayMaterialLibrary:

Public Types
typedef vtkRenderMaterialLibrary	Superclass

Public Types inherited from vtkRenderMaterialLibrary
enum class	ParameterType { FLOAT , FLOAT_DATA , COLOR_RGB , COLOR_RGBA , VEC2 , VEC3 , VEC4 , BOOLEAN , INT , TEXTURE , NORMALIZED_FLOAT }

typedef vtkObject	Superclass

using	ParametersMap = std::map<std::string, ParameterType>

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.

vtkOSPRayMaterialLibrary *	NewInstance () const

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

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

void	AddTexture (const std::string &nickname, const std::string &varname, vtkTexture *tex, const std::string &texturename="unnamedTexture", const std::string &filename="") override
	Add Texture Given a material `nickname` and a shader variable `varname`, set its data to a specific texture `tex` named `texturename`.

void	AddShaderVariable (const std::string &nickname, const std::string &variablename, int numVars, const double *x) override
	Add control variable Adds a new control variable validated against the OSPRay parameter dictionary.

std::vector< double >	GetDoubleShaderVariable (const std::string &nickname, const std::string &varname) const override
	Returns a uniform variable, resolving OSPRay parameter name aliases.

const TextureInfo *	GetTextureInfo (const std::string &nickname, const std::string &varname) const override
	Returns the texture information, resolving OSPRay parameter name aliases.

const std::map< std::string, ParametersMap > &	GetParametersDictionary () const override
	Get the dictionary of all possible materials based on OSPRay documentation.

void	AddShaderVariable (const std::string &nickname, const std::string &variablename, const std::initializer_list< double > &data)
	Add a shader variable from an initializer list of doubles.

Public Member Functions inherited from vtkRenderMaterialLibrary
vtkRenderMaterialLibrary *	NewInstance () const

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

bool	ReadFile (const char *FileName)
	Read a material file from disk.

bool	ReadBuffer (const char *Buffer)
	Parse material data from a buffer in memory.

const std::set< std::string > &	GetMaterialNames () const
	Get the set of all material nicknames currently in the library.

std::string	LookupImplName (const std::string &nickname) const
	Look up the implementation name for a material nickname.

std::vector< std::string >	GetDoubleShaderVariableList (const std::string &nickname) const
	Get the list of double-valued shader variables for a material.

std::vector< std::string >	GetTextureList (const std::string &nickname) const
	Get the list of texture variables for a material.

vtkTexture *	GetTexture (const std::string &nickname, const std::string &varname) const
	Get a texture object for a material variable.

std::string	GetTextureName (const std::string &nickname, const std::string &varname) const
	Get the registered name of a texture variable.

std::string	GetTextureFilename (const std::string &nickname, const std::string &varname) const
	Get the filename path of a texture variable.

void	RemoveMaterial (const std::string &nickname)
	Remove a material from the library.

void	AddShaderVariable (const std::string &nickname, const std::string &variablename, const std::initializer_list< double > &data)
	Add a shader variable from an initializer list of doubles.

void	RemoveShaderVariable (const std::string &nickname, const std::string &variablename)
	Remove a shader variable from a material.

void	RemoveAllShaderVariables (const std::string &nickname)
	Remove all shader variables from a material.

void	RemoveTexture (const std::string &nickname, const std::string &varname)
	Remove a texture from a material.

void	RemoveAllTextures (const std::string &nickname)
	Remove all textures from a material.

const char *	WriteBuffer (bool writeImageInline=true)
	Write the material library to a string buffer.

void	WriteFile (const std::string &filename, bool writeImageInline=false)
	Write the material library to a file on disk.

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

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

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

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

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

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

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

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

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

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.

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.

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.

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

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

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

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

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

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkOSPRayMaterialLibrary *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkOSPRayMaterialLibrary *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkRenderMaterialLibrary
static vtkRenderMaterialLibrary *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkRenderMaterialLibrary *	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.

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

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

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

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

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

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.

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).

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

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

bool	InternalParseJSON (const char filename, bool fromfile, std::istream doc) override
	Parse JSON material file with OSPRay-specific backward compatibility handling.

bool	ReadTextureFileOrData (const std::string &texFilenameOrData, bool fromfile, const std::string &parentDir, vtkTexture *textr, std::string &textureName, std::string &textureFilename) override
	Load texture from file or inline XML data.

	vtkOSPRayMaterialLibrary ()=default

	~vtkOSPRayMaterialLibrary () override=default

const char *	GetFamilyName () const override

const char *	GetAcceptedFamilyName () const override

Protected Member Functions inherited from vtkRenderMaterialLibrary
bool	InternalParse (const char *filename, bool fromfile)

bool	InternalParseMTL (const char filename, bool fromfile, std::istream doc)

std::string	FilePathToTextureName (const std::string &path)
	Convert a file path to a texture name by extracting the filename without extension.

std::string	Trim (const std::string &s)
	Remove leading and trailing whitespace from a string.

	vtkRenderMaterialLibrary ()

	~vtkRenderMaterialLibrary () override

std::string	InternalGetImplName (const std::string &nickname) const

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.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

a collection of materials for OSPRay-based rendering

A singleton instance of this class manages a collection of materials for use with the OSPRay renderer. The materials can be read in from disk or created programmatically.

This class extends vtkRenderMaterialLibrary with OSPRay-specific material type validation and the OSPRay material parameter dictionary. It accepts material files with the "OSPRay" family designation.

See also: vtkRenderMaterialLibrary, vtkOSPRayMaterialHelpers

Tests:: vtkOSPRayMaterialLibrary (Tests)

Definition at line 29 of file vtkOSPRayMaterialLibrary.h.

Member Typedef Documentation

◆ Superclass

typedef vtkRenderMaterialLibrary vtkOSPRayMaterialLibrary::Superclass

Definition at line 33 of file vtkOSPRayMaterialLibrary.h.

Constructor & Destructor Documentation

◆ vtkOSPRayMaterialLibrary()

vtkOSPRayMaterialLibrary::vtkOSPRayMaterialLibrary ( )

protecteddefault

◆ ~vtkOSPRayMaterialLibrary()

vtkOSPRayMaterialLibrary::~vtkOSPRayMaterialLibrary ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkOSPRayMaterialLibrary * vtkOSPRayMaterialLibrary::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

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 vtkRenderMaterialLibrary.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOSPRayMaterialLibrary::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkRenderMaterialLibrary.

◆ NewInstance()

vtkOSPRayMaterialLibrary * vtkOSPRayMaterialLibrary::NewInstance ( ) const

◆ PrintSelf()

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.

◆ AddMaterial()

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

overridevirtual

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

The implementation name is validated against the OSPRay material dictionary. If the name is a repeat, we replace the old one.

Reimplemented from vtkRenderMaterialLibrary.

◆ AddTexture()

void vtkOSPRayMaterialLibrary::AddTexture	(	const std::string &	nickname,
		const std::string &	varname,
		vtkTexture *	tex,
		const std::string &	texturename = "unnamedTexture",
		const std::string &	filename = "" )

overridevirtual

Add Texture Given a material nickname and a shader variable varname, set its data to a specific texture tex named texturename.

The variable name is validated against the OSPRay material parameter dictionary.

Replaces any previous content.

Reimplemented from vtkRenderMaterialLibrary.

◆ AddShaderVariable() [1/2]

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

overridevirtual

Add control variable Adds a new control variable validated against the OSPRay parameter dictionary.

Replaces any previous content.

Reimplemented from vtkRenderMaterialLibrary.

◆ GetDoubleShaderVariable()

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

overridevirtual

Returns a uniform variable, resolving OSPRay parameter name aliases.

Reimplemented from vtkRenderMaterialLibrary.

◆ GetTextureInfo()

const TextureInfo * vtkOSPRayMaterialLibrary::GetTextureInfo	(	const std::string &	nickname,
		const std::string &	varname ) const

overridevirtual

Returns the texture information, resolving OSPRay parameter name aliases.

Reimplemented from vtkRenderMaterialLibrary.

◆ GetParametersDictionary()

const std::map< std::string, ParametersMap > & vtkOSPRayMaterialLibrary::GetParametersDictionary ( ) const

overridevirtual

Get the dictionary of all possible materials based on OSPRay documentation.

Reimplemented from vtkRenderMaterialLibrary.

◆ InternalParseJSON()

bool vtkOSPRayMaterialLibrary::InternalParseJSON	(	const char *	filename,
		bool	fromfile,
		std::istream *	doc )

overrideprotectedvirtual

Parse JSON material file with OSPRay-specific backward compatibility handling.

Reimplemented from vtkRenderMaterialLibrary.

◆ ReadTextureFileOrData()

bool vtkOSPRayMaterialLibrary::ReadTextureFileOrData	(	const std::string &	texFilenameOrData,
		bool	fromfile,
		const std::string &	parentDir,
		vtkTexture *	textr,
		std::string &	textureName,
		std::string &	textureFilename )

overrideprotectedvirtual

Load texture from file or inline XML data.

Implements image loading for OSPRay materials.

Reimplemented from vtkRenderMaterialLibrary.

◆ GetFamilyName()

const char * vtkOSPRayMaterialLibrary::GetFamilyName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from vtkRenderMaterialLibrary.

Definition at line 97 of file vtkOSPRayMaterialLibrary.h.

◆ GetAcceptedFamilyName()

const char * vtkOSPRayMaterialLibrary::GetAcceptedFamilyName ( ) const

inlineoverrideprotectedvirtual

Reimplemented from vtkRenderMaterialLibrary.

Definition at line 98 of file vtkOSPRayMaterialLibrary.h.

◆ AddShaderVariable() [2/2]

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

inline

Add a shader variable from an initializer list of doubles.

Convenience overload that forwards to AddShaderVariable(string, string, int, const double*).

Parameters

nickname	The material to modify
variablename	The shader variable name
data	Initializer list of double values

Definition at line 181 of file vtkRenderMaterialLibrary.h.

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

Rendering/RayTracing/vtkOSPRayMaterialLibrary.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkOSPRayMaterialLibrary()

◆ ~vtkOSPRayMaterialLibrary()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ AddMaterial()

◆ AddTexture()

◆ AddShaderVariable() [1/2]

◆ GetDoubleShaderVariable()

◆ GetTextureInfo()

◆ GetParametersDictionary()

◆ InternalParseJSON()

◆ ReadTextureFileOrData()

◆ GetFamilyName()

◆ GetAcceptedFamilyName()

◆ AddShaderVariable() [2/2]