Skip to content
This repository was archived by the owner on Oct 16, 2024. It is now read-only.

Commit c5eeb26

Browse files
committed
updated version number
1 parent 809397a commit c5eeb26

File tree

99 files changed

+685
-454
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+685
-454
lines changed

docs/changelog/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="..">v0.1.1-Alpha</a>
75+
<a href="..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../.">v0.1.1-Alpha</a>
799+
<a href="../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

docs/components/addons/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="../..">v0.1.1-Alpha</a>
75+
<a href="../..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../../..">v0.1.1-Alpha</a>
799+
<a href="../../../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

docs/components/addons/maya-extend/index.html

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="../../..">v0.1.1-Alpha</a>
75+
<a href="../../..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../../../../..">v0.1.1-Alpha</a>
799+
<a href="../../../../../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

@@ -1328,7 +1328,7 @@ <h4 id="create-your-module">Create your module</h4>
13281328
</ul>
13291329
<p>In the new <code>your_new_module/__init__.py</code> file, you will import or code all the methods you want to expose and make available in Maya, for example to be used in a <em>shelf</em> or any other <em>Python</em> script. You can also register your <em>Ramses</em> callbacks there (read below for more information about <em>Ramses</em> callbacks).</p>
13301330
<p>Here is an example of such an <code>__init__.py</code> file, assuming you have two other files (<em>anotherFile.py</em> and <em>aSecondFile.py</em>) in the same folder, containing the actual code and methods to import:</p>
1331-
<pre><code class="language-py">from .anotherFile import aPublicMethod
1331+
<pre><code class="py">from .anotherFile import aPublicMethod
13321332
from .aSecondFile import aPublishMethod, anImportMethod
13331333

13341334
# Now, 'aPublicMethod' can be called from everyhwere in Maya
@@ -1343,13 +1343,15 @@ <h4 id="create-your-module">Create your module</h4>
13431343
# The import method
13441344
ramses.importScripts.append( anImportMethod )
13451345
</code></pre>
1346+
13461347
<h4 id="import-the-module">Import the module</h4>
13471348
<p>Finally, you just have to import your new module in the <code>ramses_maya</code> module: add a simple import at the end of the <code>ramses_maya/__init__.py</code> file, which should look like this:</p>
1348-
<pre><code class="language-py">from .ram_cmds import cmds_classes
1349+
<pre><code class="py">from .ram_cmds import cmds_classes
13491350
from ramses import log, LogLevel
13501351

13511352
import your_new_module
13521353
</code></pre>
1354+
13531355
<p>Both the new module and the shelf will be automatically registered by the <em>Ramses Maya Add-On</em> when it&rsquo;s loaded in <em>Maya</em>.</p>
13541356
<h4 id="example">Example</h4>
13551357
<p>A complete and working example has been made available: it is the extension made for the school <a href="http://rubika-edu.com"><em>Rubika Animation / Supinfocom</em></a>, for the production pipeline of the graduation movies of the students.</p>
@@ -1380,7 +1382,7 @@ <h3 id="callbacks">Callbacks</h3>
13801382
<p>Read the <a href="../../../dev/add-ons-reference/ramses/">Scripting API Reference</a> for more information.</p>
13811383
<h4 id="adding-your-custom-callbacks">Adding your custom callbacks</h4>
13821384
<p>To register your callbacks, you just have to append them in the corresponding <code>Ramses</code> lists:</p>
1383-
<pre><code class="language-py"># We need to import the Ramses Module (API)
1385+
<pre><code class="py"># We need to import the Ramses Module (API)
13841386
from ramses import Ramses
13851387
# Now we just have to add the callbacks
13861388
ramses = Ramses.instance()
@@ -1391,11 +1393,12 @@ <h4 id="adding-your-custom-callbacks">Adding your custom callbacks</h4>
13911393
# A status method
13921394
ramses.statusScripts.append( aStatusMethod )
13931395
</code></pre>
1396+
13941397
<p>Now, all these methods will be automatically called each time a status changes, an item is published, or an item is imported.</p>
13951398
<h3 id="detailed-example">Detailed Example</h3>
13961399
<p>In this example, three files are added, with the import, status, and publish methods.</p>
13971400
<p>The file <code>plug-ins/your_new_module/myPublishCallbacks.py</code> creates the callbacks used to publish shots and assets.</p>
1398-
<pre><code class="language-py"># myPublishCallbacks.py
1401+
<pre><code class="py"># myPublishCallbacks.py
13991402

