VRay SDK for C#
Loading...
Searching...
No Matches
VRay.Plugins.Plugin Class Reference

Inherits VRay.Plugins.IPluginRef< T >.

Inherited by 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.BSDFPointParticle, VRay.Plugins.BakeView, VRay.Plugins.BitmapBuffer, 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.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.LightRectangle, VRay.Plugins.LightSphere, VRay.Plugins.LightSpot, VRay.Plugins.LightSpotMax, VRay.Plugins.LuminaireBaker, VRay.Plugins.MaterialOverrider, 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.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.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.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.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.VolumeAerialPerspective, VRay.Plugins.VolumeChannels, VRay.Plugins.VolumeFog, VRay.Plugins.VolumeMulti, VRay.Plugins.VolumeScatterFog, VRay.Plugins.VolumeVRayToon, VRay.Plugins.texRenderHair, VRay.Plugins.texXSIColor2Alpha, VRay.Plugins.texXSIColor2Vector, VRay.Plugins.volumeXSIMulti, VRay.Plugins.xsiUVWGenChannel, and VRay.Plugins.xsiUVWGenEnvironment.

Public Member Functions

PluginCategories GetCategories ()
 Gets all the plugin categories this plugin belongs to, such as being a Light or a Material, etc.
 
long GetIntegerID ()
 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.
 
double[] GetKeyframeTimes (string propertyName)
 Return an array of keyframe times if the property contains animated values or an empty array if the property is not animated. More...
 
PluginMeta GetMeta ()
 Gets a plugin meta object.
 
string GetName ()
 Gets the name of the plugin.
 
PropertyRuntimeMeta GetPropertyRuntimeMeta (string propertyName)
 Gets an object with runtime meta information about the property. More...
 
VRayRenderer GetRenderer ()
 Gets a reference to the renderer which created the plugin.
 
string Gettype ()
 Gets the type of the plugin. More...
 
object GetValue (string propertyName)
 Gets the value of the specified property as a generic object. More...
 
object GetValue (string propertyName, double time)
 Gets the value of the specified property as a generic object. More...
 
AColor GetValueAsAColor (string propertyName)
 Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown. More...
 
AColor GetValueAsAColor (string propertyName, double time)
 Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown. More...
 
bool GetValueAsBool (string propertyName)
 Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown. More...
 
bool GetValueAsBool (string propertyName, double time)
 Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown. More...
 
Color GetValueAsColor (string propertyName)
 Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown. More...
 
Color GetValueAsColor (string propertyName, double time)
 Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown. More...
 
double GetValueAsDouble (string propertyName)
 Gets the value of the specified property if it is of type double. Otherwise an exception is thrown. More...
 
double GetValueAsDouble (string propertyName, double time)
 Gets the value of the specified property if it is of type double. Otherwise an exception is thrown. More...
 
float GetValueAsFloat (string propertyName)
 Gets the value of the specified property if it is of type float. Otherwise an exception is thrown. More...
 
float GetValueAsFloat (string propertyName, double time)
 Gets the value of the specified property if it is of type float. Otherwise an exception is thrown. More...
 
int GetValueAsInt (string propertyName)
 Gets the value of the specified property if it is of type int. Otherwise an exception is thrown. More...
 
int GetValueAsInt (string propertyName, double time)
 Gets the value of the specified property if it is of type int. Otherwise an exception is thrown. More...
 
IList GetValueAsList (string propertyName)
 Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList. More...
 
IList GetValueAsList (string propertyName, double time)
 Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList. More...
 
IList< T > GetValueAsList< T > (string propertyName)
 Gets the value of the specified property if it is of a list type. More...
 
IList< T > GetValueAsList< T > (string propertyName, double time)
 Gets the value of the specified property if it is of a list type. More...
 
Matrix GetValueAsMatrix (string propertyName)
 Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown. More...
 
Matrix GetValueAsMatrix (string propertyName, double time)
 Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown. More...
 
IPluginRef GetValueAsPluginRef (string propertyName)
 Gets the value of the specified property if it is of type Plugin/PluginRef. More...
 
IPluginRef GetValueAsPluginRef (string propertyName, double time)
 Gets the value of the specified property if it is of type Plugin/PluginRef. More...
 
string GetValueAsString (string propertyName)
 Gets the string representation of the specified plugin property value. More...
 
string GetValueAsString (string propertyName, double time)
 Gets the string representation of the specified plugin property value. More...
 
