Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
en:vraypattern-maya [2013/03/26 16:20]
anvar
en:vraypattern-maya [2017/03/07 09:22] (current)
anvar
Line 3: Line 3:
 ====== VRayPattern For Maya Manual ====== ====== VRayPattern For Maya Manual ======
  
-VRayPattern allows to multiply geometry periodically without extra memory consumption. As a sample you can use any tiled geometry (or those with unobtrusive joints). VRayPattern also allows to curve geometry on any surface. The plug-in works in similar way as displacement map. However, displacement map can only use raster or vector maps of pattern to cover the surface of geometry, VRayPattern can use any of the original geometry.+**[[http://​rendering.ru/​ru_en/​vraypattern-maya.html|VRayPattern ​For Maya]]** ​allows to multiply geometry periodically without extra memory consumption. As a sample you can use any tiled geometry (or those with unobtrusive joints). VRayPattern also allows to curve geometry on any surface. The plug-in works in similar way as displacement map. However, displacement map can only use raster or vector maps of pattern to cover the surface of geometry, VRayPattern can use any of the original geometry. 
 + 
 +VrayPattern technology is fundamentally different from the technologies that are used in scattering. Scatters are multiplying individual objects, but pattern is actually a 3d procedural texture.  
 +The consequence of this is unique opportunity but lot of restrictions. 
 + 
 +The unique features include:  
 +Possibility to literally not limit duplicating of elements.  
 +Automatic deformation of objects in accordance with the shape of the surface 
 +Low memory consumption when rendering. 
 + 
 +Restrictions related to the possibility to randomise the elements, possibility to process edges and abilities to limit an area with other tools, except for the physical cut-offs of a surface.  
 +The same goes for the preview in the viewport - unfortunately there are no other possibilities to see anything in the viewport, but to generate and assign appropriate geometry texture;
  
 The plug-in best used where large amount of geometry required, but without great accuracy. The plug-in best used where large amount of geometry required, but without great accuracy.
  
- {{ :​vraypattern-maya:​vraypattern_for_maya.png?​700 | User interface}}+ ​{{:​vraypattern-maya:​vraypattern_for_maya.png?​700| User interface}}
  
-**Downloads** +latest versions can be found on our [[http://forum.rendering.ru/viewforum.php?f=26|forum]]
-  * Windows: ​[[http://cgdo.ru/​rdgroup/​VRayPatternForMaya/​vraypattern_for_maya_1.0.0.exe|vraypattern_for_maya_1.0.0.exe]] +
-  * Linux: [[http://​cgdo.ru/rdgroup/​VRayPatternForMaya/​vraypattern_for_maya_1.0.0_linux.zip|vraypattern_for_maya_1.0.0_linux.zip]] +
-  * Mac OS X: [[http://​cgdo.ru/​rdgroup/​VRayPatternForMaya/​vraypattern_for_maya_1.0.0_osx.zip|vraypattern_for_maya_1.0.0_osx.zip]]+
  
-**Example Scenes** 
-  * [[http://​cgdo.ru/​rdgroup/​VRayPatternForMaya/​vraypattern_test.mb|vraypattern_test.mb]] 
-  * [[http://​cgdo.ru/​rdgroup/​VRayPatternForMaya/​VRayPattern_simple_grass.mb.zip|VRayPattern_simple_grass.mb.zip]] 
- 
-**Quick Start** 
-  * Create VRayPattern Node: Create -> R&D Group -> VRayPattern 
-  * Select base polygon object, select VRayPattern and press "​Attach"​ button near "Base Object"​. Object must have UV! 
-  * Select pattern polygon object, select VRayPattern and press "​Attach"​ button near "​Pattern Object"​. 
-  * Press "Fit Crop Box" button. Edit crop box with "Crop Size" attribute or using manipulator with "Show manipulator tool". 
-  * Press render. 
 ====== System Requirements ====== ====== System Requirements ======
-  +__Operating system:__
-__Operating system:​__ ​+
   * **Windows**   * **Windows**
 +  * **Linux**
   * **Mac OS X**   * **Mac OS X**
-  * **Linux** ​+
  
 __Maya versions:__ __Maya versions:__
-  * **Windows**:​ 2009, 2010, 2011, 2012, 2013 +  * **Windows**:​ 2009, 2010, 2011, 2012, 2013, 2014 
-  * **Mac OS X**: 2010, 2011, 2012, 2013 +  * **Linux**: 2009, 2010, 2011, 2012, 2013, 2014 
-  * **Linux**: 2009, 2010, 2011, 2012, 2013+  * **Mac OS X**: 2010, 2011, 2012, 2013, 2014
  
-__V-Ray versions:__  +__V-Ray versions:​__ 
-  * **Windows** / **Linux** / **Mac OS X**: 1.5, 2.0, 2.2, 2.3+  * **Windows** / **Linux** / **Mac OS X**: 1.5, 2.0, 2.2, 2.3. 2.4
  
 __Architecture:​__ __Architecture:​__
   * **Windows**:​ 32/64 bit   * **Windows**:​ 32/64 bit
-  * **Mac OS X**: 32/64 bit 
   * **Linux**: 64 bit   * **Linux**: 64 bit
 +  * **Mac OS X**: 32/64 bit
  
 **NOTE**: **NOTE**:
   * User must be able to obtain root permissions (for Linux or OS X, using //sudo//, for example) to install **VRayPattern For Maya**.   * User must be able to obtain root permissions (for Linux or OS X, using //sudo//, for example) to install **VRayPattern For Maya**.
  
-====== ​Registration ​======+====== ​Windows ​======
  
-All iCube R&D Group plugins have the same registration procedure. +===== Installation on Windows=====
-=====Windows=====+
  
-Start the registration utilityStart menu > R&D Group > Product > Registration or launch <​ProductName>​_registration.exe+ {{:vraypattern-maya:​vraypattern-install-1.png?nolink| VRayPattern for Maya installer}}
  
-**Please make sure you always use the registration utility which is supplied with the particular version of the product.**+Read the license agreement carefully. If you accept ​the license ​the click “I Agree” otherwise press “Cancel”:​
  
- {{ :vrayscatter-maya:50_vrs_activation.png | VRayScatter ​for Maya registration ​}}+ {{:vraypattern-maya:vraypattern-install-2.png?nolinkVRayPattern ​for Maya installer}}
  
-Choose ​the hard disk to be linked with the license (linking with external USB storageFlash drives ​and network drives __is not supported__). ​+Choose ​Maya versionV-Ray version ​and the architecture:​
  
-Press the «Get Your ID File» button and save ***.id** file on your hard disk under any name you like+ ​{{:​vraypattern-maya:​vraypattern-install-3.png?nolink| VRayPattern for Maya installer}}
  
- {{ :​vrayscatter-maya:​60_vrs_activation.png | VRayScatter for Maya activation }}+Check installation paths
  
-This will generate an **//​ProductName_<​UserName>​_<​Date>​.id//​** file on your Desktop.+ ​{{:​vraypattern-maya:​vraypattern-install-4.png?nolink| VRayPattern for Maya installer}}
  
-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.**+Start Maya and enable ​**Load** and/or **Auto load** ​in Window -> Settings/​Preferences -> Plug-in Manager for the **VRayPattern** plug-in.
  
-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.+  
 +===== Activation on Windows ===== 
 +please see: http://docs.rendering.ru/​en:​cerber-protection
  
-Start again the registration utility and press the «Apply Key File» button.+===== Installation on Windows DR nodes ===== 
 +Copy **vray_VRayPattern.dll** from //​MAYA_ROOT/​vray/​vrayplugins//​ to //​VRAY_STANDALONE/​vrayplugins//​ (or //​MAYA_ROOT/​vray/​vrayplugins//​) on render nodes.
  
-In the dialogue box select the *.key file you received ​from us. With this registration procedure is over. +For example, ​from: 
-=====Linux ​OS X=====+<​code>​C:​\Program Files\Autodesk\Maya2012\vray\vrayplugins<​/code> 
 +to:\\ 
 +<​code>​C:​\Program Files\Chaos Group\V-Ray\Standalone\vrayplugins</​code>​
  
-Please make sure you always ​use the registration utility which is supplied with the particular version of the product.+===== Uninstall ===== 
 +To uninstall VRayPattern ​use the uninstaller:​ Start menu > R&D Group > VRayPattern For Maya > Uninstall
  
-Open your preferred terminal application ​and start the registration utility:+====== Linux ====== 
 +===== Installation On Linux ===== 
 +Please, make sure that you've downloaded the latest version of the plug-in from our [[http://​forum.rendering.ru/​viewforum.php?​f=26|forum]] 
 + 
 +Unpack the archive, open your preferred terminal application, obtain root permission 
 + 
 +Installer has a graphical interface on all supported platforms:
 <​code>​ <​code>​
-cd ~/​where/​you/​have/​unpacked/​the/​archive +sudo -i 
-./​tools/​ProductNameRegistration+# VRayPatternForMaya-x.xxx.run
 </​code>​ </​code>​
  
-This will generate an **//​ProductName_<UserName>_<Date>.id//** file on your Desktop.+or you can also run text installation mode 
 +<code> 
 +$ sudo -i 
 +# VRayPatternForMaya-x.xxx.run --mode text 
 +</code>
  
-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.** 
  
-In the nearest time (usually within 24 hours) ​you will get an email from us (or your reseller) with ***.lic** license file attachedSave this file on your hard disk.+Select ​you Maya/V-Ray versions and copy the plugins. Here is an example for the default paths of Maya 2013 and V-Ray 2.3: 
 +<​code>​ 
 +# cp workstation/​maya/​2013/​23/​x64/​VRayPatternForMaya.bundle /​Applications/​Autodesk/​maya2013/​Maya.app/​Contents/​MacOS/​plug-ins 
 +# cp workstation/​maya/​2013/​23/​x64/​libvray_VRayPattern.so /​Applications/​Autodesk/​maya2013/​vray/​vrayplugins/​ 
 +</​code>​
  
-Start again the registration utility with the path to the license file argument like:+Install ​the Maya UI files:
 <​code>​ <​code>​
-$ cd ~/where/you/have/unpacked/the/archive +# cp ui/AEVRayPattern.mel ​/Applications/Autodesk/maya2013/Maya.app/​Contents/​scripts/AETemplates 
-./tools/ProductNameRegistrationRegistration ​/path/to/license/file.lic+# cp ui/​rdgroupVRayPattern.mel /Applications/Autodesk/maya2013/Maya.app/Contents/scripts/ 
 +# cp ui/​rdgroupMenu.mel /​Applications/​Autodesk/​maya2013/​Maya.app/​Contents/​scripts/​ 
 +# cp ui/​rdgroupProc.mel /​Applications/​Autodesk/​maya2013/​Maya.app/​Contents/​scripts/​
 </​code>​ </​code>​
  
-or manually copy this file to //​~/​.config/​RDGroup/​ProductName.lic//​ like this:+**NOTE**: 
 +  * Change the installation paths depending on your setup 
 +  * # - means that command should be executed with root permissions 
 +  * Default V-Ray plugins path before Maya 2013 is 
 <​code>​ <​code>​
-$ mkdir -p ~/.config/RDGroup/ +/Applications/Autodesk/maya<​MAYA_VERSION>​/Maya.app/Contents/vray/vrayplugins/
-$ cp /path/to/license/file.lic ~/.config/​RDGroup/​ProductName.lic+
 </​code>​ </​code>​
-===== Notes ===== 
  
-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 timePlease 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.+===== Activation on Linux ===== 
 +please see http://docs.rendering.ru/​en:​cerber-protection
  
-However, we reserve the right not to issue a new license in case of total replacement of a PC if the  +===== Installation On Linux Batch Render Nodes ===== 
-registration request is submitted more often than once in half a year.+Run installer and choose "​Batch"​
  
-**ATTENTION! Please always try to email from the same email address you used when you  +or copy files manually
-purchased the plug-in. If we can’t find your e-mail address from which you sent the ID file in  +
-our database and there is no explanation and receipt ​or order number in you email, your  +
-request may not be processed!**+
  
-**Please always attach you receipt or order number to avoid any delays in communication.**+Download full archive [[http://​files.rendering.ru/​vraypattern_for_maya/​VRayPatternForMaya-FULL-latest.zip|here]] (150mb), Select you Maya/V-Ray versions and copy the plugin files:
  
-**You don't need a license for Batch and DR nodes**.+e.g. 
 +<​code>​ 
 +# cp plugins/​batch/​maya2012_vray22_x64/​VRayPattern.so /​usr/​autodesk/​maya2012-x64/​bin/​plug-ins/​ 
 +# cp plugins/​batch/​maya2012_vray22_x64/​libvray_VRayPattern.so /​usr/​autodesk/​maya2012-x64/​vray/​vrayplugins/​ 
 +</​code>​
  
 +===== Installation On Linux DR Nodes =====
 +For V-Ray "​Distributed Render"​ node installation you only need to copy V-Ray plugin:
 +<​code>​
 +# cp libvray_VRayPattern.so /​usr/​autodesk/​maya2012-x64/​vray/​vrayplugin/​
 +</​code>​
  
 +===== Uninstall =====
  
-======Linux / 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://​forum.rendering.ru/​viewforum.php?f=23|forum]] ​+ ​{{:​vraypattern-maya:vraypattern-install-osx-1.png?nolinkVRayPattern for Maya OS X installer}}
  
-Here is an example file structure of the **VRayPattern For Maya** for Linux / Mac OS X archive: +Read the license agreement carefully. If you accept the license the click “I Agree” otherwise press “Cancel”:
-  * **workstation** – plugins for artist workstation +
-  * **batch** – plugins for batch render nodes +
-  * **ui** – scripts for Maya +
-  * **tools** – registration tools+
  
-=====Installation on Mac=====+ ​{{:​vraypattern-maya:​vraypattern-install-osx-2.png?​nolink| VRayPattern for Maya OS X installer}}
  
-Unpack the archiveopen your preferred terminal application,​ obtain root permission ​and start  +Choose Maya versionV-Ray version ​and working mode:
-coping files:+
  
-<​code>​ + ​{{:​vraypattern-maya:​vraypattern-install-osx-3.png?​nolink| VRayPattern for Maya OS X installer}} 
-$ sudo -i + 
-# cd ~/where/you/have/unpacked/the/archive +Check installation paths 
-</​code>​+ 
 + ​{{:​vraypattern-maya:​vraypattern-install-osx-4.png?​nolink| VRayPattern for Maya OS X installer}} 
 + 
 +Start Maya and enable **Load** and/or **Auto load** in Window -> Settings/Preferences -> Plug-in Manager for the **VRayPattern** plug-in. 
 + 
 + 
 +In case of problems with installer ​you can download full archive [[http://files.rendering.ru/vraypattern_for_maya/VRayPatternForMaya-FULL-latest.zip|here]] (150mb)
  
 Select you Maya/V-Ray versions and copy the plugins. Here is an example for the default paths of Maya 2013 and V-Ray 2.3: Select you Maya/V-Ray versions and copy the plugins. Here is an example for the default paths of Maya 2013 and V-Ray 2.3:
Line 151: Line 180:
 # cp ui/​rdgroupProc.mel /​Applications/​Autodesk/​maya2013/​Maya.app/​Contents/​scripts/​ # cp ui/​rdgroupProc.mel /​Applications/​Autodesk/​maya2013/​Maya.app/​Contents/​scripts/​
 </​code>​ </​code>​
- 
  
 **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   * # - means that command should be executed with root permissions
-  * Default V-Ray plugins path before Maya 2013 is <​code>/​Applications/​Autodesk/​maya<​MAYA_VERSION>/​Maya.app/​Contents/​vray/​vrayplugins/</​code>​ +  * Default V-Ray plugins path before Maya 2013 is  
-======Usage======+<​code>​ 
 +/​Applications/​Autodesk/​maya<​MAYA_VERSION>/​Maya.app/​Contents/​vray/​vrayplugins/​ 
 +</​code>​
  
-  - In menu chooseCreate -R&D Group -> VRayPattern. +===== Activation on Mac OS X ===== 
-  - VRayPattern logo will appear. Use it to select VRayPattern. ​+Open your preferred terminal application and start the registration utility: 
 +<code
 +$ /​Library/​RDGroup/​bin/​VRayPatternForMayaRegistration 
 +</​code>​
  
-===== Parameters Description =====+This will generate **//​ProductName_<​UserName>​_<​Date>​.id//​** file on your Desktop.
  
- {{ :​vraypattern-maya:​vraypattern_ae.png?300}}+Send this file to mail@rendering.ru (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.
 +
 +Start again the registration utility with the path to the license file argument like:
 +<​code>​
 +$ /​Library/​RDGroup/​bin/​VRayPatternForMayaRegistration ~/​Desktop/​yourlicensefile.lic
 +</​code>​
 +
 +or manually copy this file to //​~/​.config/​RDGroup/​ProductName.lic//​ like this:
 +<​code>​
 +$ mkdir -p ~/​.config/​RDGroup/​
 +$ cp /​path/​to/​license/​file.lic ~/​.config/​RDGroup/​ProductName.lic
 +</​code>​
 +
 +===== Installation On OS X Batch Render Nodes =====
 +Run installer and choose "​Batch"​
 +
 +or copy files manually
 +
 +Download full archive [[http://​files.rendering.ru/​vraypattern_for_maya/​VRayPatternForMaya-FULL-latest.zip|here]] (150mb), Select you Maya/V-Ray versions and copy the plugin files:
 +
 +e.g.
 +<​code>​
 +# cp plugins/​batch/​maya2012_vray22_x64/​VRayPattern.so /​usr/​autodesk/​maya2012-x64/​bin/​plug-ins/​
 +# cp plugins/​batch/​maya2012_vray22_x64/​libvray_VRayPattern.so /​usr/​autodesk/​maya2012-x64/​vray/​vrayplugins/​
 +</​code>​
 +
 +===== Installation On OS X DR Nodes =====
 +For V-Ray "​Distributed Render"​ node installation you only need to copy V-Ray plugin:
 +<​code>​
 +# cp libvray_VRayPattern.so /​usr/​autodesk/​maya2012-x64/​vray/​vrayplugin/​
 +</​code>​
 +
 +====== Usage ======
 +
 +  -In menu choose: Create -> R&D Group -> VRayPattern.
 +  -VRayPattern logo will appear. Use it to select VRayPattern.
 +  ​
 +**Quick Start**
 +  * Create VRayPattern Node: Create -> R&D Group -> VRayPattern
 +  * Select base polygon object, select VRayPattern and press "​Attach"​ button near "Base Object"​. Object must have UV!
 +  * Select pattern polygon object, select VRayPattern and press "​Attach"​ button near "​Pattern Object"​.
 +  * Press "Fit Crop Box" button. Edit crop box with "Crop Size" attribute or using manipulator with "Show manipulator tool".
 +  * Press render.
 +  ​
 +===== Parameters Description =====
 + ​{{:​vraypattern-maya:​vraypattern_ae.png?​300| Parameters}}
  
   * **Base Object** - Surface on which geometry will be propagated.   * **Base Object** - Surface on which geometry will be propagated.
   * **Render Base Object** - Quick way to turn off the visibility in rendering of the base object.   * **Render Base Object** - Quick way to turn off the visibility in rendering of the base object.
   * **Pattern Object** - Propagated object.   * **Pattern Object** - Propagated object.
-  * **Render Original Pattern Object** - Quick way to turn off the visibility in rendering of the original object of propagating. ​ +  * **Render Original Pattern Object** - Quick way to turn off the visibility in rendering of the original object of propagating.
   * **Crop Size** - Size of the crop box of propagated geometry. All objects outside of the box – are ignored. Crop box also defines the repeating period of the geometry.   * **Crop Size** - Size of the crop box of propagated geometry. All objects outside of the box – are ignored. Crop box also defines the repeating period of the geometry.
   * **Fit Crop Box** - Fit crop box within geometry saving rotation   * **Fit Crop Box** - Fit crop box within geometry saving rotation
-  * **Height** - Height multiplier of the propagated geometry.  +  * **Height** - Height multiplier of the propagated geometry. 
-  * **Shift** - Displacement of the geometry against surface normal’s, which is covered by propagated geometry. ​+  * **Shift** - Displacement of the geometry against surface normal’s, which is covered by propagated geometry.
   * **Surface Renderable** - Ability to quickly switch visibility of the surface in render.   * **Surface Renderable** - Ability to quickly switch visibility of the surface in render.
   * **Map. Channel** - Map channel on the basis of which the geometry will be propagated.   * **Map. Channel** - Map channel on the basis of which the geometry will be propagated.
   * **Use Real World** - Work in real scale.   * **Use Real World** - Work in real scale.
-  * **Tiling U/V** - Mapping multiplier by U/V axis. +  * **Tiling U/V** - Mapping multiplier by U/V axis.
   * **Polygon ID From/To** - Range of polygon IDs of the surface on which propagation is happening.   * **Polygon ID From/To** - Range of polygon IDs of the surface on which propagation is happening.
   * **Random Segment Count** - Enables to split multiplying geometry into several parts and multiply these parts randomly on surface elements.   * **Random Segment Count** - Enables to split multiplying geometry into several parts and multiply these parts randomly on surface elements.
Line 188: Line 267:
 <​code>​VRayPattern:​ Incorrect license!</​code>​ <​code>​VRayPattern:​ Incorrect license!</​code>​
  
-If you were having Maya running while applying a license, make sure to restart Maya after it.+If you were having Maya running while applying a license ​key, make sure to restart Maya after it
 + 
 +In case of license malfunction and errors (which can be caused by disk reformatting,​ re-installation of the operating system or components replacement) you are free to address the developer at any time by sending your request for a new license key to mail@rendering.ru. 
 + 
 +However, we reserve the right not to issue a new license in case of total replacement of a PC if the registration request is submitted more often than once in half a year.
  
-In case of license malfunction and errors (which can be caused by disk reformatting,​ re-installation of the operating system or components replacement) you are free to address the developer at any time by sending your request for a new *.key file to the e-mail [[mail@rendering.ru|mail@rendering.ru]]. ​ 
  
-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 ===== ===== Installation error =====
  
-  * Make sure Maya is not running, please double check in task manager too.  +  * 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 are installing with the administrator rights (on Windows 7 right click “Run as administrator”) .
   * Make sure you choose right installation path.   * Make sure you choose right installation path.
  
Print/export