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

#include <vtkOSPRayMaterialLibrary.h>

Inheritance diagram for vtkOSPRayMaterialLibrary:

Collaboration diagram for vtkOSPRayMaterialLibrary:

Public Types
enum class	ParameterType : unsigned char { FLOAT , NORMALIZED_FLOAT , FLOAT_DATA , VEC3 , COLOR_RGB , BOOLEAN , TEXTURE , VEC2 , VEC4 }
	Lists all different parameter types. More...

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	Fire ()
	Called to kick off events in all followers.

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

const char *	WriteBuffer (bool writeImageInline=true)
	Serialize contents to an in memory buffer.

void	WriteFile (const std::string &filename, bool writeImageInline=false)
	Serialize contents to a file specified by `filename`.

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

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

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

std::vector< std::string >	GetDoubleShaderVariableList (const std::string &nickname)
	Returns list of variable names set for a specific material.

std::vector< double >	GetDoubleShaderVariable (const std::string &nickname, const std::string &varname)
	Returns a uniform variable.

std::vector< std::string >	GetTextureList (const std::string &nickname)
	Returns list of texture names set for a specific material.

vtkTexture *	GetTexture (const std::string &nickname, const std::string &varname)
	Returns a texture.

const TextureInfo *	GetTextureInfo (const std::string &nickname, const std::string &varname)
	Returns the texture information (name, texture and filename) of this `varname`.

std::string	GetTextureName (const std::string &nickname, const std::string &varname)
	Returns the name (and not the shader variable name) associated to a texture.

std::string	GetTextureFilename (const std::string &nickname, const std::string &varname)
	Returns the filename associated ti a texture (if any).

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

void	RemoveMaterial (const std::string &nickname)
	Remove Material Removes a material nickname from 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="")
	Add Texture Given a material `nickname` and a shader variable `varname`, set its data to a specific texture `tex` named `texturename`.

void	RemoveTexture (const std::string &nickname, const std::string &varname)
	Remove Texture Removes a texture for a specific materal `nickname` and shader variable `varname`.

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

void	RemoveShaderVariable (const std::string &nickname, const std::string &variablename)
	Remove control variable Removes a new control variable.

void	RemoveAllShaderVariables (const std::string &nickname)
	Remove all control variables of a specific material.


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

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

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	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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 std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

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

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 const std::map< std::string, ParametersMap > &	GetParametersDictionary ()
	Get the dictionary of all possible materials based on OSPRay documentation.

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

	vtkOSPRayMaterialLibrary ()

	~vtkOSPRayMaterialLibrary () override

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)

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

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	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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 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 33 of file vtkOSPRayMaterialLibrary.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkOSPRayMaterialLibrary::Superclass

Definition at line 37 of file vtkOSPRayMaterialLibrary.h.

◆ ParametersMap

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

Definition at line 204 of file vtkOSPRayMaterialLibrary.h.

Member Enumeration Documentation

◆ ParameterType

enum class vtkOSPRayMaterialLibrary::ParameterType : unsigned char

strong

Lists all different parameter types.

Enumerator
FLOAT
NORMALIZED_FLOAT
FLOAT_DATA
VEC3
COLOR_RGB
BOOLEAN
TEXTURE
VEC2
VEC4

Definition at line 191 of file vtkOSPRayMaterialLibrary.h.

Constructor & Destructor Documentation

◆ vtkOSPRayMaterialLibrary()

vtkOSPRayMaterialLibrary::vtkOSPRayMaterialLibrary ( )

protected

◆ ~vtkOSPRayMaterialLibrary()

vtkOSPRayMaterialLibrary::~vtkOSPRayMaterialLibrary ( )

overrideprotected

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

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkOSPRayMaterialLibrary::NewInstanceInternal ( ) const

protectedvirtual

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

◆ Fire()

void vtkOSPRayMaterialLibrary::Fire ( )

Called to kick off events in all followers.

◆ ReadFile()

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

◆ WriteBuffer()

const char * vtkOSPRayMaterialLibrary::WriteBuffer ( bool writeImageInline = true )

Serialize contents to an in memory buffer.

If writeImageInline, all textures are stored in a XML format. Else, store the texture using its filename stored in its TextureInfo struct. Warning: you must free the return value using delete.

◆ WriteFile()

void vtkOSPRayMaterialLibrary::WriteFile	(	const std::string &	filename,
		bool	writeImageInline = `false`
	)

