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

#include <vraysdk.hpp>

Inheritance diagram for VRay::Plugin:
VRay::PluginRefT< Plugin > VRay::Plugins::BRDFAlHair VRay::Plugins::BRDFAlSurface VRay::Plugins::BRDFBlinn VRay::Plugins::BRDFBump VRay::Plugins::BRDFCSV VRay::Plugins::BRDFCarPaint VRay::Plugins::BRDFCarPaint2 VRay::Plugins::BRDFCookTorrance VRay::Plugins::BRDFDiffuse VRay::Plugins::BRDFDiffuse_forSSS VRay::Plugins::BRDFFiltering VRay::Plugins::BRDFFlakes VRay::Plugins::BRDFFlakes2 VRay::Plugins::BRDFGGX VRay::Plugins::BRDFGlass VRay::Plugins::BRDFGlassGlossy VRay::Plugins::BRDFHOPS VRay::Plugins::BRDFHair VRay::Plugins::BRDFHair2 VRay::Plugins::BRDFHair3 VRay::Plugins::BRDFHair4 VRay::Plugins::BRDFLayered VRay::Plugins::BRDFLight VRay::Plugins::BRDFMirror VRay::Plugins::BRDFModoUnity VRay::Plugins::BRDFModoUnreal VRay::Plugins::BRDFMultiBump VRay::Plugins::BRDFPhong VRay::Plugins::BRDFSSS VRay::Plugins::BRDFSSS2 VRay::Plugins::BRDFSSS2Complex VRay::Plugins::BRDFSampled VRay::Plugins::BRDFScanned VRay::Plugins::BRDFScatterVolume VRay::Plugins::BRDFSkinComplex VRay::Plugins::BRDFStochasticFlakes VRay::Plugins::BRDFThunderLoom VRay::Plugins::BRDFToonMtl VRay::Plugins::BRDFToonOverride VRay::Plugins::BRDFVRayMtl VRay::Plugins::BRDFWard VRay::Plugins::BSDFPluginCategory VRay::Plugins::BSDFPointParticle VRay::Plugins::BakeView VRay::Plugins::BitmapBuffer VRay::Plugins::BitmapPluginCategory VRay::Plugins::CameraDefault VRay::Plugins::CameraDome VRay::Plugins::CameraFilmTransform VRay::Plugins::CameraLensSystem VRay::Plugins::CameraPhysical VRay::Plugins::ColorCorrect VRay::Plugins::ColorCorrection VRay::Plugins::ColorMapperTest VRay::Plugins::ColorTextureToMono VRay::Plugins::CustomGlsl VRay::Plugins::EnvFogMeshGizmo VRay::Plugins::EnvironmentFog VRay::Plugins::ExtChannel VRay::Plugins::ExtMapChannels VRay::Plugins::FilterArea VRay::Plugins::FilterBox VRay::Plugins::FilterCatmullRom VRay::Plugins::FilterCookVariable VRay::Plugins::FilterGaussian VRay::Plugins::FilterLanczos VRay::Plugins::FilterMitNet VRay::Plugins::FilterPoint VRay::Plugins::FilterSinc VRay::Plugins::FilterTriangle VRay::Plugins::Float3ToAColor VRay::Plugins::FloatToTex VRay::Plugins::GeomBifrost VRay::Plugins::GeomBox VRay::Plugins::GeomDisplacedMesh VRay::Plugins::GeomEnmesh VRay::Plugins::GeomGaussians VRay::Plugins::GeomHair VRay::Plugins::GeomImagePlane VRay::Plugins::GeomInstancer VRay::Plugins::GeomLocalRayserver VRay::Plugins::GeomMayaHair VRay::Plugins::GeomMeshFile VRay::Plugins::GeomMeshLoader VRay::Plugins::GeomMeshLoader1 VRay::Plugins::GeomMeshTest VRay::Plugins::GeomMetaballSystem VRay::Plugins::GeomParticleSystem VRay::Plugins::GeomPartio VRay::Plugins::GeomPerfectSphere VRay::Plugins::GeomPlane VRay::Plugins::GeomRayserverInstancer VRay::Plugins::GeomScatter VRay::Plugins::GeomScatterSpline VRay::Plugins::GeomStaticMesh VRay::Plugins::GeomStaticNURBS VRay::Plugins::GeomStaticSmoothedMesh VRay::Plugins::GeometryPluginCategory VRay::Plugins::GeometrySourcePluginCategory VRay::Plugins::InfoRenderEngine VRay::Plugins::Instancer VRay::Plugins::Instancer2 VRay::Plugins::LightAmbient VRay::Plugins::LightAmbientMax VRay::Plugins::LightDirect VRay::Plugins::LightDirectMax VRay::Plugins::LightDirectModo VRay::Plugins::LightDome VRay::Plugins::LightIES VRay::Plugins::LightIESMax VRay::Plugins::LightInstancer VRay::Plugins::LightLuminaire VRay::Plugins::LightMesh VRay::Plugins::LightOmni VRay::Plugins::LightOmniMax VRay::Plugins::LightPluginCategory VRay::Plugins::LightRectangle VRay::Plugins::LightSphere VRay::Plugins::LightSpot VRay::Plugins::LightSpotMax VRay::Plugins::LuminaireBaker VRay::Plugins::MaterialOverrider VRay::Plugins::MaterialPluginCategory VRay::Plugins::MayaGamma VRay::Plugins::MayaLightDirect VRay::Plugins::MayaMtlMatte VRay::Plugins::MayaMultiplyDivide VRay::Plugins::MayaProjectionTex VRay::Plugins::MeshGeometryTrim VRay::Plugins::Mtl2Sided VRay::Plugins::MtlDoubleSided VRay::Plugins::MtlGLSL VRay::Plugins::MtlMDL VRay::Plugins::MtlMaterialID VRay::Plugins::MtlMayaRamp VRay::Plugins::MtlMulti VRay::Plugins::MtlOSL VRay::Plugins::MtlObjBBox VRay::Plugins::MtlOverride VRay::Plugins::MtlRenderStats VRay::Plugins::MtlRoundEdges VRay::Plugins::MtlSelectRE VRay::Plugins::MtlSingleBRDF VRay::Plugins::MtlStreakFade VRay::Plugins::MtlUVWScaler VRay::Plugins::MtlUVWSelect VRay::Plugins::MtlVRmat VRay::Plugins::MtlWrapper VRay::Plugins::MtlWrapperMaya VRay::Plugins::NURBSCurve VRay::Plugins::Node VRay::Plugins::OutputDeepWriter VRay::Plugins::OutputTest VRay::Plugins::ParticleTex VRay::Plugins::PhxShaderCache VRay::Plugins::PhxShaderFoam VRay::Plugins::PhxShaderFoamTex VRay::Plugins::PhxShaderOceanTex VRay::Plugins::PhxShaderPGroup VRay::Plugins::PhxShaderParticleTex VRay::Plugins::PhxShaderPrtLoader VRay::Plugins::PhxShaderSim VRay::Plugins::PhxShaderSimGeom VRay::Plugins::PhxShaderSimMesh VRay::Plugins::PhxShaderSimVol VRay::Plugins::PhxShaderTex VRay::Plugins::PhxShaderTexAlpha VRay::Plugins::PhxShaderVoxelShader VRay::Plugins::PluginAtTime VRay::Plugins::PluginParameterStore VRay::Plugins::RTEngine VRay::Plugins::RawBitmapBuffer VRay::Plugins::RenderChannelAmbientOcclusion VRay::Plugins::RenderChannelBackToBeauty VRay::Plugins::RenderChannelBumpNormals VRay::Plugins::RenderChannelCoat VRay::Plugins::RenderChannelCoatReflection VRay::Plugins::RenderChannelColor VRay::Plugins::RenderChannelColorModo VRay::Plugins::RenderChannelCoverage VRay::Plugins::RenderChannelCryptomatte VRay::Plugins::RenderChannelDRBucket VRay::Plugins::RenderChannelDenoiser VRay::Plugins::RenderChannelExtraTex VRay::Plugins::RenderChannelExtraTexFloat VRay::Plugins::RenderChannelExtraTexInt VRay::Plugins::RenderChannelGlossiness VRay::Plugins::RenderChannelInteger VRay::Plugins::RenderChannelInvertedFloat VRay::Plugins::RenderChannelLightMix VRay::Plugins::RenderChannelLightSelect VRay::Plugins::RenderChannelLightingAnalysis VRay::Plugins::RenderChannelMtlID VRay::Plugins::RenderChannelMultiMatte VRay::Plugins::RenderChannelNodeID VRay::Plugins::RenderChannelNormals VRay::Plugins::RenderChannelObjectSelect VRay::Plugins::RenderChannelPluginCategory VRay::Plugins::RenderChannelRenderID VRay::Plugins::RenderChannelSheen VRay::Plugins::RenderChannelSheenReflection VRay::Plugins::RenderChannelToon VRay::Plugins::RenderChannelVelocity VRay::Plugins::RenderChannelZDepth VRay::Plugins::RenderView VRay::Plugins::SceneMetadata VRay::Plugins::SceneModifierTest VRay::Plugins::SettingsCamera VRay::Plugins::SettingsCameraDof VRay::Plugins::SettingsCaustics VRay::Plugins::SettingsColorMapping VRay::Plugins::SettingsColorMappingModo VRay::Plugins::SettingsCurrentFrame VRay::Plugins::SettingsDMCGI VRay::Plugins::SettingsDMCSampler VRay::Plugins::SettingsDecal VRay::Plugins::SettingsDefaultDisplacement VRay::Plugins::SettingsEXR VRay::Plugins::SettingsEnvironment VRay::Plugins::SettingsGI VRay::Plugins::SettingsGaussianSplats VRay::Plugins::SettingsHair VRay::Plugins::SettingsImageSampler VRay::Plugins::SettingsIrradianceMap VRay::Plugins::SettingsJPEG VRay::Plugins::SettingsLightCache VRay::Plugins::SettingsLightLinker VRay::Plugins::SettingsLightTree VRay::Plugins::SettingsMemoryTracker VRay::Plugins::SettingsMotionBlur VRay::Plugins::SettingsOptions VRay::Plugins::SettingsOutput VRay::Plugins::SettingsPNG VRay::Plugins::SettingsPhotonMap VRay::Plugins::SettingsPluginCategory VRay::Plugins::SettingsPtexBaker VRay::Plugins::SettingsRTEngine VRay::Plugins::SettingsRaycaster VRay::Plugins::SettingsRegionsGenerator VRay::Plugins::SettingsRenderChannels VRay::Plugins::SettingsSGI VRay::Plugins::SettingsTGA VRay::Plugins::SettingsTIFF VRay::Plugins::SettingsTextureCache VRay::Plugins::SettingsUnitsInfo VRay::Plugins::SettingsVFB VRay::Plugins::SettingsVRST VRay::Plugins::SettingsVertexBaker VRay::Plugins::SphereFade VRay::Plugins::SphereFadeGizmo VRay::Plugins::SphericalHarmonicsExporter VRay::Plugins::SphericalHarmonicsRenderer VRay::Plugins::SunLight VRay::Plugins::TexAColor VRay::Plugins::TexAColorChannel VRay::Plugins::TexAColorOp VRay::Plugins::TexAnimationCurve VRay::Plugins::TexBerconDistortion VRay::Plugins::TexBerconGrad VRay::Plugins::TexBerconNoise VRay::Plugins::TexBerconTile VRay::Plugins::TexBerconWood VRay::Plugins::TexBezierCurve VRay::Plugins::TexBezierCurveColor VRay::Plugins::TexBifrostVVMix VRay::Plugins::TexBillboardParticle VRay::Plugins::TexBitmap VRay::Plugins::TexBlend VRay::Plugins::TexBlendBumpNormal VRay::Plugins::TexBulge VRay::Plugins::TexBump2Glossiness VRay::Plugins::TexC4DNoise VRay::Plugins::TexCellular VRay::Plugins::TexChecker VRay::Plugins::TexClamp VRay::Plugins::TexCloth VRay::Plugins::TexColor2Scalar VRay::Plugins::TexColor8Mix VRay::Plugins::TexColorAndAlpha VRay::Plugins::TexColorAverage VRay::Plugins::TexColorCondition VRay::Plugins::TexColorConstant VRay::Plugins::TexColorCorrect VRay::Plugins::TexColorCurve VRay::Plugins::TexColorExponential VRay::Plugins::TexColorLogic VRay::Plugins::TexColorMask VRay::Plugins::TexColorMathBasic VRay::Plugins::TexColorSwitch VRay::Plugins::TexColorToFloat VRay::Plugins::TexCombineColor VRay::Plugins::TexCombineColorLightMtl VRay::Plugins::TexCombineFloat VRay::Plugins::TexCompMax VRay::Plugins::TexComplexFresnel VRay::Plugins::TexComposite VRay::Plugins::TexCondition VRay::Plugins::TexCondition2 VRay::Plugins::TexCurvature VRay::Plugins::TexCustomBitmap VRay::Plugins::TexDent VRay::Plugins::TexDirt VRay::Plugins::TexDisplacacementRestrict VRay::Plugins::TexDistance VRay::Plugins::TexDistanceBetween VRay::Plugins::TexDistanceToObject VRay::Plugins::TexEdges VRay::Plugins::TexExtMaterialID VRay::Plugins::TexFalloff VRay::Plugins::TexFloat VRay::Plugins::TexFloatComposite VRay::Plugins::TexFloatCondition VRay::Plugins::TexFloatConstant VRay::Plugins::TexFloatCorrect VRay::Plugins::TexFloatLogic VRay::Plugins::TexFloatMask VRay::Plugins::TexFloatOp VRay::Plugins::TexFloatPerVertexHairSampler VRay::Plugins::TexFloatToColor VRay::Plugins::TexForestColor VRay::Plugins::TexFresnel VRay::Plugins::TexGradRamp VRay::Plugins::TexGradient VRay::Plugins::TexGranite VRay::Plugins::TexGrid VRay::Plugins::TexHSVToRGB VRay::Plugins::TexHairRootSampler VRay::Plugins::TexHairSampler VRay::Plugins::TexICC VRay::Plugins::TexIDIntegerMap VRay::Plugins::TexInt VRay::Plugins::TexIntToFloat VRay::Plugins::TexInterpLinear VRay::Plugins::TexInvert VRay::Plugins::TexInvertFloat VRay::Plugins::TexLayered VRay::Plugins::TexLayeredMax VRay::Plugins::TexLayeredNuke VRay::Plugins::TexLeather VRay::Plugins::TexLuminance VRay::Plugins::TexLut VRay::Plugins::TexMarble VRay::Plugins::TexMarbleMax VRay::Plugins::TexMaskMax VRay::Plugins::TexMaxGamma VRay::Plugins::TexMaxHairInfo VRay::Plugins::TexMaxPointCloudColor VRay::Plugins::TexMayaCloth VRay::Plugins::TexMayaContrast VRay::Plugins::TexMayaConversion VRay::Plugins::TexMayaFluid VRay::Plugins::TexMayaFluidCombined VRay::Plugins::TexMayaFluidProcedural VRay::Plugins::TexMayaFluidTransformed VRay::Plugins::TexMayaHairColor VRay::Plugins::TexMayaHairIncandescence VRay::Plugins::TexMayaHairTransparency VRay::Plugins::TexMayaLeather VRay::Plugins::TexMayaMountain VRay::Plugins::TexMayaSolidFractal VRay::Plugins::TexMayaStucco VRay::Plugins::TexMeshVertexColor VRay::Plugins::TexMeshVertexColorChannel VRay::Plugins::TexMeshVertexColorWithDefault VRay::Plugins::TexMix VRay::Plugins::TexModoBlendLayersColor VRay::Plugins::TexModoBlendLayersScalar VRay::Plugins::TexModoChanModColorCorrect VRay::Plugins::TexModoChanModLogic VRay::Plugins::TexModoDiffuseRoughness VRay::Plugins::TexModoEnvironmentColor VRay::Plugins::TexModoExtractAlpha VRay::Plugins::TexModoExtractColor VRay::Plugins::TexModoFresnelSchlick VRay::Plugins::TexModoInvert VRay::Plugins::TexModoInvertChannels VRay::Plugins::TexModoInvertFloat VRay::Plugins::TexModoLowHigh VRay::Plugins::TexModoMaxColorComponent VRay::Plugins::TexModoOpacityToVRayWeight VRay::Plugins::TexModoProcess VRay::Plugins::TexModoProcessFloat VRay::Plugins::TexModoRayType VRay::Plugins::TexModoReflectionRoughness VRay::Plugins::TexModoRefractionRoughness VRay::Plugins::TexModoSampler VRay::Plugins::TexModoSpecularRoughness VRay::Plugins::TexModoStencil VRay::Plugins::TexModoSwizzle VRay::Plugins::TexModoUVResetAndFalloff VRay::Plugins::TexMotionOcclusion VRay::Plugins::TexMtlxSignature VRay::Plugins::TexMulti VRay::Plugins::TexMultiFloat VRay::Plugins::TexMultiProjection VRay::Plugins::TexMultiX VRay::Plugins::TexNoise VRay::Plugins::TexNoiseMax VRay::Plugins::TexNoiseMaya VRay::Plugins::TexNormalBump VRay::Plugins::TexNormalMapFlip VRay::Plugins::TexOCIO VRay::Plugins::TexOSL VRay::Plugins::TexOSLOutputSelector VRay::Plugins::TexOceanSpectra VRay::Plugins::TexOpenVDB VRay::Plugins::TexOutput VRay::Plugins::TexParticleDiffuse VRay::Plugins::TexParticleId VRay::Plugins::TexParticleSampler VRay::Plugins::TexParticleShape VRay::Plugins::TexPatternID VRay::Plugins::TexPerVertexHairSampler VRay::Plugins::TexPlusMinusAverage VRay::Plugins::TexPtex VRay::Plugins::TexRGBMultiplyMax VRay::Plugins::TexRGBTintMax VRay::Plugins::TexRGBToHSV VRay::Plugins::TexRamp VRay::Plugins::TexRandom VRay::Plugins::TexRaySwitch VRay::Plugins::TexRemap VRay::Plugins::TexRemapFloat VRay::Plugins::TexRgbaCombine VRay::Plugins::TexRgbaSplit VRay::Plugins::TexRock VRay::Plugins::TexSampler VRay::Plugins::TexScalarCurve VRay::Plugins::TexScalarExponential VRay::Plugins::TexScalarHairRootSampler VRay::Plugins::TexScalarMathBasic VRay::Plugins::TexScatterSurfaceColor VRay::Plugins::TexSetRange VRay::Plugins::TexSimplexNoise VRay::Plugins::TexSky VRay::Plugins::TexSmoke VRay::Plugins::TexSnow VRay::Plugins::TexSoftbox VRay::Plugins::TexSpeckle VRay::Plugins::TexSplat VRay::Plugins::TexStencil VRay::Plugins::TexStucco VRay::Plugins::TexSurfIncidence VRay::Plugins::TexSurfaceLuminance VRay::Plugins::TexSwirl VRay::Plugins::TexSwitch VRay::Plugins::TexSwitchFloat VRay::Plugins::TexSwitchInt VRay::Plugins::TexSwitchMatrix VRay::Plugins::TexSwitchTransform VRay::Plugins::TexTemperature VRay::Plugins::TexTemperatureToColor VRay::Plugins::TexThickness VRay::Plugins::TexThinFilm VRay::Plugins::TexTiles VRay::Plugins::TexToVector VRay::Plugins::TexTriPlanar VRay::Plugins::TexUVW VRay::Plugins::TexUVWGenToTexture VRay::Plugins::TexUserColor VRay::Plugins::TexUserInteger VRay::Plugins::TexUserScalar VRay::Plugins::TexVRayFurSampler VRay::Plugins::TexVectorOp VRay::Plugins::TexVectorProduct VRay::Plugins::TexVectorToColor VRay::Plugins::TexVertexColorDirect VRay::Plugins::TexVoxelData VRay::Plugins::TexWater VRay::Plugins::TexWaves VRay::Plugins::TexWood VRay::Plugins::TexXSIBitmap VRay::Plugins::TexXSICell VRay::Plugins::TexXSIColorBalance VRay::Plugins::TexXSIColorCorrection VRay::Plugins::TexXSIColorMix VRay::Plugins::TexXSIFabric VRay::Plugins::TexXSIFalloff VRay::Plugins::TexXSIFlagstone VRay::Plugins::TexXSIGradient VRay::Plugins::TexXSIHLSAdjust VRay::Plugins::TexXSIIntensity VRay::Plugins::TexXSILayered VRay::Plugins::TexXSIMulti VRay::Plugins::TexXSINormalMap VRay::Plugins::TexXSIRGBAKeyer VRay::Plugins::TexXSIRipple VRay::Plugins::TexXSIRock VRay::Plugins::TexXSIScalar2Color VRay::Plugins::TexXSIScalarInvert VRay::Plugins::TexXSISnow VRay::Plugins::TexXSIVein VRay::Plugins::TexXSIVertexColorLookup VRay::Plugins::TexXSIWeightmapColorLookup VRay::Plugins::TexXSIWeightmapLookup VRay::Plugins::TexXSIWood VRay::Plugins::TextureFloatPluginCategory VRay::Plugins::TextureIntPluginCategory VRay::Plugins::TextureMatrixPluginCategory VRay::Plugins::TexturePluginCategory VRay::Plugins::TextureTransformPluginCategory VRay::Plugins::TextureVectorPluginCategory VRay::Plugins::TransformToTex VRay::Plugins::TrimmingRegion VRay::Plugins::TrimmingRegionsComplex VRay::Plugins::UVWGenBercon VRay::Plugins::UVWGenChannel VRay::Plugins::UVWGenEnvironment VRay::Plugins::UVWGenExplicit VRay::Plugins::UVWGenMaxPointCloud VRay::Plugins::UVWGenMayaPlace2dTexture VRay::Plugins::UVWGenModo VRay::Plugins::UVWGenObject VRay::Plugins::UVWGenObjectBBox VRay::Plugins::UVWGenPlanarWorld VRay::Plugins::UVWGenPluginCategory VRay::Plugins::UVWGenProjection VRay::Plugins::UVWGenRandomizer VRay::Plugins::UVWGenSelect VRay::Plugins::UVWGenSwitch VRay::Plugins::VRScansPMaskElement VRay::Plugins::VRScansZoneElement VRay::Plugins::VRayClipper VRay::Plugins::VRayDecal VRay::Plugins::VRayObjectProperties VRay::Plugins::VRayScene VRay::Plugins::VRaySceneAsset VRay::Plugins::VRayStereoscopicSettings VRay::Plugins::ViewPluginCategory VRay::Plugins::VolumeAerialPerspective VRay::Plugins::VolumeChannels VRay::Plugins::VolumeFog VRay::Plugins::VolumeMulti VRay::Plugins::VolumeScatterFog VRay::Plugins::VolumeVRayToon VRay::Plugins::VolumetricPluginCategory VRay::Plugins::texRenderHair VRay::Plugins::texXSIColor2Alpha VRay::Plugins::texXSIColor2Vector VRay::Plugins::volumeXSIMulti VRay::Plugins::xsiUVWGenChannel VRay::Plugins::xsiUVWGenEnvironment

