VTK  9.6.20260625
vtkRenderMaterialLibrary Class Reference

a renderer-agnostic collection of materials for VTK apps to draw from More...

#include <vtkRenderMaterialLibrary.h>

Inheritance diagram for vtkRenderMaterialLibrary:
[legend]
Collaboration diagram for vtkRenderMaterialLibrary:
[legend]

Public Types

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.
 
vtkRenderMaterialLibraryNewInstance () 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.
 
virtual std::vector< double > GetDoubleShaderVariable (const std::string &nickname, const std::string &varname) const
 Get the value of a double shader variable for a material.
 
std::vector< std::string > GetTextureList (const std::string &nickname) const
 Get the list of texture variables for a material.
 
vtkTextureGetTexture (const std::string &nickname, const std::string &varname) const
 Get a texture object for a material variable.
 
virtual const TextureInfo * GetTextureInfo (const std::string &nickname, const std::string &varname) const
 Get texture information 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.
 
virtual void AddMaterial (const std::string &nickname, const std::string &implname)
 Add a new material to the library or replace an existing one.
 
void RemoveMaterial (const std::string &nickname)
 Remove a material from the library.
 
virtual void AddTexture (const std::string &nickname, const std::string &varname, vtkTexture *tex, const std::string &texturename="unnamedTexture", const std::string &filename="")
 Add a texture to a material.
 
virtual void AddShaderVariable (const std::string &nickname, const std::string &variablename, int numVars, const double *x)
 Add a shader variable to a material.
 
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.
 
