VTK
9.0.3
|
a collection of materials for vtk apps to draw from More...
#include <vtkOSPRayMaterialLibrary.h>
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. 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< 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... | |
vtkTexture * | GetTexture (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... | |
![]() | |
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) |
vtkCommand * | GetCommand (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) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (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). 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 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. More... | |
![]() | |
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 () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
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 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). 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) |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 39 of file vtkOSPRayMaterialLibrary.h.
Definition at line 43 of file vtkOSPRayMaterialLibrary.h.
using vtkOSPRayMaterialLibrary::ParametersMap = std::map<std::string, ParameterType> |
Definition at line 174 of file vtkOSPRayMaterialLibrary.h.
|
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.
|
protected |
|
protectedvirtual |
|
static |
|
static |
|
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 |
|
protectedvirtual |
vtkOSPRayMaterialLibrary* vtkOSPRayMaterialLibrary::NewInstance | ( | ) | const |
|
overridevirtual |
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 interpreted.
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 interpreted.
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<std::string> vtkOSPRayMaterialLibrary::GetDoubleShaderVariableList | ( | const std::string & | nickname | ) |
Returns list of variable names set for a specific material.
std::vector<double> vtkOSPRayMaterialLibrary::GetDoubleShaderVariable | ( | const std::string & | nickname, |
const std::string & | varname | ||
) |
Returns a uniform variable.
std::vector<std::string> vtkOSPRayMaterialLibrary::GetTextureList | ( | const std::string & | nickname | ) |
Returns list of texture names set for a specific material.
vtkTexture* vtkOSPRayMaterialLibrary::GetTexture | ( | const std::string & | nickname, |
const std::string & | varname | ||
) |
Returns a texture.
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::RemoveMaterial | ( | const std::string & | nickname | ) |
Remove Material Removes a material nickname from the set of known materials.
Do nothing if material does not exist.
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::RemoveTexture | ( | const std::string & | nickname, |
const std::string & | texturename | ||
) |
Remove Texture Removes a texture.
Do nothing if texture does not exist.
void vtkOSPRayMaterialLibrary::RemoveAllTextures | ( | const std::string & | nickname | ) |
Remove all textures of a specific material.
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.
|
inline |
Add control variable Adds a new control variable.
Replaces any previous content.
Definition at line 139 of file vtkOSPRayMaterialLibrary.h.
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.
void vtkOSPRayMaterialLibrary::RemoveAllShaderVariables | ( | const std::string & | nickname | ) |
Remove all control variables of a specific material.
|
static |
Get the dictionary of all possible materials based on OSPRay documentation.
|
protected |
|
protected |
|
protected |