VRay::Plugins::PhxShaderSimGeom Class Reference

This plugin is created when rendering the Phoenix or V-Ray Volume Grid container in Volumetric Geometry, Volumetric Heat Haze or Isosurface render modes. Other render modes use either the PhoenixMeshPlugin, or the PhoenixVolPlugin. [gpuSupport=(partial)]. More...

#include <vrayplugins.hpp>

Inheritance diagram for VRay::Plugins::PhxShaderSimGeom:

Public Member Functions
int	get_gpu_di_mode (double time=TiMe::Default()) const
int	get_gpu_gi_mode (double time=TiMe::Default()) const
int	get_gpu_samples_count (double time=TiMe::Default()) const
PluginRef	get_phoenix_sim (double time=TiMe::Default()) const
	operator GeometrySourcePluginCategory ()
	operator SettingsPluginCategory ()
bool	set_gpu_di_mode (int val, double time=TiMe::Default())
bool	set_gpu_gi_mode (int val, double time=TiMe::Default())
bool	set_gpu_samples_count (int val, double time=TiMe::Default())
bool	set_phoenix_sim (const PluginRef &plugin, double time=TiMe::Default())
Public Member Functions inherited from VRay::Plugin
	Plugin () noexcept
	Default construct an invalid Plugin - not referencing a V-Ray scene object.
	Plugin (const Plugin &plugin) noexcept
	Copy construct from another Plugin. They both point to the same underlying object. This is like having T& a=x; T& b=x;.