14001403
import ramses as ram
14011404

@@ -1423,8 +1426,9 @@ <h3 id="detailed-example">Detailed Example</h3>
14231426
# etc.
14241427

14251428
</code></pre>
1429+
14261430
<p>The file <code>plug-ins/your_new_module/myStatusCallbacks.py</code> creates the callbacks used when a status changes.</p>
1427-
<pre><code class="language-py"># myStatusCallbacks.py
1431+
<pre><code class="py"># myStatusCallbacks.py
14281432

14291433
import ramses as ram
14301434

@@ -1452,8 +1456,9 @@ <h3 id="detailed-example">Detailed Example</h3>
14521456
# etc.
14531457

14541458
</code></pre>
1459+
14551460
<p>The file <code>plug-ins/your_new_module/myImportCallbacks.py</code> creates the callbacks used to import items.</p>
1456-
<pre><code class="language-py"># myImportCallbacks.py
1461+
<pre><code class="py"># myImportCallbacks.py
14571462

14581463
import ramses as ram
14591464

@@ -1471,15 +1476,17 @@ <h3 id="detailed-example">Detailed Example</h3>
14711476
# etc.
14721477

14731478
</code></pre>
1479+
14741480
<p>The file <code>plug-ins/your_new_module/otherMethods.py</code> creates a few other methods, for example to be used in a <em>Maya shelf</em>.</p>
1475-
<pre><code class="language-py"># otherMethods.py
1481+
<pre><code class="py"># otherMethods.py
14761482

14771483
def methodForAShelf():
14781484
doSomething()
14791485

14801486
</code></pre>
1487+
14811488
<p>Finally, we just need to import these files in the <code>plug-ins/your_new_module/__init__.py</code> file of our custom module. We can register them here.</p>
1482-
<pre><code class="language-py"># __init__.py
1489+
<pre><code class="py"># __init__.py
14831490
from myImportCallbacks import importAsset
14841491
from myStatusCallbacks import updateAsset, updateShot
14851492
from myPublishCallbacks import publishAsset, publishShot
@@ -1501,13 +1508,15 @@ <h3 id="detailed-example">Detailed Example</h3>
15011508
# Add the callbacks to the status list
15021509
ramses.importScripts.append( importAsset )
15031510
</code></pre>
1511+
15041512
<p>And don&rsquo;t forget to import your new module in <code>plug-ins/ramses_maya/__init__.py</code>:</p>
1505-
<pre><code class="language-py"># plug-ins/ramses_maya/__init__.py
1513+
<pre><code class="py"># plug-ins/ramses_maya/__init__.py
15061514
from .ram_cmds import cmds_classes
15071515
from ramses import log, LogLevel
15081516

15091517
import your_new_module
15101518
</code></pre>
1519+
15111520
<p>Don&rsquo;t change anything else in the file!</p>
15121521
<p>Now you can also use <code>methodForAShelf()</code> in an existing or new <em>shelf</em>, which can be stored in the <code>shelves</code> folder if you want it to be deployed with your extension.</p></div>
15131522

docs/components/addons/maya-rubika/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="../../..">v0.1.1-Alpha</a>
75+
<a href="../../..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../../../../..">v0.1.1-Alpha</a>
799+
<a href="../../../../../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

docs/components/addons/maya/index.html

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="../../..">v0.1.1-Alpha</a>
75+
<a href="../../..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../../../../..">v0.1.1-Alpha</a>
799+
<a href="../../../../../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