Public Member Functions

 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.
 

Protected Member Functions

 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

InstanceId internalId
 
const VRayRendererpRenderer
 

Friends

class Internal::Access
 
class Internal::BinaryValueBuilder
 
class Internal::BinaryValueParser
 
std::ostream & operator<< (std::ostream &stream, const Plugin &plugin)
 
class PropertyRuntimeMeta
 
class VRayRenderer
 
class VUtils::Value
 

Detailed Description

A thin wrapper (or a handle) around actual V-Ray scene objects. It holds a reference to the real object, so constructing and destructing a Plugin does no effect the scene. Only VRayRenderer methods can create and remove the underlying V-Ray objects.

Member Function Documentation

◆ getAColor()

AColor VRay::Plugin::getAColor ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as AColor

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getBool()

bool VRay::Plugin::getBool ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as bool

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getCategories()

PluginCategories VRay::Plugin::getCategories ( ) const

Returns all the plugin categories this plugin belongs to, such as being a Light or a Material, etc.

Returns
PluginCategories

◆ getColor()

Color VRay::Plugin::getColor ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as Color

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getColorList()

ColorList VRay::Plugin::getColorList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as ColorList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getDouble()

double VRay::Plugin::getDouble ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as float

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getFloat()

float VRay::Plugin::getFloat ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as float

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getFloatList()

