Overview
The .vrmesh files and proxy objects can be created through the vrayCreateProxy command. Using the command with different flags allows you to create, export, import, etc. the proxy.
You can use the vrayCreateProxy command with both MEL and Python. For the purpose of the documentation, the examples below are written in MEL.
Syntax
The various options are described below:
Option | Description |
---|---|
˗exportType | Specifies the type of export: 1 - export all selected objects in a single .vrmesh file. 2 - export each selected object in a separate .vrmesh file. |
˗previewFaces | Specifies the number of faces in the viewport preview for the proxy object. |
˗dir | Specifies the path where the .vrmesh file(s) will be created. |
˗fname | Specifies the file name when exporting to multiple .vrmesh files. |
˗makeBackup | Create a backup .ma file containing just the exported objects. |
˗overwrite | If specified, any existing .vrmesh files will be overwritten; otherwise, an error will be printed. |
˗vertexColorsOn | If specified, vertex color sets are also exported. |
˗ignoreHiddenObjects | If specified, hidden objects are not exported. |
˗createProxyNode | After successful export, replaces the original geometry with proxy nodes. Returns a list of the names of the transform nodes directly above the created nodes. |
˗node | The name for the new proxy node when -createProxyNode is specified, and a single proxy is created. |
˗animOn | If specified, animated .vrmesh files are created. |
˗animType | If -animOn is specified, this option determines the animation interval to export: 1 - playback range 2 - animation range 3 - explicit frame range specified with -startFrame and -endFrame |
˗startFrame | Specifies the start animation frame when using explicit range. |
˗endFrame | Specifies the end animation frame when using explicit range. |
˗velocityOn | If specified, vertex velocity is also exported. This enables motion blur and smooth interpolation of the resulting animated proxies. |
˗velocityIntervalStart | A value between 0.0 and 1.0 with the time position within a frame for the initial vertex positions. |
˗velocityIntervalEnd | A value between 0.0 and 1.0 with the time position within a frame for the ending vertex positions. |
-oneVoxelPerMesh | If specified, export each separate mesh to a single voxel. |
-facesPerVoxel | An integer value that specifies the maximum number of faces that a voxel can hold. |
-includeTransformation | If specified and exporting objects in separate files , bake the transformation of each object into the vertex positions in the resulting .vrmesh files. |
-previewType | The simplification method to use when generating a preview. Must be one of the following: "clustering" "edge_collapse" "face_sampling" "combined" |
-pointSize | If higher than 0.0, create a point cloud representation of the mesh. The specified value is used as a minimum size of the disk samples. |
-existing | Uses existing vrmesh file instead of creating a new one. |
-noMaterial | If specified, does not create a VRayMeshMaterial for the proxy. |
Examples
Export Mesh Example
The command operates on the current selection and has the following syntax, where curly braces {} denote a choice between several values separated by a pipe |, and options in brackets [] are optional:
Single proxy export:
vrayCreateProxy -exportType {1|2} -previewFaces $previewFaces -dir $path -fname $filename [-makeBackup] [-vertexColorsOn] [-ignoreHiddenObjects] [-includeTransformation] [-oneVoxelPerMesh] [-facesPerVoxel $facesPerVoxel]
Animation export:
vrayCreateProxy -exportType {1|2} -dir $path -fname $filename -animOn -animType {0|1|2} -startFrame $startFrame -endFrame $endFrame -previewFaces $previewFaces [-createProxyNode -node $newNodeName] [-velocityOn -velocityIntervalStart $velocityIntervalStart -velocityIntervalEnd $velocityIntervalEnd] [-previewType $previewType];
Note that $filename has to include the correct extension of the file, that is .abc or .vrmesh.
Import Mesh Example
.vrmesh example:
vrayCreateProxy -node $nodename -existing -dir $path.vrmesh -createProxyNode
alembic example:
vrayCreateProxy -node $nodename -existing -dir $path.abc -createProxyNode
This command creates a proxy node and points it to an existing file (.vrmesh or .abc). Please note that "$path.vrmesh/abc" is the full path of the file. $nodename is the name of the new proxy node.