@@ -1328,6 +1328,7 @@ <h2 id="installation">Installation</h2>
13281328
PYTHONPATH+:=plug-ins
13291329
MAYA_SHELF_PATH+:=shelves
13301330
</code></pre>
1331+
13311332
<p>Do not change anything else in the file.</p>
13321333
<ul>
13331334
<li>In order to prevent unintended modifications to the <em>Ramses</em> shelf, you can set its <em>read-only</em> attribute:<ul>
@@ -1428,7 +1429,7 @@ <h2 id="save"><img alt="" src="../../../img/icons/save.svg" style="width:32px" /
14281429
<li><code>-set_comment</code> or <code>-sc</code>: <em>boolean</em> used to set a comment associated to the current version file.</li>
14291430
<li><code>-comment</code> or <code>-c</code>: <em>string</em> is the comment to be associated if <code>-sc</code> is <code>True</code>.</li>
14301431
</ul>
1431-
<pre><code class="language-py"># Python
1432+
<pre><code class="py"># Python
14321433
import maya.cmds as cmds
14331434

14341435
# Save the current file
@@ -1440,6 +1441,7 @@ <h2 id="save"><img alt="" src="../../../img/icons/save.svg" style="width:32px" /
14401441
# Save the file with a custom comment
14411442
cmds.ramSave(sc = True, comment = &quot;A new comment!&quot;)
14421443
</code></pre>
1444+
14431445
<h2 id="comment"><img alt="" src="../../../img/icons/comment.svg" style="width:32px" /> Comment</h2>
14441446
<p>The <em>Comment</em> command saves the current scene the same way as the <em>Save</em> command, and adds a comment associated with the current version.</p>
14451447
<p>This comment is displayed with the corresponding version in all version selection dialogs, both in the add-on itself and in the <em>Ramses Client Application</em>, as shown below.</p>
@@ -1454,19 +1456,21 @@ <h2 id="comment"><img alt="" src="../../../img/icons/comment.svg" style="width:3
14541456
</figure>
14551457

14561458
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramSave</code> with its two parameters <code>-sc</code> and <code>c</code>. Read the <a href="#save"><em>Save</em></a> section for details.</p>
1457-
<pre><code class="language-py"># Python
1459+
<pre><code class="py"># Python
14581460
import maya.cmds as cmds
14591461
# Save the file with a custom comment
14601462
cmds.ramSave(sc = True, comment = &quot;A new comment!&quot;)
14611463
</code></pre>
1464+
14621465
<h2 id="incremental-save"><img alt="" src="../../../img/icons/saveversion.svg" style="width:32px" /> Incremental Save</h2>
14631466
<p>The <em>Incremental Save</em> runs the save command and forces it to increment to a new version.</p>
14641467
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramSaveVersion</code> with the parameter <code>updateStatus</code> set to <code>False</code>. Read the <a href="#update-status-and-publish"><em>Update Status</em></a> section for details.</p>
1465-
<pre><code class="language-py"># Python
1468+
<pre><code class="py"># Python
14661469
import maya.cmds as cmds
14671470
# Incremental save
14681471
cmds.ramSaveVersion( updateStatus=False )
14691472
</code></pre>
1473+
14701474
<h2 id="update-status-and-publish"><img alt="" src="../../../img/icons/savestatus.svg" style="width:32px" /> Update Status and Publish</h2>
14711475
<p>The <em>Update Status</em> runs the <em>Incremental Save</em> command and updates the current production status of the current Asset or Shot.</p>
14721476
<p>A dialog is shown with a few options ot update the status, and to choose to also publish the scene, and create a preview for it. This dialog may differ depending on the use of the <em>Ramses Client Application</em> or not.</p>
@@ -1498,7 +1502,7 @@ <h2 id="update-status-and-publish"><img alt="" src="../../../img/icons/savestatu
14981502
<li><code>-publish</code> or <code>-p</code>: <em>boolean</em> activates the publication of the scene.</li>
14991503
<li><code>-preview</code> or <code>-pv</code>: <em>boolean</em> activates the creation of a preview.</li>
15001504
</ul>
1501-
<pre><code class="language-py"># Python
1505+
<pre><code class="py"># Python
15021506
import maya.cmds as cmds
15031507