Serialize contents to a file specified by filename.

If writeImageInline, all textures are stored in a XML format. Else, store the texture using its filename stored in its TextureInfo struct Warning: if filename exists, its content is discarded.

◆ ReadBuffer()

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

◆ GetMaterialNames()

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

Returns the set of material nicknames.

◆ LookupImplName()

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

Return an implementation name for the given material nickname.

◆ GetDoubleShaderVariableList()

std::vector< std::string > vtkOSPRayMaterialLibrary::GetDoubleShaderVariableList ( const std::string & nickname )

Returns list of variable names set for a specific material.

◆ GetDoubleShaderVariable()

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

Returns a uniform variable.

◆ GetTextureList()

std::vector< std::string > vtkOSPRayMaterialLibrary::GetTextureList ( const std::string & nickname )

Returns list of texture names set for a specific material.

◆ GetTexture()

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

Returns a texture.

◆ GetTextureInfo()

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

Returns the texture information (name, texture and filename) of this varname.

If not found, return nullptr;

◆ GetTextureName()

std::string vtkOSPRayMaterialLibrary::GetTextureName	(	const std::string &	nickname,
		const std::string &	varname
	)

Returns the name (and not the shader variable name) associated to a texture.

◆ GetTextureFilename()

std::string vtkOSPRayMaterialLibrary::GetTextureFilename	(	const std::string &	nickname,
		const std::string &	varname
	)

Returns the filename associated ti a texture (if any).

◆ AddMaterial()

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.

◆ RemoveMaterial()

void vtkOSPRayMaterialLibrary::RemoveMaterial ( const std::string & nickname )

Remove Material Removes a material nickname from the set of known materials.

Do nothing if material does not exist.

◆ AddTexture()

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

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

If not specified the texture is called "unnamedTexture". The last parameter, filename, is defaulted to empty. If specified, the absolute path to find the texture will be stored. Useful when writing the library into a file.

Replaces any previous content.

◆ RemoveTexture()

void vtkOSPRayMaterialLibrary::RemoveTexture	(	const std::string &	nickname,
		const std::string &	varname
	)

Remove Texture Removes a texture for a specific materal nickname and shader variable varname.

Do nothing if texture does not exist.

◆ RemoveAllTextures()

void vtkOSPRayMaterialLibrary::RemoveAllTextures ( const std::string & nickname )

Remove all textures of a specific material.

◆ AddShaderVariable() [1/2]

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.

◆ AddShaderVariable() [2/2]

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 169 of file vtkOSPRayMaterialLibrary.h.

◆ RemoveShaderVariable()

void vtkOSPRayMaterialLibrary::RemoveShaderVariable	(	const std::string &	nickname,
		const std::string &	variablename
	)

Remove control variable Removes a new control variable.

Do nothing if variable does not exist.

◆ RemoveAllShaderVariables()

void vtkOSPRayMaterialLibrary::RemoveAllShaderVariables ( const std::string & nickname )

Remove all control variables of a specific material.

◆ GetParametersDictionary()

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

static

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

◆ InternalParse()

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

protected

◆ InternalParseJSON()

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

protected

◆ InternalParseMTL()

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

protected

◆ ReadTextureFileOrData()

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

protected

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

◆ ParametersMap

Member Enumeration Documentation

◆ ParameterType

Constructor & Destructor Documentation

◆ vtkOSPRayMaterialLibrary()

◆ ~vtkOSPRayMaterialLibrary()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Fire()

◆ ReadFile()

◆ WriteBuffer()

◆ WriteFile()

◆ ReadBuffer()

◆ GetMaterialNames()

◆ LookupImplName()

◆ GetDoubleShaderVariableList()

◆ GetDoubleShaderVariable()

◆ GetTextureList()

◆ GetTexture()

◆ GetTextureInfo()

◆ GetTextureName()

◆ GetTextureFilename()

◆ AddMaterial()

◆ RemoveMaterial()

◆ AddTexture()

◆ RemoveTexture()

◆ RemoveAllTextures()

◆ AddShaderVariable() [1/2]

◆ AddShaderVariable() [2/2]

◆ RemoveShaderVariable()

◆ RemoveAllShaderVariables()

◆ GetParametersDictionary()

◆ InternalParse()

◆ InternalParseJSON()

◆ InternalParseMTL()

◆ ReadTextureFileOrData()