Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
en:vrayscatter-maya [2018/03/29 08:04] anvar [Installation On Linux Batch Render Nodes] |
en:vrayscatter-maya [2022/11/23 12:30] (current) anvar [System Requirements] |
||
---|---|---|---|
Line 3: | Line 3: | ||
====== VRayScatter For Maya Manual ====== | ====== VRayScatter For Maya Manual ====== | ||
- | **[[http://rendering.ru/ru_en/ | + | **[[https://icube3d.com/ |
Usually scenes in Maya with a great amount of even identical objects take a lot of space on HDD, consumes a lot of time for loading, and it is very hard to work with. **VRayScatter For Maya** is created to solve these problems. | Usually scenes in Maya with a great amount of even identical objects take a lot of space on HDD, consumes a lot of time for loading, and it is very hard to work with. **VRayScatter For Maya** is created to solve these problems. | ||
Line 16: | Line 16: | ||
__Operating system: | __Operating system: | ||
* **Windows** | * **Windows** | ||
- | * **Mac OS X** (for Mac users: please contact us before purchasing) | + | * **Mac OS X** |
* **Linux** | * **Linux** | ||
__Maya versions:__ | __Maya versions:__ | ||
- | * **Windows**: | + | * **Windows**: |
- | * **Mac OS X**: 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2016.5, 2017 | + | * **Mac OS X**: 2016, 2016.5, 2017, 2018, 2019, 2020 |
- | * **Linux**: | + | * **Linux**: 2016, 2016.5, 2017, 2018, 2019, 2020, 2022, 2023 |
__V-Ray versions: | __V-Ray versions: | ||
- | * **Windows** / **Linux** / **Mac OS X**: 2.0, 2.2, 2.3, 2.4, 3.1 ( 3.00.01 is not compatible, but some nightlies like 3.05.04 are compatible), 3.3 , 3.4, 3.5, 3.6, 4.x (Next) (best performs with latest nightlies) | + | * **Windows** / **Linux** / **Mac OS X**: 3.6, 4.x (Next), 5, 6 |
- | __Architecture: | ||
- | * **Windows**: | ||
- | * **Mac OS X**: 32/64 bit | ||
- | * **Linux**: 64 bit | ||
Line 42: | Line 38: | ||
====== Upgrade from 2.x.x to 4.x ====== | ====== Upgrade from 2.x.x to 4.x ====== | ||
- | Version 3.x.x and 4.x now uses only one V-Ray plugin file so you have to remove old conflicting plugins: | + | Version 3.x.x and 4.x now uses only one V-Ray plugin file and since version 4.514 installs only a module, |
* Windows: uninstall previous version of VRayScatter For Maya using the uninstaller. | * Windows: uninstall previous version of VRayScatter For Maya using the uninstaller. | ||
* Linux: remove **libvray_GeomRamProxy.so** and **libvray_TexVRayScatter.so** from / | * Linux: remove **libvray_GeomRamProxy.so** and **libvray_TexVRayScatter.so** from / | ||
Line 51: | Line 47: | ||
=====Installation===== | =====Installation===== | ||
- | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// | + | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// |
To install the program you need to run the **VRayScatterForMaya-< | To install the program you need to run the **VRayScatterForMaya-< | ||
+ | |||
+ | please note, since version 4.514, installs only a module | ||
Line 64: | Line 62: | ||
| | ||
- | Choose Maya version, | + | Choose Maya and V-Ray versions: |
- | | + | |
Check installation paths | Check installation paths | ||
- | | + | |
Start Maya and enable **Load** and/or **Auto load** in Window -> Settings/ | Start Maya and enable **Load** and/or **Auto load** in Window -> Settings/ | ||
| | ||
- | ===== Installation on Windows | + | ===== Installation on Windows |
+ | |||
+ | ==== Batch Rendering ==== | ||
+ | install same as workstation but without activation | ||
+ | |||
+ | or manually copy files | ||
+ | |||
+ | |||
+ | ==== Distributed Rendering | ||
- | Copy **vray_VRayScatter.dll** from //MAYA_ROOT/vray/vrayplugins// | + | Copy **vray_VRayScatter.dll** from //MAYA_ROOT\plug-ins\vrayscatter\vrayplugins// |
(or whichever folder is used for loading vray plugins from, the folder is usually called / | (or whichever folder is used for loading vray plugins from, the folder is usually called / | ||
For example, from: | For example, from: | ||
- | < | + | < |
to:\\ | to:\\ | ||
- | < | + | < |
===== Uninstall ===== | ===== Uninstall ===== | ||
Line 92: | Line 98: | ||
===== Activation ===== | ===== Activation ===== | ||
please see: | please see: | ||
- | http:// | + | http:// |
Line 98: | Line 104: | ||
=====General===== | =====General===== | ||
- | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// | + | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// |
- | + | ||
- | Here is an example file structure of the **VRayScatter For Maya** for Linux / Mac OS X archive: | + | |
- | * **plugins** – plugins: | + | |
- | * **workstation** – artist workstation | + | |
- | * **batch** – for batch render nodes | + | |
- | * **shaders** – description files for V-Ray shaders | + | |
- | * **ui** – UI files for Maya | + | |
- | * **tools** – registration tools | + | |
=====Installation On Linux===== | =====Installation On Linux===== | ||
- | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// | + | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// |
Unpack the archive, open your preferred terminal application, | Unpack the archive, open your preferred terminal application, | ||
Line 127: | Line 124: | ||
- | Select you Maya/V-Ray versions | + | Select you Maya/V-Ray versions, files will be copied to the following folders according to your setup, e.g: |
< | < | ||
- | # cp plugins/ | + | Maya module path |
- | # cp plugins/ | + | Maya module plugin path / |
</ | </ | ||
- | Install the Maya UI files: | ||
- | < | ||
- | # cp ui/ | ||
- | # cp ui/ | ||
- | # cp ui/ | ||
- | # cp ui/ | ||
- | # cp ui/ | ||
- | </ | ||
- | |||
- | Install the V-Ray texture description file: | ||
- | < | ||
- | # cp shaders/ | ||
- | </ | ||
**NOTE**: | **NOTE**: | ||
* Change the installation paths depending on your setup | * Change the installation paths depending on your setup | ||
- | * # - means that command should be executed with root permissions | + | * change paths in VRayScatterForMaya.mod file according to your environment, |
- | ===== Installation On Linux Batch Render Nodes ===== | + | * command should be executed with root permissions |
- | run installer and extract files according to your Maya and V-Ray versions | + | ===== Installation On Linux Render Nodes ===== |
+ | ==== Batch Rendering ==== | ||
- | then copy 3 files to appropriate directories | + | Same as for workstation, but without activation |
- | < | + | |
- | / | + | Run installer, extract files and then copy across rendernodes |
- | / | + | |
- | / | + | |
- | </ | + | |
- | ===== Installation On Linux DR Nodes ===== | + | |
- | For V-Ray " | + | And check .mod file for variables |
+ | ==== Distributed Rendering ==== | ||
+ | |||
+ | For V-Ray " | ||
< | < | ||
$ sudo -i | $ sudo -i | ||
- | # cd ~/ | + | # cd ~/ |
- | # cp libvray_VRayScatter.so / | + | # cp libvray_VRayScatter.so / |
</ | </ | ||
Line 175: | Line 159: | ||
===== Activation on Linux ===== | ===== Activation on Linux ===== | ||
please see: | please see: | ||
- | http:// | + | http:// |
Line 181: | Line 165: | ||
=====Installation on Mac OS X===== | =====Installation on Mac OS X===== | ||
- | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// | + | Please, make sure that you've downloaded the latest version of the plug-in from our [[http:// |
Unpack the archive, open your preferred terminal application, | Unpack the archive, open your preferred terminal application, | ||
Line 257: | Line 241: | ||
This will generate an **// | This will generate an **// | ||
- | Send this file to [[mail@rendering.ru|mail@rendering.ru]] (or your reseller). **Please, attach copy of you receipt or order number to avoid any delays in communication.** | + | Send this file to [[support@icube3d.com|support@icube3d.com]] (or your reseller). **Please, attach copy of you receipt or order number to avoid any delays in communication.** |
In the nearest time (usually within 24 hours) you will get an email from us (or your reseller) with ***.lic** license file attached. Save this file on your hard disk. | In the nearest time (usually within 24 hours) you will get an email from us (or your reseller) with ***.lic** license file attached. Save this file on your hard disk. | ||
Line 272: | Line 256: | ||
</ | </ | ||
- | In case of license malfunction and errors (which can be caused by disk formatting, reinstallation of the operating system or components replacement) you are free to address the developer at any time. Please make sure you download latest version from our forum and generate new ***.id** file. Send it to [[mail@rendering.ru|mail@rendering.ru]] to get your updated ***.lic** file. | + | In case of license malfunction and errors (which can be caused by disk formatting, reinstallation of the operating system or components replacement) you are free to address the developer at any time. Please make sure you download latest version from our forum and generate new ***.id** file. Send it to [[support@icube3d.com|support@icube3d.com]] to get your updated ***.lic** file. |
However, we reserve the right not to issue a new license in case of total replacement of a PC if the | However, we reserve the right not to issue a new license in case of total replacement of a PC if the | ||
Line 293: | Line 277: | ||
===== User Interface ===== | ===== User Interface ===== | ||
- | | + | |
- Select objects to distribute (Mesh or VRayProxy) then select VRayScatter and press Add in «Scatter Objects» rollout. This will connect objects to the “scatterObject” attribute. | - Select objects to distribute (Mesh or VRayProxy) then select VRayScatter and press Add in «Scatter Objects» rollout. This will connect objects to the “scatterObject” attribute. | ||
- If you have added multiple objects tweak the Probability parameter to make all objects visible or use menu Tools -> “Auto Probability”. | - If you have added multiple objects tweak the Probability parameter to make all objects visible or use menu Tools -> “Auto Probability”. | ||
===== Parameters Description ===== | ===== Parameters Description ===== | ||
- | **Scatter Objects rollout** | + | ==== Scatter Objects rollout |
+ | | ||
* Scatter Objects – list of scattered objects. | * Scatter Objects – list of scattered objects. | ||
- | * Draw Color – object' | + | * Color – object' |
+ | * Scale - | ||
* Probability – probability of the object' | * Probability – probability of the object' | ||
* Radius – radius of the collision sphere for the collision solving. Default value is 100% - that corresponds to the object size. | * Radius – radius of the collision sphere for the collision solving. Default value is 100% - that corresponds to the object size. | ||
Line 306: | Line 293: | ||
* Penetration – sets the blur of the collisions border areas. | * Penetration – sets the blur of the collisions border areas. | ||
* Mask color variance – threshold for colorful mask. | * Mask color variance – threshold for colorful mask. | ||
- | * Hide From Render – hide original object from render. | + | * Hide From Render – hide original object from render. |
+ | * Apply Offset | ||
+ | * Apply Geometry Transform | ||
+ | |||
+ | ==== Distribution ==== | ||
+ | | ||
- | **Distribution** | ||
* Seed – initial random seed. | * Seed – initial random seed. | ||
* Amount – render objects amount. | * Amount – render objects amount. | ||
- | * Preview – preview objects amount. | + | * Preview – preview objects amount. |
- | * Instancing type: | + | * UV Set - |
- | * Intance | + | |
- | * Node - use this type for smaller object amounts (< 100,000) and if you need to scatter displaced or smoothed geometry. This type also provides motion blur when using animated VRayProxy and compatible with VRay RT. | + | |
* Use Mask – use distribution mask texture. | * Use Mask – use distribution mask texture. | ||
* Colorful - use colorful mask; this will place objects by the texture using object "Draw Color" | * Colorful - use colorful mask; this will place objects by the texture using object "Draw Color" | ||
- | * Texture – distribution mask texture. This could be any Maya texture. | + | |
+ | * Texture | ||
+ | * Color Set | ||
+ | * Both | ||
+ | | ||
+ | * Color Set - | ||
* Solve Collisions – solve scatter objects collisions. | * Solve Collisions – solve scatter objects collisions. | ||
- | **Pattern** | + | ==== Distribution Cache==== |
+ | | ||
+ | |||
+ | ==== Pattern | ||
+ | | ||
* Type – pattern type | * Type – pattern type | ||
* Random | * Random | ||
- | | + | * Pattern 1 - Pattern distribution uses UV-mapping to work, thus object must have proper UV-coordinates. |
- | * Pattern - Pattern distribution uses UV-mapping to work, thus object must have proper UV-coordinates. | + | * Pattern 2 |
- | * Lock Offsets – when this option is enabled you will to control both U and V offsets simultaneously. | + | * Pattern 3 |
- | | + | * Random Sticked |
- | * V Offset – V offset. | + | |
+ | * Count | ||
+ | * Per Square | ||
+ | | ||
+ | | ||
+ | * V Offset – V offset. | ||
+ | |||
+ | ==== Rotation==== | ||
+ | | ||
- | **Rotation** | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
+ | * Look At | ||
+ | * Attach | ||
+ | * Mode: Rotate or Track | ||
+ | * X, Z, Y | ||
+ | * Align To Face | ||
* Align To Normal – align object to surface normal. | * Align To Normal – align object to surface normal. | ||
* Constant – constant rotation (for each axis). | * Constant – constant rotation (for each axis). | ||
Line 339: | Line 350: | ||
* Texture contrast – quick control of texture contrast. | * Texture contrast – quick control of texture contrast. | ||
- | **Scale** | + | ==== Scale==== |
+ | | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
* Global From/To – global minimum/ | * Global From/To – global minimum/ | ||
Line 347: | Line 360: | ||
* Max Scale – maximum scale that corresponds to the 1.0 color value. | * Max Scale – maximum scale that corresponds to the 1.0 color value. | ||
- | **Offset** | + | ==== Offset |
+ | | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
* Along Normal – offset objects along surface normal. | * Along Normal – offset objects along surface normal. | ||
Line 356: | Line 371: | ||
* Max Offset – maximum offset that corresponds to the 1.0 color value. | * Max Offset – maximum offset that corresponds to the 1.0 color value. | ||
- | **Distance to surface borders** | + | ==== Slope Control ==== |
+ | | ||
+ | |||
+ | | ||
+ | | ||
+ | * Mode | ||
+ | * World Space | ||
+ | * Bounding box | ||
+ | * From/To | ||
+ | * Use Angle | ||
+ | * Invert | ||
+ | * From/To | ||
+ | |||
+ | ==== Mirror ==== | ||
+ | | ||
+ | |||
+ | ==== Distance to surface borders | ||
+ | | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
- | * Distance – maximum distance from object to surface border in which object parameters will be affected. Actual control parameter | + | * Distance – maximum distance from object to surface border in which object parameters will be affected. Actual control parameter |
+ | * Affect Density | ||
+ | * Affect Scale | ||
+ | * Border Density Ramp | ||
+ | * Selected Position | ||
+ | * Selected Value | ||
+ | * Interpolation - None, Linear, Smooth, Spline | ||
+ | * Border Scale Ramp | ||
+ | * Selected position | ||
+ | * Selected Value | ||
+ | * Interpolation - None, Linear, Smooth, Spline | ||
+ | |||
+ | ==== Distance to curve ==== | ||
+ | | ||
- | **Distance to curve borders** | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
* Distance – maximum distance from object to curve in which object parameters will be affected. Actual control parameter behavior could be defined using Density and Scale ramps. | * Distance – maximum distance from object to curve in which object parameters will be affected. Actual control parameter behavior could be defined using Density and Scale ramps. | ||
- | * Attach | + | * Affect Density |
+ | * Affect Scale | ||
+ | * Border | ||
+ | * Curve Border Density Ramp | ||
+ | *Selected position | ||
+ | *Selected Value | ||
+ | *Interpolation - None, Linear, Smooth, Spline | ||
+ | * Curve Border Scale Ramp | ||
+ | *Selected position | ||
+ | *Selected Value | ||
+ | *Interpolation - None, Linear, Smooth, Spline | ||
+ | ==== Mask curve ==== | ||
+ | | ||
- | **Mask curve** | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
- | * Inverse – inverse mask curve behavior. | + | * Inverse – inverse mask curve behaviour. |
- | * Attach | + | * Projection Plane |
+ | * Render-Time Clipping | ||
+ | * Mask Curve Attach | ||
+ | |||
+ | ==== Camera ==== | ||
+ | | ||
- | **Camera** | ||
* Use – quick control to enable/ | * Use – quick control to enable/ | ||
* Use FOV – limits rendered objects to only that are seen from camera field of view. Could save some RAM. | * Use FOV – limits rendered objects to only that are seen from camera field of view. Could save some RAM. | ||
- | * Distance – distance from camera. | + | |
+ | | ||
+ | * Distance Near | ||
* Affect Density – limits objects visibility to distance. | * Affect Density – limits objects visibility to distance. | ||
- | * Attach | + | * Camera |
+ | |||
+ | ==== Render ==== | ||
+ | | ||
- | **Render** | ||
* Use Light Linker - this feature will transfer Light Linker setup from objects used in scatter to instanced objects. | * Use Light Linker - this feature will transfer Light Linker setup from objects used in scatter to instanced objects. | ||
- | * Use Tint Texture - check [[vrayscatter-maya# | + | * Use Hair |
- | * Replace Color - this will replace the color with Tint Texture color, otherwise it will be mixed. | + | * Use Subdivision / Displacement |
- | * Type - mix type. | + | * Preview in Viewport |
- | * Amount - mix amount. | + | * Tint Texture - check [[vrayscatter-maya# |
- | * Tint Texture - color variance control texture. | + | * Use Render Stats |
- | * Use Render Stats - this feature allows to setup render stats options | + | * Visibility |
+ | * Cast Shadows | ||
+ | * Visible To Camera | ||
+ | * Visible To Reflections | ||
+ | * Visible To Refractions | ||
+ | * Visible To GI | ||
+ | * Render ID Mode | ||
+ | * No ID | ||
+ | * Instance Render ID | ||
+ | * Unique Per Scatter | ||
+ | * Unique Per Instance | ||
+ | * Object ID Mode | ||
+ | * Custom Object ID | ||
+ | * Instance Object ID | ||
+ | * Instance / Proxy Object ID | ||
+ | * Object ID | ||
+ | * Motion Blur | ||
+ | * No Motion Blur | ||
+ | * Motion Blur and Velocity Channel | ||
+ | * Velocity Channel Only | ||
+ | * Use Rayserver Instancer (WIP, Next) | ||
+ | * Static instancer | ||
- | **VRayProxy Animation** | + | ==== VRayProxy Animation |
+ | | ||
This feature works only when scattering VRayProxy and allows to assign different frame offset. | This feature works only when scattering VRayProxy and allows to assign different frame offset. | ||
- | * Use – quick control to enable/ | + | * Generate Random Offsets |
* Offset From/To – From/To frame offset. Actual frame offset is a random value between From and To. | * Offset From/To – From/To frame offset. Actual frame offset is a random value between From and To. | ||
+ | * Max. Difference Offset Random | ||
* Use Offset Texture - use texture to drive frame offset; black = " | * Use Offset Texture - use texture to drive frame offset; black = " | ||
+ | * Animation Offset Texture | ||
- | **Viewport** | + | ==== Viewport |
- | * Draw style – objects draw style in the viewport. | + | |
+ | |||
+ | * Draw style – objects draw style in the viewport. | ||
+ | * None | ||
+ | * Point | ||
+ | * Box | ||
+ | * Mesh Preview | ||
+ | * Draw Alpha | ||
+ | * Draw Point Size | ||
* Logo color - color for the locator logo and bounding box. | * Logo color - color for the locator logo and bounding box. | ||
* Logo size – locator logo size. | * Logo size – locator logo size. | ||
- | **Bake** | + | ==== Bake ==== |
+ | | ||
- | This feature allows to " | + | This feature allows to " |
+ | * Bake Mode | ||
+ | * Preview | ||
+ | * Render | ||
* Bake Type | * Bake Type | ||
* Instance - new objects will be linked with one geometry. | * Instance - new objects will be linked with one geometry. | ||
- | * Cope - geometry data will also be duplicated. | + | * Copy - geometry data will also be duplicated. |
+ | * Duplicate Input Connection | ||
+ | * Group | ||
+ | ==== Textures ==== | ||
+ | | ||
===== VRayScatter Texture ===== | ===== VRayScatter Texture ===== | ||
Line 426: | Line 530: | ||
**if this is happens right after activation, please restart Maya** | **if this is happens right after activation, please restart Maya** | ||
- | In case of license malfunction and errors (which can be caused by disk reformatting, | + | In case of license malfunction and errors (which can be caused by disk reformatting, |
- | + | ||
- | However, in the case of total replacement of a computer by a new one new license is not provided more often than once in half a year. | + | |
- | ===== Installation error ===== | + | |
- | + | ||
- | | + | |
- | + | ||
- | Make sure Maya is not running, please double check in task manager too. | + | |
- | + | ||
- | Make sure you are installing with the administrator rights (on Windows 7 right click “Run as administrator”) . | + | |
- | + | ||
- | Make sure you choose right installation path | + | |
===== Does not appear in create menu ===== | ===== Does not appear in create menu ===== | ||
- | * Please make sure all files were placed into right folders | + | * Please make sure all files were placed into right folders. |
* Start Maya and enable Load and/or Auto load in Window → Settings/ | * Start Maya and enable Load and/or Auto load in Window → Settings/ | ||
- | ===== Manual installation ===== | ||
- | < | ||
- | 2009-2014 - are Maya versions | ||
- | 20, 22, 23, 24, nightly - are V-Ray versions (20 => 2.0, 24 => 2.4 | ||
- | etc, nightly means some nightly V-Ray build) | ||
- | |||
- | VRayScatter.so, | ||
- | Files started with libvray_* (vray_* for Windwos) are V-Ray plugins | ||
- | and should go to VRAY_FOR_MAYA< | ||
- | |||
- | Mel files goes to MAYA_SCRIPT_PATH (AETemplate* could be stored under | ||
- | the AETemplates for convenience). | ||
- | Shader file should go to VRAY_FOR_MAYA2014_MAIN_x64/ | ||
- | |||
- | If you are using default setup then: | ||
- | MAYA_SCRIPT_PATH = / | ||
- | AETemplates = / | ||
- | MAYA_PLUG_IN_PATH = / | ||
- | VRAY_FOR_MAYA2014_PLUGINS_x64 = / | ||
- | Shader txt file goes to / | ||
- | </ | ||
- | ===== log ===== | + | ===== Log ===== |
Check your log for any errors, also from version 4.405.154 you can now setup environment variable ICUBE_DEBUG | Check your log for any errors, also from version 4.405.154 you can now setup environment variable ICUBE_DEBUG | ||
===== Other errors ===== | ===== Other errors ===== | ||
- | Please make sure you download and install latest version from our [[http:// | + | Please make sure you download and install latest version from our [[http:// |
- | If this haven' | + | If this haven' |
the following information: | the following information: | ||
* VRayScatter version | * VRayScatter version | ||
- | * OS version (including 32 or 64 bit) | ||
* Maya version | * Maya version | ||
* V-Ray version | * V-Ray version | ||
* Some screenshots will be useful | * Some screenshots will be useful | ||
* The scene file facing the problem (if possible) | * The scene file facing the problem (if possible) |