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

Top-level geometry plugin. Places a geometric object in the scene and associates it with a material. More...

#include <vrayplugins.hpp>

Inheritance diagram for VRay::Plugins::Node:
VRay::Plugin

Public Member Functions

std::string get_bake_subdiv_filepath (double time=TiMe::Default()) const
 
PluginRef get_geometry (double time=TiMe::Default()) const
 Geometry source plugin for this object.
 
int get_is_instance_prototype (double time=TiMe::Default()) const
 
PluginList get_lights (double time=TiMe::Default()) const
 List of lights that will be used with this object instead of all scene lights.
 
PluginRef get_map_channels (double time=TiMe::Default()) const
 A plugin providing map channels override data via EXT_EXTERNAL_MAP_CHANNELS interface.
 
PluginRef get_material (double time=TiMe::Default()) const
 Material for the object surface. If this is invalid the object will render transparent.
 
int get_nsamples (double time=TiMe::Default()) const
 
PluginRef get_object_properties (double time=TiMe::Default()) const
 
int get_object_space_displacement (double time=TiMe::Default()) const
 
int get_objectID (double time=TiMe::Default()) const
 
Vector get_pivot_offset (double time=TiMe::Default()) const
 
bool get_primary_visibility (double time=TiMe::Default()) const
 
StringList get_scene_name (double time=TiMe::Default()) const
 
float get_time_for_geometry (double time=TiMe::Default()) const
 
Transform get_transform (double time=TiMe::Default()) const
 
bool get_use_time_for_geometry (double time=TiMe::Default()) const
 
std::string get_user_attributes (double time=TiMe::Default()) const
 
IntList get_user_attributes_bin (double time=TiMe::Default()) const
 
bool get_visible (double time=TiMe::Default()) const
 
PluginRef get_volume (double time=TiMe::Default()) const
 Volumetric shader if this object isn't an opaque surface.
 
 operator GeometryPluginCategory ()
 
bool set_bake_subdiv_filepath (const char *str, double time=TiMe::Default())
 
bool set_bake_subdiv_filepath (const std::string &str, double time=TiMe::Default())
 
bool set_geometry (const PluginRef &plugin, double time=TiMe::Default())
 Geometry source plugin for this object.
 
bool set_is_instance_prototype (int val, double time=TiMe::Default())
 
bool set_lights (const Plugin *plugins, size_t count, double time=TiMe::Default())
 
template<size_t count>
bool set_lights (const Plugin(&plugins)[count], double time=TiMe::Default())
 
bool set_lights (const PluginList &pluginList, double time=TiMe::Default())
 List of lights that will be used with this object instead of all scene lights.
 
bool set_map_channels (const PluginRef &plugin, double time=TiMe::Default())
 A plugin providing map channels override data via EXT_EXTERNAL_MAP_CHANNELS interface.
 
bool set_material (const PluginRef &plugin, double time=TiMe::Default())
 Material for the object surface. If this is invalid the object will render transparent.
 
bool set_nsamples (int val, double time=TiMe::Default())
 
bool set_object_properties (const PluginRef &plugin, double time=TiMe::Default())
 
bool set_object_space_displacement (int val, double time=TiMe::Default())
 
bool set_objectID (int val, double time=TiMe::Default())
 
bool set_pivot_offset (const Vector &vector, double time=TiMe::Default())
 
bool set_primary_visibility (bool val, double time=TiMe::Default())
 
bool set_scene_name (const StringList &stringList, double time=TiMe::Default())
 
bool set_time_for_geometry (float val, double time=TiMe::Default())
 
bool set_transform (const Transform &transform, double time=TiMe::Default())
 
bool set_use_time_for_geometry (bool val, double time=TiMe::Default())
 
bool set_user_attributes (const char *str, double time=TiMe::Default())
 
bool set_user_attributes (const std::string &str, double time=TiMe::Default())
 
bool set_user_attributes_bin (const int *ints, size_t count, double time=TiMe::Default())
 
template<size_t count>
bool set_user_attributes_bin (const int(&ints)[count], double time=TiMe::Default())
 
bool set_user_attributes_bin (const IntList &intList, double time=TiMe::Default())
 
bool set_user_attributes_bin (IntList &&intList, double time=TiMe::Default())
 
bool set_visible (bool val, double time=TiMe::Default())
 
bool set_volume (const PluginRef &plugin, double time=TiMe::Default())
 Volumetric shader if this object isn't an opaque surface.
 
- 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< PlugingetPlugin (const char *propertyName, bool &ok, double time=TiMe::Default()) const
 