FloatList VRay::Plugin::getFloatList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as FloatList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getInt() [1/2]

int VRay::Plugin::getInt ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as int

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getInt() [2/2]

int VRay::Plugin::getInt ( const char *  propertyName,
double  time = TiMe::Default() 
) const

Returns the value of a property as int

Parameters
propertyName

◆ getIntList()

IntList VRay::Plugin::getIntList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as IntList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getKeyframeTimes() [1/2]

std::vector< double > VRay::Plugin::getKeyframeTimes ( const char *  propertyName) const

Returns a vector of keyframe times if the property is animated or an empty one if it's not

Parameters
propertyName

◆ getKeyframeTimes() [2/2]

std::vector< double > VRay::Plugin::getKeyframeTimes ( const char *  propertyName,
bool &  ok 
) const

Returns a vector of keyframe times if the property is animated or an empty one if it's not

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getMatrix()

Matrix VRay::Plugin::getMatrix ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as Matrix

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getMeta()

PluginMeta VRay::Plugin::getMeta ( ) const

Returns an object used to obtain meta information about this plugin's type.

Returns
PluginMeta

◆ getName()

const char * VRay::Plugin::getName ( ) const

Returns the name of the plugin instance.

Returns
The pointer is valid while the plugin instance inside VRayRenderer is alive or until a new name is set with setName().

