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

A class encapsulating various export settings. More...

Public Member Functions

 ExportSettings ()
 Constructs a default instance of ExportSettings.
 
ExportSettings AddSubFileInfo (IEnumerable< SubFileInfo > subFileInfo)
 Adds a collection of SubFileInfo descriptions regarding the type of the exported plugins and the name suffixes of the export files. More...
 
ExportSettings AddSubFileInfo (SubFileInfo subFileInfo)
 Adds a SubFileInfo description regarding the type of the exported plugins and the suffix of the export file name. More...
 
ExportSettings ClearSubFileInfos ()
 Clears the list of added SubFileInfo objects. More...
 
SubFileInfo GetSubFileInfo (int index)
 Gets the SubFileInfo at the specified index. More...
 

Properties

IList< string > AdditionalIncludeFiles [get, set]
 Optional list of files to #include at the end of the main vrscene
 
bool AppendFrameSuffix [get, set]
 Valid only when CurrentFrameOnly=true - appends a %04d frame number to the file name. False by default.
 
bool Compressed [get, set]
 True if plugin property values of lists should be compressed (requires HexArrays=true). True by default.
 
bool CurrentFrameOnly [get, set]
 If true only the current keyframe is exported, otherwise the whole timeline. False by default.
 
bool HexArrays [get, set]
 Whether to use hex format for lists of numbers. True by default.
 
bool HexTransforms [get, set]
 Whether to use hex format for Transform. False by default.
 
string HostAppString [get, set]
 An optional string identifying the host application, version, etc.
 
bool Incremental [get, set]
 Valid only when CurrentFrameOnly=true and AppendFrameSuffix=false - set to true to incrementally append keyframe data after initial export with false. False by default.
 
double LeftInterval [get, set]
 Valid only when CurrentFrameOnly=true. The (closed) time interval left of the current time in which to include keyframes, i.e. [left, right). Value 0.0 means automatic 1 frame based on FPS. Default value 0.0.
 
IList< PluginPluginExportList [get, set]
 If this is not empty, only these plugins will be exported instead of all plugins in the scene.
 
bool PrintHeader [get, set]
 Whether to write the comment section with version and time info. True by default.
 
bool RenderElementsSeparateFolders [get, set]
 True if render elements should be in separate folders. False by default.
 
double RightInterval [get, set]
 Valid only when CurrentFrameOnly=true. The (open) time interval right of the current time in which to include keyframes, i.e. [left, right). Value 0.0 means automatic 1 frame based on FPS. Default value 0.0.
 
string SceneBasePath [get, set]
 An optional absolute scene base path that can be used for resolving relative paths for the .vrfiles file.
 
bool StripPaths [get, set]
 If enabled, the paths for bitmap textures and other external files are stripped from the file so that only the filenames remain. False by default.
 
bool VrdataExport [get, set]
 Enable or disable vrdata file writing. False by default.
 
int VrdataFileSizeLimitMiB [get, set]
 Limit the size of the vrdata file. If this limit is reached another file is started.
 
int VrdataSmallBufferSizeLimit [get, set]
 Set a limit for the min size of the buffer. If the buffer is smaller it is not written to the vrdata file.
 
bool VrfilesComputeHashes [get, set]
 True if MD5 and SHA256 hashes should be computed and written in the .vrfiles file for each resolved asset file. False by default.
 
bool VrfilesExport [get, set]
 Enable or disable vrfiles file writing. False by default.
 

Detailed Description

A class encapsulating various export settings.

Member Function Documentation

◆ AddSubFileInfo() [1/2]

ExportSettings VRay.ExportSettings.AddSubFileInfo ( IEnumerable< SubFileInfo subFileInfo)

Adds a collection of SubFileInfo descriptions regarding the type of the exported plugins and the name suffixes of the export files.

Parameters
subFileInfoAn enumeration of SubFileInfo objects.
Returns
A self reference.

◆ AddSubFileInfo() [2/2]

ExportSettings VRay.ExportSettings.AddSubFileInfo ( SubFileInfo  subFileInfo)

Adds a SubFileInfo description regarding the type of the exported plugins and the suffix of the export file name.

Parameters
subFileInfoA SubFileInfo object.
Returns
A self reference.

◆ ClearSubFileInfos()

ExportSettings VRay.ExportSettings.ClearSubFileInfos ( )

Clears the list of added SubFileInfo objects.

Returns
A self reference.

◆ GetSubFileInfo()

SubFileInfo VRay.ExportSettings.GetSubFileInfo ( int  index)

Gets the SubFileInfo at the specified index.

Parameters
indexThe index of the SubFileInfo specifying the order of addition.
Returns
A SubFileInfo object.

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