PluginRefT< PlugingetPlugin (const char *propertyName, double time=TiMe::Default()) const
 Returns the value of a property as a Plugin reference.
 
PluginRefT< PlugingetPlugin (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< PlugingetPlugin (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.
 
VRayRenderergetRenderer () 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.
 
Pluginoperator= (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 VRayRendererpRenderer
 

Detailed Description

Top-level geometry plugin. Places a geometric object in the scene and associates it with a material.

Member Function Documentation

◆ get_bake_subdiv_filepath()

std::string VRay::Plugins::Node::get_bake_subdiv_filepath ( double  time = TiMe::Default()) const
inline

A file path for baking subdivision geometry to a *.vrmesh file. This will abort frame rendering! [Default value]

◆ get_is_instance_prototype()

int VRay::Plugins::Node::get_is_instance_prototype ( double  time = TiMe::Default()) const
inline

Set to true to disable this node from being compiled. Used for optimizing instancer wrapper nodes. [UI Guides] gpuSupport=full [Default value] 0

◆ get_nsamples()

int VRay::Plugins::Node::get_nsamples ( double  time = TiMe::Default()) const
inline

Number of transform samples for motion blur [Default value] 0

◆ get_object_properties()

PluginRef VRay::Plugins::Node::get_object_properties ( double  time = TiMe::Default()) const
inline

Object properties. [UI Guides] gpuSupport=none

◆ get_object_space_displacement()

int VRay::Plugins::Node::get_object_space_displacement ( double  time = TiMe::Default()) const
inline

Parameter to pass to the GeomDisplacedMesh wrapper created by the node. See GeomDisplacedMesh::object_space_displacement [UI Guides] gpuSupport=full [Default value] 0

◆ get_objectID()

int VRay::Plugins::Node::get_objectID ( double  time = TiMe::Default()) const
inline

Object ID for the rendering [Default value] 0

◆ get_pivot_offset()

Vector VRay::Plugins::Node::get_pivot_offset ( double  time = TiMe::Default()) const
inline

Pivot point offset relative to center of local coordinate space. Does NOT affect rendering. [Default value] Vector(0, 0, 0)

◆ get_primary_visibility()

bool VRay::Plugins::Node::get_primary_visibility ( double  time = TiMe::Default()) const
inline

If off shading an intersection with this mesh will not generate a gbuffer (object is invisible to direct camera rays). [Default value] 1

◆ get_scene_name()

StringList VRay::Plugins::Node::get_scene_name ( double  time = TiMe::Default()) const
inline

A list of string identifying the original scene node name for which this VRay Plugin was generated. The first string is directly the node name. [Default value]

◆ get_time_for_geometry()

float VRay::Plugins::Node::get_time_for_geometry ( double  time = TiMe::Default()) const
inline

If this is used (controlled by 'use_time_for_geometry') it will be given as the time for which the instance should be created and the geometry should be compiled for geometry that supports being created only at a certain time (currently only GeomMeshFile). Note that this time will not be used for the transform of the node - the current frame time will be used for that [Default value] 0

◆ get_transform()

Transform VRay::Plugins::Node::get_transform ( double  time = TiMe::Default()) const
inline

Object-to-world space transformation for the object [Default value] Transform(Matrix(Vector(1, 0, 0), Vector(0, 1, 0), Vector(0, 0, 1)), Vector(0, 0, 0))

◆ get_use_time_for_geometry()

bool VRay::Plugins::Node::get_use_time_for_geometry ( double  time = TiMe::Default()) const
inline

If true the 'time_for_geometry' parameter will be used [Default value] 0

◆ get_user_attributes()

std::string VRay::Plugins::Node::get_user_attributes ( double  time = TiMe::Default()) const
inline

A list of user defined attributes in the form "attrName1=value1;attrName2=value2" where values are usually numbers, strings or R,G,B triplets [Default value]

◆ get_user_attributes_bin()

IntList VRay::Plugins::Node::get_user_attributes_bin ( double  time = TiMe::Default()) const
inline

Serialized user attributes (refer to BinUserAttributesWriter). [Default value] 0

◆ get_visible()

bool VRay::Plugins::Node::get_visible ( double  time = TiMe::Default()) const
inline

true if the object is renderable (visible) and false otherwise; it only makes sense to use this parameter if it is animated, or if another object depends on this node but it must not be rendered [Default value] 1

◆ set_bake_subdiv_filepath() [1/2]

bool VRay::Plugins::Node::set_bake_subdiv_filepath ( const char *  str,
double  time = TiMe::Default() 
)
inline

A file path for baking subdivision geometry to a *.vrmesh file. This will abort frame rendering! [Default value]

◆ set_bake_subdiv_filepath() [2/2]

bool VRay::Plugins::Node::set_bake_subdiv_filepath ( const std::string &  str,
double  time = TiMe::Default() 
)
inline

A file path for baking subdivision geometry to a *.vrmesh file. This will abort frame rendering! [Default value]

◆ set_is_instance_prototype()

bool VRay::Plugins::Node::set_is_instance_prototype ( int  val,
double  time = TiMe::Default() 
)
inline

Set to true to disable this node from being compiled. Used for optimizing instancer wrapper nodes. [UI Guides] gpuSupport=full [Default value] 0

◆ set_nsamples()

bool VRay::Plugins::Node::set_nsamples ( int  val,
double  time = TiMe::Default() 
)
inline

Number of transform samples for motion blur [Default value] 0

◆ set_object_properties()

bool VRay::Plugins::Node::set_object_properties ( const PluginRef plugin,
double  time = TiMe::Default() 
)
inline

Object properties. [UI Guides] gpuSupport=none

◆ set_object_space_displacement()

bool VRay::Plugins::Node::set_object_space_displacement ( int  val,
double  time = TiMe::Default() 
)
inline

Parameter to pass to the GeomDisplacedMesh wrapper created by the node. See GeomDisplacedMesh::object_space_displacement [UI Guides] gpuSupport=full [Default value] 0

◆ set_objectID()

bool VRay::Plugins::Node::set_objectID ( int  val,
double  time = TiMe::Default() 
)
inline

Object ID for the rendering [Default value] 0

◆ set_pivot_offset()

bool VRay::Plugins::Node::set_pivot_offset ( const Vector vector,
double  time = TiMe::Default() 
)
inline

Pivot point offset relative to center of local coordinate space. Does NOT affect rendering. [Default value] Vector(0, 0, 0)

◆ set_primary_visibility()

bool VRay::Plugins::Node::set_primary_visibility ( bool  val,
double  time = TiMe::Default() 
)
inline

If off shading an intersection with this mesh will not generate a gbuffer (object is invisible to direct camera rays). [Default value] 1

◆ set_scene_name()

bool VRay::Plugins::Node::set_scene_name ( const StringList &  stringList,
double  time = TiMe::Default() 
)
inline

A list of string identifying the original scene node name for which this VRay Plugin was generated. The first string is directly the node name. [Default value]

◆ set_time_for_geometry()

bool VRay::Plugins::Node::set_time_for_geometry ( float  val,
double  time = TiMe::Default() 
)
inline

If this is used (controlled by 'use_time_for_geometry') it will be given as the time for which the instance should be created and the geometry should be compiled for geometry that supports being created only at a certain time (currently only GeomMeshFile). Note that this time will not be used for the transform of the node - the current frame time will be used for that [Default value] 0

◆ set_transform()

bool VRay::Plugins::Node::set_transform ( const Transform transform,
double  time = TiMe::Default() 
)
inline

Object-to-world space transformation for the object [Default value] Transform(Matrix(Vector(1, 0, 0), Vector(0, 1, 0), Vector(0, 0, 1)), Vector(0, 0, 0))

◆ set_use_time_for_geometry()

bool VRay::Plugins::Node::set_use_time_for_geometry ( bool  val,
double  time = TiMe::Default() 
)
inline

If true the 'time_for_geometry' parameter will be used [Default value] 0

◆ set_user_attributes() [1/2]

bool VRay::Plugins::Node::set_user_attributes ( const char *  str,
double  time = TiMe::Default() 
)
inline

A list of user defined attributes in the form "attrName1=value1;attrName2=value2" where values are usually numbers, strings or R,G,B triplets [Default value]

◆ set_user_attributes() [2/2]

bool VRay::Plugins::Node::set_user_attributes ( const std::string &  str,
double  time = TiMe::Default() 
)
inline

A list of user defined attributes in the form "attrName1=value1;attrName2=value2" where values are usually numbers, strings or R,G,B triplets [Default value]

◆ set_user_attributes_bin()

bool VRay::Plugins::Node::set_user_attributes_bin ( const IntList &  intList,
double  time = TiMe::Default() 
)
inline

Serialized user attributes (refer to BinUserAttributesWriter). [Default value] 0

◆ set_visible()

bool VRay::Plugins::Node::set_visible ( bool  val,
double  time = TiMe::Default() 
)
inline

true if the object is renderable (visible) and false otherwise; it only makes sense to use this parameter if it is animated, or if another object depends on this node but it must not be rendered [Default value] 1


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