VRay::PropertyMeta Class Reference

Static meta information about a plugin property. More...

#include <vraysdk.hpp>

Inheritance diagram for VRay::PropertyMeta:

Public Member Functions
	PropertyMeta (const PropertyMeta &propertyMeta)
StringList	getAliases () const
	Returns a list of alias names of this property.
Value	getDefaultValue () const
const char *	getDeprecation () const
	Returns a deprecation string for this property. May be nullptr!
std::string	getDescription () const
	Returns a short description of this property. May be empty.
int	getElementsCount () const
	Returns the number of elements for the property if it is a list and -1 otherwise.
Type	getElementType () const
	Returns the type of the property by definition or the type of the list elements when it's a typed list.
GPUParamSupport	getGPUSupport () const
	Returns to what extent the property is supported by V-Ray GPU.
const char *	getName () const
	Returns the primary name of this property.
Type	getType () const
const char *	getTypeAsString () const
std::string	getUIGuides () const
UIGuides	getUIGuidesObject () const
	Returns an object used to obtain meta information about a plugin property uiGuides.
	operator bool () const
	Returns true if the PropertyMeta is valid property meta, therefore can be used for valid checks of parameters.
PropertyMeta &	operator= (const PropertyMeta &propertyMeta)
void	swap (PropertyMeta &propertyMeta)

Static Public Member Functions
static const char *	typeToString (const Type type)

Protected Member Functions
	PropertyMeta (const VRayRenderer *pRenderer, const char *pluginClassName, const char *propertyName)

Protected Attributes
GPUParamSupport	gpuSupport
const void *	pParamDef

Friends
class	PluginMeta

Detailed Description

Static meta information about a plugin property.

Member Function Documentation

getDefaultValue()

Value VRay::PropertyMeta::getDefaultValue

(

)

const

Returns the default value of this property. This will never be a list. For list types the default value of an element is returned, if any. The returned value will have TYPE_UNSPECIFIED if a default value is not available and the .isOK() method will return false.

getType()

Type VRay::PropertyMeta::getType ( ) const

inline

Returns the type of the property value by definition. The runtime type may be slightly different for texture objects - they can be Plugin references or plain AColor, Vector, etc. values.

getUIGuides()

std::string VRay::PropertyMeta::getUIGuides ( ) const

inline

Returns a short description of what the name of this property in UI should be, min and max values, etc. This information is not available for many properties.

---

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

• /home/jenkins/ci/cgrepo/appsdk/VRay_SDK_CPP/include/vraysdk.hpp