VRay SDK for C++
Loading...
Searching...
No Matches
VRay::PluginRefT< T > Class Template Reference

#include <vraysdk.hpp>

Inheritance diagram for VRay::PluginRefT< T >:

Public Member Functions

 PluginRefT () noexcept
 Default construct an invalid PluginRef - not referencing a V-Ray scene object.
 
 PluginRefT (const PluginRefT &plugin) noexcept
 Copy construct from another PluginRef.
 
template<class X >
 PluginRefT (const PluginRefT< X > &plugin) noexcept
 
 PluginRefT (const T &plugin) noexcept
 Construct from another Plugin.
 
 PluginRefT (const T &plugin, const char *outPropertyName)
 Construct from Plugin and output property.
 
template<class X >
 PluginRefT (const X &plugin) noexcept
 
const char * getOutputName () const
 
bool isOutputValid () const noexcept
 Returns true if this PluginRef references a valid Plugin output (including the default one).
 
bool operator< (const PluginRefT &plugin) const noexcept
 
bool operator< (const PluginRefT< Plugin > &plugin) const noexcept
 
bool operator<= (const PluginRefT &plugin) const noexcept
 
bool operator<= (const PluginRefT< Plugin > &plugin) const noexcept
 
PluginRefToperator= (const PluginRefT &plugin) noexcept
 Assign from another PluginRefT. They both point to the same underlying object. This is like having T& a=x; T& b=x;.
 
bool operator== (const Plugin &plugin) const noexcept
 Returns true if both Plugins point to the same scene object instance.
 
bool operator== (const PluginRefT &plugin) const noexcept
 Returns true if both PluginRefTs point to the same scene object instance and reference the same output.
 
bool operator== (const PluginRefT< Plugin > &plugin) const noexcept
 Returns true if both PluginRefTs point to the same scene object instance and reference the same output.
 
bool operator> (const PluginRefT &plugin) const noexcept
 
bool operator> (const PluginRefT< Plugin > &plugin) const noexcept
 
bool operator>= (const PluginRefT &plugin) const noexcept
 
bool operator>= (const PluginRefT< Plugin > &plugin) const noexcept
 
void swap (PluginRefT &plugin) noexcept
 Swaps the underlying scene object instance reference along with its output and associated renderer reference.
 
std::string toString () const
 Returns a string representation of the plugin reference of the form "pluginName::outputPropertyName".
 

Friends

template<class U >
std::ostream & operator<< (std::ostream &stream, const PluginRefT< U > &pluginRef)
 
class PluginRefT< Plugin >
 
class VRayRenderer
 

Detailed Description

template<class T>
class VRay::PluginRefT< T >

PluginRef extends Plugin to hold a plugin property output as well. PluginRefT<class T> where T is a typed plugin class is a typed version of PluginRef. Instances of PluginRef are used when a property value is read or set. Plugin instances are convertible to PluginRefs; and vice versa with information loss. PluginRefT<T> can be implicitly converted to PluginRef. PluginRef can be converted to PluginRefT<T> with plugin_cast or plugin_checked_cast.

Member Function Documentation

◆ getOutputName()

template<class T >
const char * VRay::PluginRefT< T >::getOutputName ( ) const

Get the name of the Plugin output this reference contains. Returns NULL if it's the default or invalid output.


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