VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkOSPRayMaterialLibrary Class Reference

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

#include <vtkOSPRayMaterialLibrary.h>

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

Public Types

enum  ParameterType : unsigned char {
  ParameterType::FLOAT, ParameterType::NORMALIZED_FLOAT, ParameterType::FLOAT_DATA, ParameterType::VEC3,
  ParameterType::COLOR_RGB, ParameterType::BOOLEAN, ParameterType::TEXTURE, ParameterType::VEC2,
  ParameterType::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. More...
 
vtkOSPRayMaterialLibraryNewInstance () 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< std::string > GetDoubleShaderVariableList (const std::string &nickname)
 Returns list of variable names set for a specific material. More...
 
std::vector< double > GetDoubleShaderVariable (const std::string &nickname, const std::string &varname)
 Returns a uniform variable. More...
 
std::vector< std::string > GetTextureList (const std::string &nickname)
 Returns list of texture names set for a specific material. More...
 
vtkTextureGetTexture (const std::string &nickname, const std::string &varname)
 Returns a texture. 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 RemoveMaterial (const std::string &nickname)
 Remove Material Removes a material nickname from 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 RemoveTexture (const std::string &nickname, const std::string &texturename)
 Remove Texture Removes a texture. More...
 
void RemoveAllTextures (const std::string &nickname)
 Remove all textures of a specific material. More...
 
void RemoveShaderVariable (const std::string &nickname, const std::string &variablename)
 Remove control variable Removes a new control variable. More...
 
void RemoveAllShaderVariables (const std::string &nickname)
 Remove all control variables of a specific material. 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 

Static Public Member Functions

static vtkOSPRayMaterialLibraryNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOSPRayMaterialLibrarySafeDownCast (vtkObjectBase *o)
 
static const std::map< std::string, ParametersMap > & GetParametersDictionary ()
 Get the dictionary of all possible materials based on OSPRay documentation. More...
 
- 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. 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 
- 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
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

Definition at line 39 of file vtkOSPRayMaterialLibrary.h.

Member Typedef Documentation

◆ Superclass

Definition at line 43 of file vtkOSPRayMaterialLibrary.h.

◆ ParametersMap

Definition at line 174 of file vtkOSPRayMaterialLibrary.h.

Member Enumeration Documentation

◆ ParameterType

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

Constructor & Destructor Documentation

◆ vtkOSPRayMaterialLibrary()

vtkOSPRayMaterialLibrary::vtkOSPRayMaterialLibrary ( )
protected

◆ ~vtkOSPRayMaterialLibrary()

virtual vtkOSPRayMaterialLibrary::~vtkOSPRayMaterialLibrary ( )
protectedvirtual

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 ( )

Serialize contents to an in memory buffer.

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

◆ 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 &  texturename,
vtkTexture tex 
)

Add Texture Adds a new texture.

Replaces any previous content.

◆ RemoveTexture()

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

Remove Texture Removes a texture.

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 139 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

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