AColor	getAColor (const char *propertyName, bool &ok, double time=TiMe::Default()) const
AColor	getAColor (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as AColor.
AColor	getAColor (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
AColor	getAColor (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	getBool (const char *propertyName, bool &ok, double time=TiMe::Default()) const
bool	getBool (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as bool.
bool	getBool (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	getBool (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginCategories	getCategories () const
VUtils::CharString	getCharString (const char *propertyName)
VUtils::CharString	getCharString (const char *propertyName, bool &ok)
VUtils::CharString	getCharString (const std::string &propertyName)
VUtils::CharString	getCharString (const std::string &propertyName, bool &ok)
VUtils::CharString	getCharStringAtTime (const char *propertyName, double time)
VUtils::CharString	getCharStringAtTime (const char *propertyName, double time, bool &ok)
VUtils::CharString	getCharStringAtTime (const std::string &propertyName, double time)
VUtils::CharString	getCharStringAtTime (const std::string &propertyName, double time, bool &ok)
Color	getColor (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Color	getColor (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Color.
Color	getColor (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Color	getColor (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ColorList	getColorList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
ColorList	getColorList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as ColorList.
ColorList	getColorList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ColorList	getColorList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::ColorRefList	getColorRefList (const char *propertyName)
VUtils::ColorRefList	getColorRefList (const char *propertyName, bool &ok)
VUtils::ColorRefList	getColorRefList (const std::string &propertyName)
VUtils::ColorRefList	getColorRefList (const std::string &propertyName, bool &ok)
VUtils::ColorRefList	getColorRefListAtTime (const char *propertyName, double time)
VUtils::ColorRefList	getColorRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::ColorRefList	getColorRefListAtTime (const std::string &propertyName, double time)
VUtils::ColorRefList	getColorRefListAtTime (const std::string &propertyName, double time, bool &ok)
double	getDouble (const char *propertyName, bool &ok, double time=TiMe::Default()) const
double	getDouble (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as double.
double	getDouble (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
double	getDouble (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
float	getFloat (const char *propertyName, bool &ok, double time=TiMe::Default()) const
float	getFloat (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as float.
float	getFloat (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
float	getFloat (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
FloatList	getFloatList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
FloatList	getFloatList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as FloatList.
FloatList	getFloatList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
FloatList	getFloatList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::FloatRefList	getFloatRefList (const char *propertyName)
VUtils::FloatRefList	getFloatRefList (const char *propertyName, bool &ok)
VUtils::FloatRefList	getFloatRefList (const std::string &propertyName)
VUtils::FloatRefList	getFloatRefList (const std::string &propertyName, bool &ok)
VUtils::FloatRefList	getFloatRefListAtTime (const char *propertyName, double time)
VUtils::FloatRefList	getFloatRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::FloatRefList	getFloatRefListAtTime (const std::string &propertyName, double time)
VUtils::FloatRefList	getFloatRefListAtTime (const std::string &propertyName, double time, bool &ok)
int	getInt (const char *propertyName, bool &ok, double time=TiMe::Default()) const
int	getInt (const char *propertyName, double time=TiMe::Default()) const
int	getInt (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
int	getInt (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
unsigned long long	getIntegerID () const noexcept
	Returns the ID of the plugin instance. The ID is unique per scene contained in a VRayRenderer instance. Can be used as a hash value.
IntList	getIntList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
IntList	getIntList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as IntList.
IntList	getIntList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
IntList	getIntList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::IntRefList	getIntRefList (const char *propertyName)
VUtils::IntRefList	getIntRefList (const char *propertyName, bool &ok)
VUtils::IntRefList	getIntRefList (const std::string &propertyName)
VUtils::IntRefList	getIntRefList (const std::string &propertyName, bool &ok)
VUtils::IntRefList	getIntRefListAtTime (const char *propertyName, double time)
VUtils::IntRefList	getIntRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::IntRefList	getIntRefListAtTime (const std::string &propertyName, double time)
VUtils::IntRefList	getIntRefListAtTime (const std::string &propertyName, double time, bool &ok)
std::vector< double >	getKeyframeTimes (const char *propertyName) const
std::vector< double >	getKeyframeTimes (const char *propertyName, bool &ok) const
std::vector< double >	getKeyframeTimes (const std::string &propertyName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::vector< double >	getKeyframeTimes (const std::string &propertyName, bool &ok) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Matrix	getMatrix (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Matrix	getMatrix (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Matrix.
Matrix	getMatrix (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Matrix	getMatrix (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginMeta	getMeta () const
const char *	getName () const
PluginRefT< Plugin >	getPlugin (const char *propertyName, bool &ok, double time=TiMe::Default()) const
PluginRefT< Plugin >	getPlugin (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as a Plugin reference.
PluginRefT< Plugin >	getPlugin (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginRefT< Plugin >	getPlugin (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginList	getPluginList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
PluginList	getPluginList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as PluginList.
PluginList	getPluginList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PluginList	getPluginList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
PropertyRuntimeMeta	getPropertyRuntimeMeta (const char *propertyName) const
PropertyRuntimeMeta	getPropertyRuntimeMeta (const std::string &propertyName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VRayRenderer *	getRenderer () const noexcept
	Return the renderer this Plugin is associated with, can be null on empty plugins.
std::string	getString (const char *propertyName, bool &ok, double time=TiMe::Default()) const
std::string	getString (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as string.
std::string	getString (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::string	getString (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
StringList	getStringList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
StringList	getStringList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as StringList.
StringList	getStringList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
StringList	getStringList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::CharStringRefList	getStringRefList (const char *propertyName)
VUtils::CharStringRefList	getStringRefList (const char *propertyName, bool &ok)
VUtils::CharStringRefList	getStringRefList (const std::string &propertyName)
VUtils::CharStringRefList	getStringRefList (const std::string &propertyName, bool &ok)
VUtils::CharStringRefList	getStringRefListAtTime (const char *propertyName, double time)
VUtils::CharStringRefList	getStringRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::CharStringRefList	getStringRefListAtTime (const std::string &propertyName, double time)
VUtils::CharStringRefList	getStringRefListAtTime (const std::string &propertyName, double time, bool &ok)
Transform	getTransform (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Transform	getTransform (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Transform.
Transform	getTransform (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Transform	getTransform (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
TransformList	getTransformList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
TransformList	getTransformList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as TransformList.
TransformList	getTransformList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
TransformList	getTransformList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
const char *	getType () const
	Returns the type of this plugin as string.
PluginTypeId	getTypeId () const noexcept
	Returns the type id of this plugin as long.
Value	getValue (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Value	getValue (const char *propertyName, double time=TiMe::Default()) const
Value	getValue (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Value	getValue (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::string	getValueAsString (const char *propertyName, bool &ok, double time=TiMe::Default()) const
std::string	getValueAsString (const char *propertyName, double time=TiMe::Default()) const
std::string	getValueAsString (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
std::string	getValueAsString (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ValueList	getValueList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
ValueList	getValueList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as ValueList. Works only if it really is a generic list.
ValueList	getValueList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
ValueList	getValueList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::ValueRefList	getValueRefList (const char *propertyName)
VUtils::ValueRefList	getValueRefList (const char *propertyName, bool &ok)
VUtils::ValueRefList	getValueRefList (const std::string &propertyName)
VUtils::ValueRefList	getValueRefList (const std::string &propertyName, bool &ok)
VUtils::ValueRefList	getValueRefListAtTime (const char *propertyName, double time)
VUtils::ValueRefList	getValueRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::ValueRefList	getValueRefListAtTime (const std::string &propertyName, double time)
VUtils::ValueRefList	getValueRefListAtTime (const std::string &propertyName, double time, bool &ok)
Vector	getVector (const char *propertyName, bool &ok, double time=TiMe::Default()) const
Vector	getVector (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as Vector.
Vector	getVector (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Vector	getVector (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VectorList	getVectorList (const char *propertyName, bool &ok, double time=TiMe::Default()) const
VectorList	getVectorList (const char *propertyName, double time=TiMe::Default()) const
	Returns the value of a property as VectorList.
VectorList	getVectorList (const std::string &propertyName, bool &ok, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VectorList	getVectorList (const std::string &propertyName, double time=TiMe::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
VUtils::VectorRefList	getVectorRefList (const char *propertyName)
VUtils::VectorRefList	getVectorRefList (const char *propertyName, bool &ok)
VUtils::VectorRefList	getVectorRefList (const std::string &propertyName)
VUtils::VectorRefList	getVectorRefList (const std::string &propertyName, bool &ok)
VUtils::VectorRefList	getVectorRefListAtTime (const char *propertyName, double time)
VUtils::VectorRefList	getVectorRefListAtTime (const char *propertyName, double time, bool &ok)
VUtils::VectorRefList	getVectorRefListAtTime (const std::string &propertyName, double time)
VUtils::VectorRefList	getVectorRefListAtTime (const std::string &propertyName, double time, bool &ok)
bool	isEmpty () const noexcept
bool	isNotEmpty () const noexcept
bool	isPropertyAnimated (const char *propertyName) const
bool	isPropertyAnimated (const std::string &propertyName) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	isValid () const
bool	operator!= (const Plugin &plugin) const noexcept
	Returns false if both Plugins belong to the same renderer and point to the same scene object instance.
Plugin &	operator= (const Plugin &plugin) noexcept
	Assign from another Plugin. 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 belong to the same renderer and point to the same scene object instance.
bool	setArray (const char *propertyName, const char *const data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const char *propertyName, const Color data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const double data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const float data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const int data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Plugin plugins[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const std::string data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Transform data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Value values[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, const Vector data[], size_t count, double time=TiMe::Default())
bool	setArray (const char *propertyName, Value valuesToMove[], size_t count, double time=TiMe::Default())
bool	setArray (const std::string &propertyName, const char *const data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Color data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const double data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const float data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const int data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Plugin plugins[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const std::string data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Transform data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Value values[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, const Vector data[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArray (const std::string &propertyName, Value valuesToMove[], size_t count, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setArrayAtTime (const char *propertyName, const Color data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const double data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const float data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const int data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const Plugin data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const std::string data[], size_t count, double time)
bool	setArrayAtTime (const char *propertyName, const Vector data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const Color data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const double data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const float data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const int data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const Plugin data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const std::string data[], size_t count, double time)
bool	setArrayAtTime (const std::string &propertyName, const Vector data[], size_t count, double time)
bool	setName (const char *newName)
bool	setName (const std::string &newName)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, ColorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, const AColor &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const bool value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const char *str, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Color &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const ColorList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const double value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const float value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const FloatList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const int value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const IntList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Matrix &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const PluginList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const PluginRefT< Plugin > &pluginRef, double time=TiMe::Default())
bool	setValue (const char *propertyName, const std::string &str, double time=TiMe::Default())
bool	setValue (const char *propertyName, const StringList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Transform &transform, double time=TiMe::Default())
bool	setValue (const char *propertyName, const TransformList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Value &value, double time=TiMe::Default())
template<size_t count>
bool	setValue (const char *propertyName, const Value(&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, const ValueList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const Vector &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const VectorList &value, double time=TiMe::Default())
bool	setValue (const char *propertyName, const void *data, size_t size, double time=TiMe::Default())
bool	setValue (const char *propertyName, const VUtils::CharString &str)
bool	setValue (const char *propertyName, const VUtils::CharStringRefList &stringList)
bool	setValue (const char *propertyName, const VUtils::ColorRefList &colorList)
bool	setValue (const char *propertyName, const VUtils::FloatRefList &floatList)
bool	setValue (const char *propertyName, const VUtils::IntRefList &intList)
bool	setValue (const char *propertyName, const VUtils::TransformRefList &transformList)
bool	setValue (const char *propertyName, const VUtils::ValueRefList &valueList)
bool	setValue (const char *propertyName, const VUtils::VectorRefList &vectorList)
bool	setValue (const char *propertyName, FloatList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, IntList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, Value &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<size_t count>
bool	setValue (const char *propertyName, Value(&&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, ValueList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const char *propertyName, VectorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, ColorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const AColor &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const bool value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const char *str, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Color &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const ColorList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const double value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const float value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const FloatList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const int value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const IntList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Matrix &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const PluginList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const PluginRefT< Plugin > &pluginRef, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const std::string &str, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const StringList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Transform &transform, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const TransformList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Value &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<size_t count>
bool	setValue (const std::string &propertyName, const Value(&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const ValueList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const Vector &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const VectorList &value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const void *data, size_t size, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, const VUtils::CharString &str)
bool	setValue (const std::string &propertyName, const VUtils::CharStringRefList &stringList)
bool	setValue (const std::string &propertyName, const VUtils::ColorRefList &colorList)
bool	setValue (const std::string &propertyName, const VUtils::FloatRefList &floatList)
bool	setValue (const std::string &propertyName, const VUtils::IntRefList &intList)
bool	setValue (const std::string &propertyName, const VUtils::TransformRefList &transformList)
bool	setValue (const std::string &propertyName, const VUtils::ValueRefList &valueList)
bool	setValue (const std::string &propertyName, const VUtils::VectorRefList &vectorList)
bool	setValue (const std::string &propertyName, FloatList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, IntList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, Value &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
template<size_t count>
bool	setValue (const std::string &propertyName, Value(&&arr)[count], double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, ValueList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValue (const std::string &propertyName, VectorList &&value, double time=TiMe::Default())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsString (const char *propertyName, const char *value)
bool	setValueAsString (const char *propertyName, const std::string &value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsString (const std::string &propertyName, const char *value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsString (const std::string &propertyName, const std::string &value)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
bool	setValueAsStringAtTime (const char *propertyName, const char *value, double time)
bool	setValueAsStringAtTime (const char *propertyName, const std::string &value, double time)
bool	setValueAsStringAtTime (const std::string &propertyName, const char *value, double time)
bool	setValueAsStringAtTime (const std::string &propertyName, const std::string &value, double time)
bool	setValueAtTime (const char *propertyName, const AColor &value, double time)
bool	setValueAtTime (const char *propertyName, const bool value, double time)
bool	setValueAtTime (const char *propertyName, const char *str, double time)
bool	setValueAtTime (const char *propertyName, const Color &value, double time)
bool	setValueAtTime (const char *propertyName, const ColorList &value, double time)
bool	setValueAtTime (const char *propertyName, const double value, double time)
bool	setValueAtTime (const char *propertyName, const float value, double time)
bool	setValueAtTime (const char *propertyName, const FloatList &value, double time)
bool	setValueAtTime (const char *propertyName, const int value, double time)
bool	setValueAtTime (const char *propertyName, const IntList &value, double time)
bool	setValueAtTime (const char *propertyName, const Matrix &value, double time)
bool	setValueAtTime (const char *propertyName, const PluginList &value, double time)
bool	setValueAtTime (const char *propertyName, const PluginRefT< Plugin > &pluginRef, double time)
bool	setValueAtTime (const char *propertyName, const std::string &str, double time)
bool	setValueAtTime (const char *propertyName, const StringList &value, double time)
bool	setValueAtTime (const char *propertyName, const Transform &transform, double time)
bool	setValueAtTime (const char *propertyName, const Value &value, double time)
bool	setValueAtTime (const char *propertyName, const ValueList &value, double time)
bool	setValueAtTime (const char *propertyName, const Vector &value, double time)
bool	setValueAtTime (const char *propertyName, const VectorList &value, double time)
bool	setValueAtTime (const char *propertyName, const void *data, size_t size, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::CharString &str, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::CharStringRefList &stringList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::ColorRefList &colorList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::FloatRefList &floatList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::IntRefList &intList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::TransformRefList &transformList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::ValueRefList &valueList, double time)
bool	setValueAtTime (const char *propertyName, const VUtils::VectorRefList &vectorList, double time)
bool	setValueAtTime (const std::string &propertyName, const AColor &value, double time)
bool	setValueAtTime (const std::string &propertyName, const bool value, double time)
bool	setValueAtTime (const std::string &propertyName, const char *str, double time)
bool	setValueAtTime (const std::string &propertyName, const Color &value, double time)
bool	setValueAtTime (const std::string &propertyName, const ColorList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const double value, double time)
bool	setValueAtTime (const std::string &propertyName, const float value, double time)
bool	setValueAtTime (const std::string &propertyName, const FloatList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const int value, double time)
bool	setValueAtTime (const std::string &propertyName, const IntList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const Matrix &value, double time)
bool	setValueAtTime (const std::string &propertyName, const PluginList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const PluginRefT< Plugin > &pluginRef, double time)
bool	setValueAtTime (const std::string &propertyName, const std::string &str, double time)
bool	setValueAtTime (const std::string &propertyName, const StringList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const Transform &transform, double time)
bool	setValueAtTime (const std::string &propertyName, const Value &value, double time)
bool	setValueAtTime (const std::string &propertyName, const ValueList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const Vector &value, double time)
bool	setValueAtTime (const std::string &propertyName, const VectorList &value, double time)
bool	setValueAtTime (const std::string &propertyName, const void *data, size_t size, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::CharString &str, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::CharStringRefList &stringList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::ColorRefList &colorList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::FloatRefList &floatList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::IntRefList &intList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::TransformRefList &transformList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::ValueRefList &valueList, double time)
bool	setValueAtTime (const std::string &propertyName, const VUtils::VectorRefList &vectorList, double time)
void	swap (Plugin &plugin) noexcept
	Swaps the underlying scene object instance reference and associated renderer reference.
std::string	toString () const
	Returns a string representation of the plugin which currently is the name of the plugin.

Static Public Member Functions
static constexpr const char *	getType ()
	Return the name of the plugin type.
static constexpr const PluginTypeId	getTypeId ()
	Plugin type ID.

Additional Inherited Members
Protected Member Functions inherited from VRay::Plugin
	Plugin (VRayRenderer &renderer, const char *name)
	Plugin (VRayRenderer &renderer, InstanceId id) noexcept
	Plugin (VRayRenderer &renderer, InstanceId id, int typeIdIdx) noexcept
	Plugin (VRayRenderer &renderer, InstanceId id, PluginTypeId typeId) noexcept
InstanceId	id () const
template<typename T , int TYPE>
bool	setArrayAtTimeTemplate (const char *propertyName, size_t count, const T &value, double time)
template<typename LengthFn , typename PointerFn >
bool	setStringArrayTemplate (const char *propertyName, size_t count, LengthFn lengthAt, PointerFn pointerAt, double time)
template<typename T , int TYPE>
bool	setValueAtTimeTemplate (const char *propertyName, const T &value, double time)
Protected Attributes inherited from VRay::Plugin
InstanceId	internalId
const VRayRenderer *	pRenderer

Detailed Description

This plugin is created when rendering the Phoenix or V-Ray Volume Grid container in Volumetric Geometry, Volumetric Heat Haze or Isosurface render modes. Other render modes use either the PhoenixMeshPlugin, or the PhoenixVolPlugin. [gpuSupport=(partial)].

Member Function Documentation

get_gpu_di_mode()

int VRay::Plugins::PhxShaderSimGeom::get_gpu_di_mode ( double  time = TiMe::Default() ) const

inline

Mode for DI computations on the GPU [UI Guides] gpuSupport=none [Default value] 2

get_gpu_gi_mode()

int VRay::Plugins::PhxShaderSimGeom::get_gpu_gi_mode ( double  time = TiMe::Default() ) const

inline

Mode for GI computations on the GPU [UI Guides] gpuSupport=none [Default value] 2

get_gpu_samples_count()

int VRay::Plugins::PhxShaderSimGeom::get_gpu_samples_count ( double  time = TiMe::Default() ) const

inline

Samples count for cache computation on the GPU [UI Guides] gpuSupport=none [Default value] 1

get_phoenix_sim()

PluginRef VRay::Plugins::PhxShaderSimGeom::get_phoenix_sim ( double  time = TiMe::Default() ) const

inline

A plugin that supports PhoenixSimInterface and can be used to load a Phoenix frame [UI Guides] gpuSupport=full

set_gpu_di_mode()

bool VRay::Plugins::PhxShaderSimGeom::set_gpu_di_mode ( int  val, double  time = TiMe::Default()  )

inline

Mode for DI computations on the GPU [UI Guides] gpuSupport=none [Default value] 2

set_gpu_gi_mode()

bool VRay::Plugins::PhxShaderSimGeom::set_gpu_gi_mode ( int  val, double  time = TiMe::Default()  )

inline

Mode for GI computations on the GPU [UI Guides] gpuSupport=none [Default value] 2

set_gpu_samples_count()

bool VRay::Plugins::PhxShaderSimGeom::set_gpu_samples_count ( int  val, double  time = TiMe::Default()  )

inline

Samples count for cache computation on the GPU [UI Guides] gpuSupport=none [Default value] 1

set_phoenix_sim()

bool VRay::Plugins::PhxShaderSimGeom::set_phoenix_sim ( const PluginRef &  plugin, double  time = TiMe::Default()  )

inline

A plugin that supports PhoenixSimInterface and can be used to load a Phoenix frame [UI Guides] gpuSupport=full

---

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

• /home/jenkins/ci/j/workspace/core/vray_appsdk_lin_build/build/APPSDK/centos7/appsdk/cpp/generated/vrayplugins.hpp