Transform GetValueAsTransform (string propertyName)
 Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown. More...
 
Transform GetValueAsTransform (string propertyName, double time)
 Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown. More...
 
Vector GetValueAsVector (string propertyName)
 Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown. More...
 
Vector GetValueAsVector (string propertyName, double time)
 Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown. More...
 
bool IsPropertyAnimated (string propertyName)
 Returns whether the current value of the property is animated or not. More...
 
bool IsValid ()
 Check whether this object contains a valid reference to a V-Ray plugin instance. (The reference may become invalid if the actual plugin it refers to has been deleted.) More...
 
bool SetName (string newName)
 Sets a new name of the plugin. More...
 
bool SetValue (string propertyName, AColor value)
 Sets the value of the specified property as AColor. More...
 
bool SetValue (string propertyName, AColor value, double time)
 Sets the value of the specified property as AColor. More...
 
bool SetValue (string propertyName, bool value)
 Sets the value of the specified property as bool. More...
 
bool SetValue (string propertyName, bool value, double time)
 Sets the value of the specified property as bool. More...
 
bool SetValue (string propertyName, Color value)
 Sets the value of the specified property as Color. More...
 
bool SetValue (string propertyName, Color value, double time)
 Sets the value of the specified property as Color. More...
 
bool SetValue (string propertyName, Color[] value)
 Sets the value of the specified property as an array of Colors. More...
 
bool SetValue (string propertyName, Color[] value, double time)
 Sets the value of the specified property as an array of Colors. More...
 