vtkCommandGetCommand (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 vtkRenderMaterialLibraryNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderMaterialLibrarySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
virtual bool ReadTextureFileOrData (const std::string &texFilenameOrData, bool fromfile, const std::string &parentDir, vtkTexture *textr, std::string &textureName, std::string &textureFilename)
 Load texture from file or inline data.
 
bool InternalParse (const char *filename, bool fromfile)
 
virtual bool InternalParseJSON (const char *filename, bool fromfile, std::istream *doc)
 
bool InternalParseMTL (const char *filename, bool fromfile, std::istream *doc)
 
virtual const std::map< std::string, ParametersMap > & GetParametersDictionary () const
 
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
 
virtual const char * GetFamilyName () const
 
virtual const char * GetAcceptedFamilyName () const
 
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 renderer-agnostic collection of materials for VTK apps to draw from

Definition at line 27 of file vtkRenderMaterialLibrary.h.

Member Typedef Documentation

◆ Superclass

◆ ParametersMap

Definition at line 49 of file vtkRenderMaterialLibrary.h.

Member Enumeration Documentation

◆ ParameterType

Enumerator
FLOAT 
FLOAT_DATA 
COLOR_RGB 
COLOR_RGBA 
VEC2 
VEC3 
VEC4 
BOOLEAN 
INT 
TEXTURE 
NORMALIZED_FLOAT 

Definition at line 34 of file vtkRenderMaterialLibrary.h.

Constructor & Destructor Documentation

◆ vtkRenderMaterialLibrary()

vtkRenderMaterialLibrary::vtkRenderMaterialLibrary ( )
protected

◆ ~vtkRenderMaterialLibrary()

vtkRenderMaterialLibrary::~vtkRenderMaterialLibrary ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRenderMaterialLibrary * vtkRenderMaterialLibrary::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRenderMaterialLibrary::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkRenderMaterialLibrary * vtkRenderMaterialLibrary::NewInstance ( ) const

◆ PrintSelf()

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

◆ ReadFile()

bool vtkRenderMaterialLibrary::ReadFile ( const char * FileName)

Read a material file from disk.

Supports JSON and OBJ/MTL file formats.

Parameters
FileNamePath to the material file to read
Returns
True if file was successfully parsed, false otherwise

◆ ReadBuffer()

bool vtkRenderMaterialLibrary::ReadBuffer ( const char * Buffer)

Parse material data from a buffer in memory.

Parameters
BufferString containing material data (JSON or MTL format)
Returns
True if buffer was successfully parsed, false otherwise

◆ GetMaterialNames()

const std::set< std::string > & vtkRenderMaterialLibrary::GetMaterialNames ( ) const

Get the set of all material nicknames currently in the library.

Returns
Set of material nickname strings

◆ LookupImplName()

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

Look up the implementation name for a material nickname.

The implementation name indicates the underlying material type (e.g., "glass", "metal").

Parameters
nicknameThe user-facing material name
Returns
The implementation/type name for the material

◆ GetDoubleShaderVariableList()

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

Get the list of double-valued shader variables for a material.

Parameters
nicknameThe material to query
Returns
Vector of variable names

◆ GetDoubleShaderVariable()

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

Get the value of a double shader variable for a material.

Parameters
nicknameThe material to query
varnameThe variable name to retrieve
Returns
Vector of double values for the variable

Reimplemented in vtkOSPRayMaterialLibrary.

◆ GetTextureList()

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

Get the list of texture variables for a material.

Parameters
nicknameThe material to query
Returns
Vector of texture variable names

◆ GetTexture()

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

Get a texture object for a material variable.

Parameters
nicknameThe material to query
varnameThe texture variable name
Returns
Pointer to vtkTexture, or nullptr if not found

◆ GetTextureInfo()

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

Get texture information for a material variable.

Parameters
nicknameThe material to query
varnameThe texture variable name
Returns
Pointer to TextureInfo structure, or nullptr if not found

Reimplemented in vtkOSPRayMaterialLibrary.

◆ GetTextureName()

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

Get the registered name of a texture variable.

Parameters
nicknameThe material to query
varnameThe texture variable name
Returns
The texture name string

◆ GetTextureFilename()

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

Get the filename path of a texture variable.

Parameters
nicknameThe material to query
varnameThe texture variable name
Returns
The texture file path string

◆ AddMaterial()

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

Add a new material to the library or replace an existing one.

Subclasses may override to add validation logic.

Parameters
nicknameUser-facing name for the material
implnameImplementation/type name of the material

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

◆ RemoveMaterial()

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

Remove a material from the library.

Also removes all associated textures and shader variables.

Parameters
nicknameThe material to remove

◆ AddTexture()

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

Add a texture to a material.

Subclasses may override to add validation logic.

Parameters
nicknameThe material to modify
varnameThe texture variable name
texThe texture object to add
texturenameOptional name for the texture
filenameOptional filename path for the texture

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

◆ AddShaderVariable() [1/2]

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

Add a shader variable to a material.

Subclasses may override to add validation logic.

Parameters
nicknameThe material to modify
variablenameThe shader variable name
numVarsNumber of values in the variable
xArray of double values for the variable

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

◆ 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
nicknameThe material to modify
variablenameThe shader variable name
dataInitializer list of double values

Definition at line 181 of file vtkRenderMaterialLibrary.h.

◆ RemoveShaderVariable()

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

Remove a shader variable from a material.

Parameters
nicknameThe material to modify
variablenameThe shader variable to remove

◆ RemoveAllShaderVariables()

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

Remove all shader variables from a material.

Parameters
nicknameThe material to modify

◆ RemoveTexture()

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

Remove a texture from a material.

Parameters
nicknameThe material to modify
varnameThe texture variable to remove

◆ RemoveAllTextures()

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

Remove all textures from a material.

Parameters
nicknameThe material to modify

◆ WriteBuffer()

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

Write the material library to a string buffer.

Parameters
writeImageInlineIf true, embed image data inline in the output; if false, use file references
Returns
String buffer containing the serialized material library data

◆ WriteFile()

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

Write the material library to a file on disk.

Parameters
filenamePath to write the material file to
writeImageInlineIf true, embed image data inline in the output; if false, use file references

◆ ReadTextureFileOrData()

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

Load texture from file or inline data.

Subclasses may override for custom texture loading.

Parameters
texFilenameOrDataPath to file or inline XML/binary data
fromfileTrue if texFilenameOrData is a file path
parentDirParent directory for relative paths
textrTexture object to populate
textureNameOutput: name of the texture
textureFilenameOutput: full path to texture file
Returns
True if loading succeeded

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

◆ InternalParse()

bool vtkRenderMaterialLibrary::InternalParse ( const char * filename,
bool fromfile )
protected

◆ InternalParseJSON()

virtual bool vtkRenderMaterialLibrary::InternalParseJSON ( const char * filename,
bool fromfile,
std::istream * doc )
protectedvirtual

Reimplemented in vtkOSPRayMaterialLibrary.

◆ InternalParseMTL()

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

◆ GetParametersDictionary()

virtual const std::map< std::string, ParametersMap > & vtkRenderMaterialLibrary::GetParametersDictionary ( ) const
protectedvirtual

◆ FilePathToTextureName()

std::string vtkRenderMaterialLibrary::FilePathToTextureName ( const std::string & path)
protected

Convert a file path to a texture name by extracting the filename without extension.

Parameters
pathFile path to convert
Returns
Filename without extension

◆ Trim()

std::string vtkRenderMaterialLibrary::Trim ( const std::string & s)
protected

Remove leading and trailing whitespace from a string.

Parameters
sInput string
Returns
String with whitespace trimmed from both ends

◆ GetFamilyName()

virtual const char * vtkRenderMaterialLibrary::GetFamilyName ( ) const
inlineprotectedvirtual

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

Definition at line 267 of file vtkRenderMaterialLibrary.h.

◆ GetAcceptedFamilyName()

virtual const char * vtkRenderMaterialLibrary::GetAcceptedFamilyName ( ) const
inlineprotectedvirtual

Reimplemented in vtkANARIMaterialLibrary, and vtkOSPRayMaterialLibrary.

Definition at line 268 of file vtkRenderMaterialLibrary.h.

◆ InternalGetImplName()

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

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