15041508
# Shows the update status dialog
@@ -1512,6 +1516,7 @@ <h2 id="update-status-and-publish"><img alt="" src="../../../img/icons/savestatu
15121516
# Publishes and creates a preview without showing the status dialog
15131517
cmds.ramSaveVersion(publish = True, preview = True, us = False)
15141518
</code></pre>
1519+
15151520
<h3 id="publication">Publication</h3>
15161521
<p>The publication of the scene is done in two steps:</p>
15171522
<ol>
@@ -1531,12 +1536,13 @@ <h2 id="preview"><img alt="" src="../../../img/icons/preview.svg" style="width:3
15311536
<p>Ramses also automatically burns useful meta-data in the image, like the frame number, the focal length, the comment, etc.</p>
15321537
<p><img alt="" src="../../../img/maya/blast.png" /></p>
15331538
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramPreview</code>.</p>
1534-
<pre><code class="language-py"># Python
1539+
<pre><code class="py"># Python
15351540
import maya.cmds as cmds
15361541

15371542
# Shows the preview dialog
15381543
cmds.ramPreview()
15391544
</code></pre>
1545+
15401546
<h3 id="playblasts">Playblasts</h3>
15411547
<p>When rendering the playblasts, <em>Ramses</em> does not only renders them as usual <em>Maya</em> playblasts: you don&rsquo;t need to install <em>Quicktime</em> on windows anymore to export videos. <em>Ramses</em> automatically renders the playblasts in a very lightweight <em>MP4</em> video, crafted especially for reviewing animations, with an intra-frame encoding setting which enables frame by frame playblack on every video player, with great performance.</p>
15421548
<p><em>Ramses</em> will also automatically play the video as soon as it&rsquo;s encoded using <em>ffplay</em>, a very efficient and lightweight video player. It may seem complicated at first as it does not have any User Interface, but it is easily controlled with a few shortcuts:</p>
@@ -1559,12 +1565,13 @@ <h2 id="save-as"><img alt="" src="../../../img/icons/saveas.svg" style="width:32
15591565
</ul>
15601566
<p>When selecting <em>Other</em> as type, the file will be saved in the main folder of the corresponding step. Read the section about the <a href="../../files/"><em>Ramses Tree</em></a> for more information.</p>
15611567
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramSaveAs</code>.</p>
1562-
<pre><code class="language-py"># Python
1568+
<pre><code class="py"># Python
15631569
import maya.cmds as cmds
15641570

15651571
# Shows the save as dialog
15661572
cmds.ramSaveAs()
15671573
</code></pre>
1574+
15681575
<h2 id="template"><img alt="" src="../../../img/icons/template.svg" style="width:32px" /> Template</h2>
15691576
<p>Use the <em>Template</em> command to create a new template file to be used with a specific step.</p>
15701577
<p><img alt="" src="../../../img/maya/template.png" /></p>
@@ -1584,42 +1591,45 @@ <h2 id="template"><img alt="" src="../../../img/icons/template.svg" style="width
15841591
</figure>
15851592

15861593
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramPublishTemplate</code>.</p>
1587-
<pre><code class="language-py"># Python
1594+
<pre><code class="py"># Python
15881595
import maya.cmds as cmds
15891596

15901597
# Shows the publish template dialog
15911598
cmds.ramPublishTemplate()
15921599
</code></pre>
1600+
15931601
<h2 id="open-and-import"><img alt="" src="../../../img/icons/open.svg" style="width:32px" /> Open and Import</h2>
15941602
<p>The <em>Open and Import</em> command automatically finds available scenes from your projects.</p>
15951603
<p><img alt="" src="../../../img/maya/open.png" /></p>
15961604
<p>It is not needed to go down all the hierarchy to select a file to open; if you just select an item and a step, <em>Ramses</em> will automatically open or import the corresponding latest version of the main resource. It works the same way when importing items: you don&rsquo;t need to go all the way down to select the files you want to import; by selecting just the main file, <em>Ramses</em> will import everything available, or, if you&rsquo;re using an <a href="../maya-extend/">extension</a> of the <em>Add-on</em> such as the <a href="../maya-rubika/"><em>Rubika Flavor</em></a>, it will pass all the files to the extension so it can automatically manage the import for you.</p>
15971605
<p>When importing an item, <em>Ramses</em> will also trigger custom import scripts registered by the pipeline tools or an extension of the <em>Maya Add-on</em>, such as the <a href="../maya-rubika/"><em>Rubika Flavor</em></a>. This is one way of automating your workflow, by just registering scripts to be called when publishing and importing items.</p>
15981606
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramOpen</code>.</p>
1599-
<pre><code class="language-py"># Python
1607+
<pre><code class="py"># Python
16001608
import maya.cmds as cmds
16011609

