VRay SDK for C#
Loading...
Searching...
No Matches
VRay.TiMe Struct Reference

A helper struct, used in Plugin.SetValue and Plugin.GetValue interfaces. Could be used either with a given time (double), or with the special values of TiMe.Default or TiMe.None (see below) More...

Public Member Functions

 TiMe (double time)
 Constructs a TiMe object from a given time (double) More...
 
override string ToString ()
 

Static Public Member Functions

static implicit operator double (TiMe time)
 Implicit cast to a double from a given TiMe object More...
 
static operator TiMe (double time)
 Explicit cast to a TiMe object from a given time (double) More...
 

Properties

static double Default [get]
 The Default value (double) of the TiMe struct In case used in Plugin.SetValue, it will set the given plugin property value at VRayRenderer.Time (the current time) In case used in Plugin.GetValue, it will return the plugin property value at VRayRenderer.Time (the current time) More...
 
static double None [get]
 The None value (double) of the TiMe struct In case used in Plugin.SetValue, the given plugin property will be reset to non-animated state In case used in Plugin.GetValue, it will return the plugin property value at VRayRenderer.Time (the current time) More...
 

Detailed Description

A helper struct, used in Plugin.SetValue and Plugin.GetValue interfaces. Could be used either with a given time (double), or with the special values of TiMe.Default or TiMe.None (see below)

Constructor & Destructor Documentation

◆ TiMe()

VRay.TiMe.TiMe ( double  time)

Constructs a TiMe object from a given time (double)

Parameters
timeThe time (double)
Returns
The TiMe object

Member Function Documentation

◆ operator double()

static implicit VRay.TiMe.operator double ( TiMe  time)
static

Implicit cast to a double from a given TiMe object

Parameters
timeA TiMe object
Returns
The double value of the given TiMe object

◆ operator TiMe()

static VRay.TiMe.operator TiMe ( double  time)
explicitstatic

Explicit cast to a TiMe object from a given time (double)

Parameters
timeThe time (double)
Returns
The TiMe struct

Property Documentation

◆ Default

double VRay.TiMe.Default
staticget

The Default value (double) of the TiMe struct In case used in Plugin.SetValue, it will set the given plugin property value at VRayRenderer.Time (the current time) In case used in Plugin.GetValue, it will return the plugin property value at VRayRenderer.Time (the current time)

Returns
The Default value (double) of the TiMe struct

◆ None

double VRay.TiMe.None
staticget

The None value (double) of the TiMe struct In case used in Plugin.SetValue, the given plugin property will be reset to non-animated state In case used in Plugin.GetValue, it will return the plugin property value at VRayRenderer.Time (the current time)

Returns
The None value (double) of the TiMe struct

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