◆ getPlugin()

PluginRefT< Plugin > VRay::Plugin::getPlugin ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as a Plugin reference

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getPluginList()

PluginList VRay::Plugin::getPluginList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as PluginList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getPropertyRuntimeMeta()

PropertyRuntimeMeta VRay::Plugin::getPropertyRuntimeMeta ( const char *  propertyName) const

Returns an object used to obtain meta information about the property runtime instance.

Returns
PropertyRuntimeMeta

◆ getString()

std::string VRay::Plugin::getString ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as string

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getStringList()

StringList VRay::Plugin::getStringList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as StringList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getTransform()

Transform VRay::Plugin::getTransform ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as Transform

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getTransformList()

TransformList VRay::Plugin::getTransformList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as VectorList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getValue() [1/2]

Value VRay::Plugin::getValue ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property encapsulated in Value class Can return simple as well as complex properties such as lists

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getValue() [2/2]

Value VRay::Plugin::getValue ( const char *  propertyName,
double  time = TiMe::Default() 
) const

Returns the value of a property encapsulated in Value class Can return simple as well as complex properties such as lists

◆ getValueAsString() [1/2]

std::string VRay::Plugin::getValueAsString ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as string.

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getValueAsString() [2/2]

std::string VRay::Plugin::getValueAsString ( const char *  propertyName,
double  time = TiMe::Default() 
) const

