VRay SDK for C++
Loading...
Searching...
No Matches
VRay::PropertyRuntimeMeta Class Reference

Extends PropertyMeta with type information only available at runtime for a specific property instance. More...

#include <vraysdk.hpp>

Inheritance diagram for VRay::PropertyRuntimeMeta:
VRay::PropertyMeta

Public Member Functions

 PropertyRuntimeMeta (const PropertyRuntimeMeta &propertyRuntimeMeta)
 
int getRuntimeElementsCount () const
 Return the current number of elements in a list property.
 
Type getRuntimeType () const
 Get the current type of the property value. This can differ from the result of getType().
 
const char * getRuntimeTypeAsString () const
 
RuntimeUIGuides getRuntimeUIGuidesObject () const
 Returns an object used to obtain meta and dynamic information about a plugin property uiGuides.
 
PropertyRuntimeMetaoperator= (const PropertyRuntimeMeta &propertyRuntimeMeta)
 
void swap (PropertyRuntimeMeta &propertyRuntimeMeta)
 
- Public Member Functions inherited from VRay::PropertyMeta
 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.
 
PropertyMetaoperator= (const PropertyMeta &propertyMeta)
 
void swap (PropertyMeta &propertyMeta)
 

Protected Member Functions

 PropertyRuntimeMeta (const Plugin &plugin, const char *propertyName)
 
- Protected Member Functions inherited from VRay::PropertyMeta
 PropertyMeta (const VRayRenderer *pRenderer, const char *pluginClassName, const char *propertyName)
 

Friends

class Plugin
 

Additional Inherited Members

- Static Public Member Functions inherited from VRay::PropertyMeta
static const char * typeToString (const Type type)
 
- Protected Attributes inherited from VRay::PropertyMeta
GPUParamSupport gpuSupport
 
const void * pParamDef
 

Detailed Description

Extends PropertyMeta with type information only available at runtime for a specific property instance.


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