Square Enix © Goodbye Kansas

Table of Contents


Overview


The .vrmesh files and proxy objects can be created through the vrayCreateProxy command. Using the command with different flags allows you to export geometry to proxy files and load files to V-Ray Proxy objects.

You can use the vrayCreateProxy command with both MEL and Python. For the purpose of the documentation, the examples below are written in MEL. 

For a list of all available arguments, run the command with the -help flag in the Maya Script Editor: vrayCreateProxy -help. 


Syntax


The various options are described below:

OptionDescription
-createProxyNode 

After successful export, replaces the original geometry with proxy nodes. Can also be used along with the -existing option to load an existing proxy file.
Returns a list of the names of the transform nodes directly above the created nodes.

-dirSpecifies the path where the .vrmesh file(s) will be created.
-existingUses existing vrmesh file instead of creating a new one.
-nodeThe name for the new proxy node when -createProxyNode is specified, and a single proxy is created.
-animStart Override start frame when importing a sequence of files with <frame> filename tag.
-animLength Override end frame when importing a sequence of files with <frame> filename tag.
-objectPath Starting path in the Alembic object hierarchy when importing .abc files
-geomToLoad 

Type of geometry to load:4

 1- None

2 - Bounding Box

3 - Preview

 

4 - Full geometry

-flipAxis  Transforms from Max to Maya coordinate system.
-noMaterialIf specified, does not create a VRayMeshMaterial for the proxy.

-vrayImportProxyRules

Imports material override rules (.xml) from a specified location.

-vrayExportProxyRulesExports material override rules (.xml) to a specified location.
-newProxyNode Uses the new VRayProxy node instead of the old VRayMesh.
-animOnIf 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

-startFrameSpecifies the start animation frame when using explicit range.
-endFrameSpecifies the end animation frame when using explicit range.
-exportHierarchyExports full paths including transforms and groups instead of just shape names.
-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.

-fnameSpecifies the file name when exporting to multiple .vrmesh files.
-facesPerVoxelAn integer value that specifies the maximum number of faces that a voxel can hold.
-oneVoxelPerMeshIf specified, export each separate mesh to a single voxel.
-ignoreHiddenObjectsIf specified, hidden objects are not exported.
-includeTransformationIf specified and exporting objects in separate files , bake the transformation of each object into the vertex positions in the resulting .vrmesh files.
-makeBackupCreate a backup .ma file containing just the exported objects.
-overwriteIf specified, any existing .vrmesh files will be overwritten; otherwise, an error will be printed.
-previewFacesSpecifies the number of faces in the viewport preview for the proxy object.
-previewType

The simplification method to use when generating a preview. Must be one of the following:

"clustering"

"edge_collapse"

"face_sampling"

"combined"

-lastSelectedAsPreview Uses the last selected object as a preview mesh.
-pointSizeIf 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.
-velocityIntervalEndA value between 0.0 and 1.0 with the time position within a frame for the ending vertex positions.
-velocityIntervalStartA value between 0.0 and 1.0 with the time position within a frame for the initial vertex positions.
-velocityOnIf specified, vertex velocity is also exported. This enables motion blur and smooth interpolation of the resulting animated proxies.
The time samples within a frame for computing the velocity are specified with the -velocityIntervalStart and -velocityIntervalEnd options.
-vertexColorsOnIf specified, vertex color sets are also exported.

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 node in the Maya scene.

 

Import/Export Material Rules Example

Import material rules example:

vrayImportProxyRules "pSphere_vrayproxy" "D:/Maya/Proxy/test.xml";

 

Export material rules example:

vrayExportProxyRules "pSphere_vrayproxy" "D:/Maya/Proxy/test.xml";

 

These commands are equivalent to the existing Import/Export material rules button (), but allow for scripting.