Returns the value of a property as string.

Parameters
propertyName

◆ getValueList()

ValueList VRay::Plugin::getValueList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as ValueList. Works only if it really is a generic list.

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getVector()

Vector VRay::Plugin::getVector ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as Vector

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ getVectorList()

VectorList VRay::Plugin::getVectorList ( const char *  propertyName,
bool &  ok,
double  time = TiMe::Default() 
) const

Returns the value of a property as VectorList

Parameters
propertyName
ok- set to true if the property has been successfully read, set to false otherwise

◆ isEmpty()

bool VRay::Plugin::isEmpty ( ) const
noexcept

Returns true if the Plugin does not hold a valid reference (e.g. default constructed Plugin()). This should be checked after calling methods that return a Plugin refernce, but success is not guaranteed.

◆ isNotEmpty()

bool VRay::Plugin::isNotEmpty ( ) const
noexcept

Returns false if the Plugin does not hold a valid reference (e.g. default constructed Plugin()) This should be checked after calling methods that return a Plugin, but success is not guaranteed.

◆ isPropertyAnimated()

bool VRay::Plugin::isPropertyAnimated ( const char *  propertyName) const

Returns whether the current property contains animated values or not

Returns
true - animated, false - not animated

◆ isValid()

bool VRay::Plugin::isValid ( ) const

