Provides static meta information about a specific Plugin type. More...

#include <vraysdk.hpp>

Public Member Functions
	PluginMeta (const PluginMeta &pluginMeta)=default

bool	checkPluginUIGuides (std::string &errMsg) const

PluginCategories	getCategories () const
	Returns all the plugin categories this plugin type belongs to, such as being a Light or a Material, etc.

const char *	getDeprecation () const
	Returns a deprecation string for this render plugin type. May be nullptr!

std::string	getDescription () const
	Returns a description for this render plugin type. May be empty.

GPUPluginSupport	getGPUSupport () const
	Returns to what extent the plugin is supported by V-Ray GPU.

PropertyMeta	getPropertyMeta (const char *propertyName) const
	Returns an object used to obtain meta information about a plugin property.

PropertyMeta	getPropertyMeta (const std::string &propertyName) const
	Returns an object used to obtain meta information about a plugin property.

std::vector< std::string >	getPropertyNames () const
	Returns the names of all properties.

const char *	getType () const
	Returns the type (name of the class) of the plugin or nullptr on ivalid type.

PluginTypeId	getTypeId () const
	Returns the type id of the plugin.

bool	isValid () const
	Checks if the object is valid.

PluginMeta &	operator= (const PluginMeta &pluginMeta)=default

bool	operator== (const PluginMeta &pluginMeta) const

void	swap (PluginMeta &pluginMeta)

Protected Member Functions
	PluginMeta (const Plugin &plugin)

	PluginMeta (const VRayRenderer renderer, const char typeStr)

	PluginMeta (const VRayRenderer *renderer, PluginTypeId pluginTypeId)

Detailed Description

Provides static meta information about a specific Plugin type.

Member Function Documentation

bool VRay::PluginMeta::checkPluginUIGuides ( std::string & errMsg ) const

Check validity of the uiguide strings of a plugin's properties. Mainly for debug purpose.

Parameters

errMsg A message explaining the error if such occurs.

Returns: Returns true if all uiGuides of the plugin's properties are valid and false otherwise.

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