bool SetValue (string propertyName, Color[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a Color array. More...
 
bool SetValue (string propertyName, Color[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a Color array. More...
 
bool SetValue (string propertyName, double value)
 Sets the value of the specified property as double. More...
 
bool SetValue (string propertyName, double value, double time)
 Sets the value of the specified property as double. More...
 
bool SetValue (string propertyName, double[] value)
 Sets the value of the specified property as an array of doubles. More...
 
bool SetValue (string propertyName, double[] value, double time)
 Sets the value of the specified property as an array of doubles. More...
 
bool SetValue (string propertyName, double[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a double array. More...
 
bool SetValue (string propertyName, double[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a double array. More...
 
bool SetValue (string propertyName, float value)
 Sets the value of the specified property as float. More...
 
bool SetValue (string propertyName, float value, double time)
 Sets the value of the specified property as float. More...
 
bool SetValue (string propertyName, float[] value)
 Sets the value of the specified property as an array of floats. More...
 
bool SetValue (string propertyName, float[] value, double time)
 Sets the value of the specified property as an array of floats. More...
 
bool SetValue (string propertyName, float[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a float array. More...
 
bool SetValue (string propertyName, float[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a float array. More...
 
bool SetValue (string propertyName, IList< Color > value)
 Sets the value of the specified property as a list of Colors. More...
 
bool SetValue (string propertyName, IList< Color > value, double time)
 Sets the value of the specified property as a list of Colors. More...
 
bool SetValue (string propertyName, IList< double > value)
 Sets the value of the specified property as alist of doubles. More...
 
bool SetValue (string propertyName, IList< double > value, double time)
 Sets the value of the specified property as alist of doubles. More...
 
bool SetValue (string propertyName, IList< float > value)
 Sets the value of the specified property as a list of floats. More...
 
bool SetValue (string propertyName, IList< float > value, double time)
 Sets the value of the specified property as a list of floats. More...
 
bool SetValue (string propertyName, IList< int > value)
 Sets the value of the specified property as a list of ints. More...
 
bool SetValue (string propertyName, IList< int > value, double time)
 Sets the value of the specified property as a list of ints. More...
 
bool SetValue (string propertyName, IList< Vector > value)
 Sets the value of the specified property as a list of Vectors. More...
 
bool SetValue (string propertyName, IList< Vector > value, double time)
 Sets the value of the specified property as a list of Vectors. More...
 
bool SetValue (string propertyName, int value)
 Sets the value of the specified property as int. More...
 
bool SetValue (string propertyName, int value, double time)
 Sets the value of the specified property as int. More...
 
bool SetValue (string propertyName, int[] value)
 Sets the value of the specified property as an array of ints. More...
 
bool SetValue (string propertyName, int[] value, double time)
 Sets the value of the specified property as an array of ints. More...
 
bool SetValue (string propertyName, int[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of an int array. More...
 
bool SetValue (string propertyName, int[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of an int array. More...
 
bool SetValue (string propertyName, IPluginRef value)
 Sets the value of the specified property as Plugin or Plugin's output parameter. More...
 
bool SetValue (string propertyName, IPluginRef value, double time)
 Sets the value of the specified property as Plugin or Plugin's output parameter. More...
 
bool SetValue (string propertyName, Matrix value)
 Sets the value of the specified property as Matrix. More...
 
bool SetValue (string propertyName, Matrix value, double time)
 Sets the value of the specified property as Matrix. More...
 
bool SetValue (string propertyName, object value)
 Sets the value of the specified property as a generic object. The type is deduced internally. More...
 
bool SetValue (string propertyName, object value, double time)
 Sets the value of the specified property as a generic object. The type is deduced internally. More...
 
bool SetValue (string propertyName, Plugin outPlugin, string outPropertyName)
 Sets the value of the specified property as a Plugin's output parameter. More...
 
bool SetValue (string propertyName, Plugin outPlugin, string outPropertyName, double time)
 Sets the value of the specified property as a Plugin's output parameter. More...
 
bool SetValue (string propertyName, Plugin value)
 Sets the value of the specified property as Plugin. More...
 
bool SetValue (string propertyName, Plugin value, double time)
 Sets the value of the specified property as Plugin. More...
 
bool SetValue (string propertyName, string propertyValue)
 Updates the currently loaded V-Ray scene. More...
 
bool SetValue (string propertyName, string propertyValue, double time)
 Updates the currently loaded V-Ray scene. More...
 
bool SetValue (string propertyName, Transform value)
 Sets the value of the specified property as Transform. More...
 
bool SetValue (string propertyName, Transform value, double time)
 Sets the value of the specified property as Transform. More...
 
bool SetValue (string propertyName, Vector value)
 Sets the value of the specified property as Vector. More...
 
bool SetValue (string propertyName, Vector value, double time)
 Sets the value of the specified property as Vector. More...
 
bool SetValue (string propertyName, Vector[] value)
 Sets the value of the specified property as an array of Vectors. More...
 
bool SetValue (string propertyName, Vector[] value, double time)
 Sets the value of the specified property as an array of Vectors. More...
 
bool SetValue (string propertyName, Vector[] value, int startIndex, int size)
 Sets the value of the specified property as a slice of a Vector array. More...
 
bool SetValue (string propertyName, Vector[] value, int startIndex, int size, double time)
 Sets the value of the specified property as a slice of a Vector array. More...
 
override string ToString ()
 Returns the plugin name. More...
 
string ToString ()
 
new string ToString ()
 

Protected Member Functions

 Plugin (VRayRenderer renderer, long id)
 
 Plugin (VRayRenderer renderer, string name)
 
void Initialize (VRayRenderer vrayRenderer, long pluginId)
 

Properties

string this[string property] [get, set]
 Gets or sets a property with the given name. More...
 
- Properties inherited from VRay.Plugins.IPluginRef< T >
string OutputName [get]
 The output property name of the plugin if any. More...
 
new string OutputName [get]
 The output property name of the plugin if any. More...
 
Plugin Plugin [get]
 The plugin. More...
 
new T Plugin [get]
 The plugin. More...
 

Member Function Documentation

◆ GetKeyframeTimes()

double[] VRay.Plugins.Plugin.GetKeyframeTimes ( string  propertyName)

Return an array of keyframe times if the property contains animated values or an empty array if the property is not animated.

Parameters
propertyNameThe name of the property.
Returns
An array of keyframe times or null on failure (no property with the given name, invalid plugin instance, etc.)

◆ GetPropertyRuntimeMeta()

PropertyRuntimeMeta VRay.Plugins.Plugin.GetPropertyRuntimeMeta ( string  propertyName)

Gets an object with runtime meta information about the property.

Parameters
propertyNameThe name of the property for which meta information will be returned.
Returns
An object with runtime meta information about the poperty.

◆ Gettype()

string VRay.Plugins.Plugin.Gettype ( )

Gets the type of the plugin.

Returns
The class name of the plugin.

◆ GetValue() [1/2]

object VRay.Plugins.Plugin.GetValue ( string  propertyName)

Gets the value of the specified property as a generic object.

Parameters
propertyNameThe plugin parameter name.
Returns
The object.

◆ GetValue() [2/2]

object VRay.Plugins.Plugin.GetValue ( string  propertyName,
double  time 
)

Gets the value of the specified property as a generic object.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.
Returns
The object.

◆ GetValueAsAColor() [1/2]

AColor VRay.Plugins.Plugin.GetValueAsAColor ( string  propertyName)

Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsAColor() [2/2]

AColor VRay.Plugins.Plugin.GetValueAsAColor ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type AColor. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsBool() [1/2]

bool VRay.Plugins.Plugin.GetValueAsBool ( string  propertyName)

Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsBool() [2/2]

bool VRay.Plugins.Plugin.GetValueAsBool ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type bool. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsColor() [1/2]

Color VRay.Plugins.Plugin.GetValueAsColor ( string  propertyName)

Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsColor() [2/2]

Color VRay.Plugins.Plugin.GetValueAsColor ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type Color. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsDouble() [1/2]

double VRay.Plugins.Plugin.GetValueAsDouble ( string  propertyName)

Gets the value of the specified property if it is of type double. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsDouble() [2/2]

double VRay.Plugins.Plugin.GetValueAsDouble ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type double. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsFloat() [1/2]

float VRay.Plugins.Plugin.GetValueAsFloat ( string  propertyName)

Gets the value of the specified property if it is of type float. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsFloat() [2/2]

float VRay.Plugins.Plugin.GetValueAsFloat ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type float. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsInt() [1/2]

int VRay.Plugins.Plugin.GetValueAsInt ( string  propertyName)

Gets the value of the specified property if it is of type int. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsInt() [2/2]

int VRay.Plugins.Plugin.GetValueAsInt ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type int. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsList() [1/2]

IList VRay.Plugins.Plugin.GetValueAsList ( string  propertyName)

Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList.

Parameters
propertyNameThe plugin parameter name.
Returns
The list or null if the value is not a list.

◆ GetValueAsList() [2/2]

IList VRay.Plugins.Plugin.GetValueAsList ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is a list. (This simply casts the result of GetValue() to IList.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.
Returns
The list or null if the value is not a list.

◆ GetValueAsList< T >() [1/2]

IList< T > VRay.Plugins.Plugin.GetValueAsList< T > ( string  propertyName)

Gets the value of the specified property if it is of a list type.

Parameters
propertyNameThe plugin parameter name.
Returns
The list or null if the value is not a list or cannot be converted to a list of the given type.

◆ GetValueAsList< T >() [2/2]

IList< T > VRay.Plugins.Plugin.GetValueAsList< T > ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of a list type.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.
Returns
The list or null if the value is not a list or cannot be converted to a list of the given type.

◆ GetValueAsMatrix() [1/2]

Matrix VRay.Plugins.Plugin.GetValueAsMatrix ( string  propertyName)

Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsMatrix() [2/2]

Matrix VRay.Plugins.Plugin.GetValueAsMatrix ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type Matrix. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsPluginRef() [1/2]

IPluginRef VRay.Plugins.Plugin.GetValueAsPluginRef ( string  propertyName)

Gets the value of the specified property if it is of type Plugin/PluginRef.

Parameters
propertyNameThe plugin parameter name.
Returns
Plugin or PluginRef. null if the property has a different type or has never been assigned.

◆ GetValueAsPluginRef() [2/2]

IPluginRef VRay.Plugins.Plugin.GetValueAsPluginRef ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type Plugin/PluginRef.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.
Returns
Plugin or PluginRef. null if the property has a different type or has never been assigned.

◆ GetValueAsString() [1/2]

string VRay.Plugins.Plugin.GetValueAsString ( string  propertyName)

Gets the string representation of the specified plugin property value.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsString() [2/2]

string VRay.Plugins.Plugin.GetValueAsString ( string  propertyName,
double  time 
)

Gets the string representation of the specified plugin property value.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsTransform() [1/2]

Transform VRay.Plugins.Plugin.GetValueAsTransform ( string  propertyName)

Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsTransform() [2/2]

Transform VRay.Plugins.Plugin.GetValueAsTransform ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type Transform. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ GetValueAsVector() [1/2]

Vector VRay.Plugins.Plugin.GetValueAsVector ( string  propertyName)

Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.

◆ GetValueAsVector() [2/2]

Vector VRay.Plugins.Plugin.GetValueAsVector ( string  propertyName,
double  time 
)

Gets the value of the specified property if it is of type Vector. Otherwise an exception is thrown.

Parameters
propertyNameThe plugin parameter name.
timeThe time, when the value is requested.

◆ IsPropertyAnimated()

bool VRay.Plugins.Plugin.IsPropertyAnimated ( string  propertyName)

Returns whether the current value of the property is animated or not.

Parameters
propertyNameThe name of the property.
Returns
true if animated, false otherwise

◆ IsValid()

bool VRay.Plugins.Plugin.IsValid ( )

Check whether this object contains a valid reference to a V-Ray plugin instance. (The reference may become invalid if the actual plugin it refers to has been deleted.)

Returns
true if the plugin is valid, false otherwise.

◆ SetName()

bool VRay.Plugins.Plugin.SetName ( string  newName)

Sets a new name of the plugin.

Returns
true on success.

◆ SetValue() [1/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
AColor  value 
)

Sets the value of the specified property as AColor.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [2/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
AColor  value,
double  time 
)

Sets the value of the specified property as AColor.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [3/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
bool  value 
)

Sets the value of the specified property as bool.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [4/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
bool  value,
double  time 
)

Sets the value of the specified property as bool.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [5/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Color  value 
)

Sets the value of the specified property as Color.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [6/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Color  value,
double  time 
)

Sets the value of the specified property as Color.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [7/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Color[]  value 
)

Sets the value of the specified property as an array of Colors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [8/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Color[]  value,
double  time 
)

Sets the value of the specified property as an array of Colors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [9/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Color[]  value,
int  startIndex,
int  size 
)

Sets the value of the specified property as a slice of a Color array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
Returns
false if an error occurred, such as wrong type

◆ SetValue() [10/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Color[]  value,
int  startIndex,
int  size,
double  time 
)

Sets the value of the specified property as a slice of a Color array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [11/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
double  value 
)

Sets the value of the specified property as double.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [12/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
double  value,
double  time 
)

Sets the value of the specified property as double.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [13/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
double[]  value 
)

Sets the value of the specified property as an array of doubles.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [14/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
double[]  value,
double  time 
)

Sets the value of the specified property as an array of doubles.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [15/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
double[]  value,
int  startIndex,
int  size 
)

Sets the value of the specified property as a slice of a double array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
Returns
false if an error occurred, such as wrong type

◆ SetValue() [16/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
double[]  value,
int  startIndex,
int  size,
double  time 
)

Sets the value of the specified property as a slice of a double array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [17/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
float  value 
)

Sets the value of the specified property as float.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [18/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
float  value,
double  time 
)

Sets the value of the specified property as float.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [19/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
float[]  value 
)

Sets the value of the specified property as an array of floats.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [20/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
float[]  value,
double  time 
)

Sets the value of the specified property as an array of floats.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [21/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
float[]  value,
int  startIndex,
int  size 
)

Sets the value of the specified property as a slice of a float array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
Returns
false if an error occurred, such as wrong type

◆ SetValue() [22/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
float[]  value,
int  startIndex,
int  size,
double  time 
)

Sets the value of the specified property as a slice of a float array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [23/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< Color value 
)

Sets the value of the specified property as a list of Colors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [24/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< Color value,
double  time 
)

Sets the value of the specified property as a list of Colors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [25/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< double >  value 
)

Sets the value of the specified property as alist of doubles.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [26/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< double >  value,
double  time 
)

Sets the value of the specified property as alist of doubles.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [27/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< float >  value 
)

Sets the value of the specified property as a list of floats.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [28/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< float >  value,
double  time 
)

Sets the value of the specified property as a list of floats.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [29/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< int >  value 
)

Sets the value of the specified property as a list of ints.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [30/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< int >  value,
double  time 
)

Sets the value of the specified property as a list of ints.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [31/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< Vector value 
)

Sets the value of the specified property as a list of Vectors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [32/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IList< Vector value,
double  time 
)

Sets the value of the specified property as a list of Vectors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [33/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
int  value 
)

Sets the value of the specified property as int.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [34/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
int  value,
double  time 
)

Sets the value of the specified property as int.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [35/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
int[]  value 
)

Sets the value of the specified property as an array of ints.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [36/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
int[]  value,
double  time 
)

Sets the value of the specified property as an array of ints.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [37/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
int[]  value,
int  startIndex,
int  size 
)

Sets the value of the specified property as a slice of an int array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
Returns
false if an error occurred, such as wrong type

◆ SetValue() [38/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
int[]  value,
int  startIndex,
int  size,
double  time 
)

Sets the value of the specified property as a slice of an int array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [39/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IPluginRef  value 
)

Sets the value of the specified property as Plugin or Plugin's output parameter.

Parameters
propertyNameThe plugin parameter name.
valueThe plugin reference to connect to.
Returns
false if an error occurred, such as wrong type or parameter name

◆ SetValue() [40/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
IPluginRef  value,
double  time 
)

Sets the value of the specified property as Plugin or Plugin's output parameter.

Parameters
propertyNameThe plugin parameter name.
valueThe plugin reference to connect to.
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type or parameter name

◆ SetValue() [41/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Matrix  value 
)

Sets the value of the specified property as Matrix.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [42/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Matrix  value,
double  time 
)

Sets the value of the specified property as Matrix.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [43/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
object  value 
)

Sets the value of the specified property as a generic object. The type is deduced internally.

Parameters
propertyNameThe plugin parameter name.
valueThe value

◆ SetValue() [44/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
object  value,
double  time 
)

Sets the value of the specified property as a generic object. The type is deduced internally.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.

◆ SetValue() [45/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Plugin  outPlugin,
string  outPropertyName 
)

Sets the value of the specified property as a Plugin's output parameter.

Parameters
propertyNameThe plugin parameter name.
outPluginThe plugin to connect to.
outPropertyNameThe name of the output parameter in V-Ray style, not PascalCase
Returns
false if an error occurred, such as wrong type or parameter name

◆ SetValue() [46/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Plugin  outPlugin,
string  outPropertyName,
double  time 
)

Sets the value of the specified property as a Plugin's output parameter.

Parameters
propertyNameThe plugin parameter name.
outPluginThe plugin to connect to.
outPropertyNameThe name of the output parameter in V-Ray style, not PascalCase
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type or parameter name

◆ SetValue() [47/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Plugin  value 
)

Sets the value of the specified property as Plugin.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [48/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Plugin  value,
double  time 
)

Sets the value of the specified property as Plugin.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [49/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
string  propertyValue 
)

Updates the currently loaded V-Ray scene.

Parameters
propertyNameThe name of the plugin parameter whose value will be changed.
propertyValueThe value of the plugin parameter.
Returns
False if setting the value failed. Check renderer's LastError

◆ SetValue() [50/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
string  propertyValue,
double  time 
)

Updates the currently loaded V-Ray scene.

Parameters
propertyNameThe name of the plugin parameter whose value will be changed.
propertyValueThe value of the plugin parameter.
timeThe time, when the value will be changed.
Returns
False if setting the value failed. Check renderer's LastError

◆ SetValue() [51/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Transform  value 
)

Sets the value of the specified property as Transform.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [52/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Transform  value,
double  time 
)

Sets the value of the specified property as Transform.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [53/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Vector  value 
)

Sets the value of the specified property as Vector.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occurred, such as wrong type

◆ SetValue() [54/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Vector  value,
double  time 
)

Sets the value of the specified property as Vector.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ SetValue() [55/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Vector[]  value 
)

Sets the value of the specified property as an array of Vectors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
Returns
false if an error occured, such as wrong type

◆ SetValue() [56/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Vector[]  value,
double  time 
)

Sets the value of the specified property as an array of Vectors.

Parameters
propertyNameThe plugin parameter name.
valueThe value
timeThe time, when the value will be changed.
Returns
false if an error occured, such as wrong type

◆ SetValue() [57/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Vector[]  value,
int  startIndex,
int  size 
)

Sets the value of the specified property as a slice of a Vector array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
Returns
false if an error occurred, such as wrong type

◆ SetValue() [58/58]

bool VRay.Plugins.Plugin.SetValue ( string  propertyName,
Vector[]  value,
int  startIndex,
int  size,
double  time 
)

Sets the value of the specified property as a slice of a Vector array.

Parameters
propertyNameThe plugin parameter name.
valueThe array to slice. Must not be null!
startIndexStarting offset; not checked!
sizeLength of the slice; not checked!
timeThe time, when the value will be changed.
Returns
false if an error occurred, such as wrong type

◆ ToString()

override string VRay.Plugins.Plugin.ToString ( )

Returns the plugin name.

Implements VRay.Plugins.IPluginRef< T >.

Property Documentation

◆ this[string property]

string VRay.Plugins.Plugin.this[string property]
getset

Gets or sets a property with the given name.

Parameters
propertyThe property name.
Returns
The string value of the property.

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