16021610
# Shows the open/import dialog
16031611
cmds.ramOpen()
16041612
</code></pre>
1613+
16051614
<h2 id="retrieve-version"><img alt="" src="../../../img/icons/restoreversion.svg" style="width:32px" /> Retrieve Version</h2>
16061615
<p>The <em>Retrieve version</em> command can be used to check and restore a previous version of the current scene.</p>
16071616
<p><img alt="" src="../../../img/maya/versionlist.png" /></p>
16081617
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramRetrieveVersion</code>.</p>
1609-
<pre><code class="language-py"># Python
1618+
<pre><code class="py"># Python
16101619
import maya.cmds as cmds
16111620

16121621
# Shows the retrieve version dialog
16131622
cmds.ramRetrieveVersion()
16141623
</code></pre>
1624+
16151625
<h2 id="settings"><img alt="" src="../../../img/icons/gotosettings.svg" style="width:32px" /> Settings</h2>
16161626
<h3 id="versionning">Versionning</h3>
16171627
<p><img alt="" src="../../../img/maya/versionsettings.png" /></p>
16181628
<ul>
16191629
<li>The <strong><em>Auto-Increment</em></strong> option sets how many time can be spent before <em>Ramses</em> automatically increments the version of the file when saving. Use this option to be sure you can get back to an earlier version of your work even if you forget to increment the version.</li>
16201630
<li>the <strong><em>Save hotkey</em></strong> option replaces the default &ldquo;<em>Save Scene</em>&rdquo; <code>[Ctrl + S]</code> hotkey from <em>Maya</em> by the <em>Save</em> command from <em>Ramses</em>. This is recommended to enable all production tracking features of <em>Ramses</em> and ensure an automatic backup of your work. Note that checking this box <strong>does not replace the <code>File/Save</code> menu entry</strong> so you can still use the default <em>Maya Save</em> command.</li>
16211631
<li>the <strong><em>Save as hotkey</em></strong> option replaces the default &ldquo;<em>Save Scene As</em>&rdquo; <code>[Ctrl + Shift + S]</code> hotkey from <em>Maya</em> by the <em>Save As</em> command from <em>Ramses</em>. Note that checking this box <strong>does not replace the <code>File/Save as...</code> menu entry</strong> so you can still use the default <em>Maya Save as</em> command.</li>
1622-
<li>the <strong>Open hotkey</strong><em> option replaces the default &ldquo;</em>Open Scene&hellip;<em>&rdquo; <code>[Ctrl + O]</code> hotkey from </em>Maya<em> by the </em>Open<em> command from </em>Ramses<em>. Note that checking this box </em><em>does not replace the <code>File/Open Scene...</code> menu entry</em><em> so you can still use the default </em>Maya Open* command.</li>
1632+
<li>the <strong>Open hotkey<strong><em> option replaces the default &ldquo;</em>Open Scene&hellip;<em>&rdquo; <code>[Ctrl + O]</code> hotkey from </em>Maya<em> by the </em>Open<em> command from </em>Ramses*. Note that checking this box </strong>does not replace the <code>File/Open Scene...</code> menu entry</strong> so you can still use the default <em>Maya Open</em> command.</li>
16231633
</ul>
16241634
<h3 id="folders">Folders</h3>
16251635
<p><img alt="" src="../../../img/maya/foldersettings.png" /></p>

docs/components/client/admin/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="../../..">v0.1.1-Alpha</a>
75+
<a href="../../..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../../../../..">v0.1.1-Alpha</a>
799+
<a href="../../../../../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

docs/components/client/applications/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272

7373

7474
<li >
75-
<a href="../../..">v0.1.1-Alpha</a>
75+
<a href="../../..">v0.1.2-Alpha</a>
7676
</li>
7777

7878

@@ -796,7 +796,7 @@
796796

797797

798798
<li >
799-
<a href="../../../../../..">v0.1.1-Alpha</a>
799+
<a href="../../../../../..">v0.1.2-Alpha</a>
800800
</li>
801801

802802

0 commit comments

Comments
 (0)