Returns false if the Plugin does not reference a valid V-Ray scene object at this time. This is a superset of the !isEmpty() check because it also checks if the referenced V-Ray object still exists. This may not be true if the object was deleted through another Plugin reference. This check may have greater performance impact if called very often. The isEmpty()/isNotEmpty() check is very light.

◆ setArray() [1/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const Color  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Colors and count elements

Returns
true - success, false - failure

◆ setArray() [2/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const double  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of floats and count elements The doubles are fast converted to floats during the operation Can also be used to set Vector, Color, AColor, Matrix amd Transform and lists of them

Returns
true - success, false - failure

◆ setArray() [3/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const float  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of floats and count elements Can also be used to set Vector, Color, AColor, Matrix amd Transform and lists of them

Returns
true - success, false - failure

◆ setArray() [4/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const int  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of ints and count elements

Returns
true - success, false - failure

◆ setArray() [5/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const Plugin  plugins[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Plugins and count elements

Returns
true - success, false - failure

◆ setArray() [6/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const std::string  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of strings and count elements

Return values
true- success, false - failure

◆ setArray() [7/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const Transform  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Transforms and count elements

Returns
true - success, false - failure

◆ setArray() [8/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const Value  values[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Values and count elements

Returns
true - success, false - failure

◆ setArray() [9/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
const Vector  data[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Vectors and count elements

Returns
true - success, false - failure

◆ setArray() [10/10]

bool VRay::Plugin::setArray ( const char *  propertyName,
Value  valuesToMove[],
size_t  count,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Values and count elements Warning: This function applies move semantics onto the input elements and thus destroys their values!

Returns
true - success, false - failure

◆ setName()

bool VRay::Plugin::setName ( const char *  newName)

Sets a new name for this plugin instance.

Parameters
newNameIf another plugin with the same name already exists this call fails.
Returns
true on success, false on failure.

◆ setValue() [1/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const AColor value,
double  time = TiMe::Default() 
)

Sets the value of a property as AColor

Returns
true - success, false - failure

◆ setValue() [2/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const bool  value,
double  time = TiMe::Default() 
)

Sets the value of a property as bool

Returns
true - success, false - failure

◆ setValue() [3/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const char *  str,
double  time = TiMe::Default() 
)

Sets the value of a property to string

Returns
true - success, false - failure

◆ setValue() [4/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const Color value,
double  time = TiMe::Default() 
)

Sets the value of a property as Color

Returns
true - success, false - failure

◆ setValue() [5/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const ColorList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of Colors

Returns
true - success, false - failure

◆ setValue() [6/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const double  value,
double  time = TiMe::Default() 
)

Sets the value of a property as double

Returns
true - success, false - failure

◆ setValue() [7/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const float  value,
double  time = TiMe::Default() 
)

Sets the value of a property as float

Returns
true - success, false - failure

◆ setValue() [8/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const FloatList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of floats

Returns
true - success, false - failure

◆ setValue() [9/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const int  value,
double  time = TiMe::Default() 
)

Sets the value of a property as int

Returns
true - success, false - failure

◆ setValue() [10/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const IntList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of ints

Returns
true - success, false - failure

◆ setValue() [11/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const Matrix value,
double  time = TiMe::Default() 
)

Sets the value of a property as Matrix

Returns
true - success, false - failure

◆ setValue() [12/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const PluginList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of plugins

Return values
true- success, false - failure

◆ setValue() [13/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const PluginRefT< Plugin > &  pluginRef,
double  time = TiMe::Default() 
)

Sets the value of a property as a Plugin reference

Returns
true - success, false - failure

◆ setValue() [14/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const std::string &  str,
double  time = TiMe::Default() 
)

Sets the value of a property to string

Returns
true - success, false - failure

◆ setValue() [15/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const StringList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of strings

Return values
true- success, false - failure

◆ setValue() [16/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const Transform transform,
double  time = TiMe::Default() 
)

Sets the value of a property as Transform

Returns
true - success, false - failure

◆ setValue() [17/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const TransformList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of Transforms

Returns
true - success, false - failure

◆ setValue() [18/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const Value value,
double  time = TiMe::Default() 
)

Sets the value of a property as Value (can set complex structures like lists and lists of lists)

Returns
true - success, false - failure

◆ setValue() [19/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const ValueList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of Values

Returns
true - success, false - failure

◆ setValue() [20/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const Vector value,
double  time = TiMe::Default() 
)

Sets the value of a property as Vector

Returns
true - success, false - failure

◆ setValue() [21/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const VectorList &  value,
double  time = TiMe::Default() 
)

Sets the value of a property to a list of Vectors

Returns
true - success, false - failure

◆ setValue() [22/22]

bool VRay::Plugin::setValue ( const char *  propertyName,
const void *  data,
size_t  size,
double  time = TiMe::Default() 
)

Sets the value of a property as a list of the underlying type and size in bytes, not elements!

Returns
true - success, false - failure
Remarks
This is a potentially dangerous method and is here for backwards compatibility. Do not use it!

◆ setValueAsString()

bool VRay::Plugin::setValueAsString ( const char *  propertyName,
const char *  value 
)

Sets the value of a property as string. The property may be of any type.

Parameters
propertyName
valueFor example "3.71" or "Color(1.0, 0.0, 0.0)" or "myTexturePlugin::out_alpha"
Returns
true - success, false - failure

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