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

Commit

Permalink
updated version number
Browse files Browse the repository at this point in the history
  • Loading branch information
Nico-Duduf committed Jul 25, 2021
1 parent 809397a commit c5eeb26
Show file tree
Hide file tree
Showing 99 changed files with 685 additions and 454 deletions.
4 changes: 2 additions & 2 deletions docs/changelog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="..">v0.1.1-Alpha</a>
<a href="..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../.">v0.1.1-Alpha</a>
<a href="../..">v0.1.2-Alpha</a>
</li>


Expand Down
4 changes: 2 additions & 2 deletions docs/components/addons/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="../..">v0.1.1-Alpha</a>
<a href="../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../../..">v0.1.1-Alpha</a>
<a href="../../../..">v0.1.2-Alpha</a>
</li>


Expand Down
31 changes: 20 additions & 11 deletions docs/components/addons/maya-extend/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="../../..">v0.1.1-Alpha</a>
<a href="../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../../../../..">v0.1.1-Alpha</a>
<a href="../../../../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -1328,7 +1328,7 @@ <h4 id="create-your-module">Create your module</h4>
</ul>
<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>
<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>
<pre><code class="language-py">from .anotherFile import aPublicMethod
<pre><code class="py">from .anotherFile import aPublicMethod
from .aSecondFile import aPublishMethod, anImportMethod

# Now, 'aPublicMethod' can be called from everyhwere in Maya
Expand All @@ -1343,13 +1343,15 @@ <h4 id="create-your-module">Create your module</h4>
# The import method
ramses.importScripts.append( anImportMethod )
</code></pre>

<h4 id="import-the-module">Import the module</h4>
<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>
<pre><code class="language-py">from .ram_cmds import cmds_classes
<pre><code class="py">from .ram_cmds import cmds_classes
from ramses import log, LogLevel

import your_new_module
</code></pre>

<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>
<h4 id="example">Example</h4>
<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>
Expand Down Expand Up @@ -1380,7 +1382,7 @@ <h3 id="callbacks">Callbacks</h3>
<p>Read the <a href="../../../dev/add-ons-reference/ramses/">Scripting API Reference</a> for more information.</p>
<h4 id="adding-your-custom-callbacks">Adding your custom callbacks</h4>
<p>To register your callbacks, you just have to append them in the corresponding <code>Ramses</code> lists:</p>
<pre><code class="language-py"># We need to import the Ramses Module (API)
<pre><code class="py"># We need to import the Ramses Module (API)
from ramses import Ramses
# Now we just have to add the callbacks
ramses = Ramses.instance()
Expand All @@ -1391,11 +1393,12 @@ <h4 id="adding-your-custom-callbacks">Adding your custom callbacks</h4>
# A status method
ramses.statusScripts.append( aStatusMethod )
</code></pre>

<p>Now, all these methods will be automatically called each time a status changes, an item is published, or an item is imported.</p>
<h3 id="detailed-example">Detailed Example</h3>
<p>In this example, three files are added, with the import, status, and publish methods.</p>
<p>The file <code>plug-ins/your_new_module/myPublishCallbacks.py</code> creates the callbacks used to publish shots and assets.</p>
<pre><code class="language-py"># myPublishCallbacks.py
<pre><code class="py"># myPublishCallbacks.py

import ramses as ram

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

</code></pre>

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

import ramses as ram

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

</code></pre>

<p>The file <code>plug-ins/your_new_module/myImportCallbacks.py</code> creates the callbacks used to import items.</p>
<pre><code class="language-py"># myImportCallbacks.py
<pre><code class="py"># myImportCallbacks.py

import ramses as ram

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

</code></pre>

<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>
<pre><code class="language-py"># otherMethods.py
<pre><code class="py"># otherMethods.py

def methodForAShelf():
doSomething()

</code></pre>

<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>
<pre><code class="language-py"># __init__.py
<pre><code class="py"># __init__.py
from myImportCallbacks import importAsset
from myStatusCallbacks import updateAsset, updateShot
from myPublishCallbacks import publishAsset, publishShot
Expand All @@ -1501,13 +1508,15 @@ <h3 id="detailed-example">Detailed Example</h3>
# Add the callbacks to the status list
ramses.importScripts.append( importAsset )
</code></pre>

<p>And don&rsquo;t forget to import your new module in <code>plug-ins/ramses_maya/__init__.py</code>:</p>
<pre><code class="language-py"># plug-ins/ramses_maya/__init__.py
<pre><code class="py"># plug-ins/ramses_maya/__init__.py
from .ram_cmds import cmds_classes
from ramses import log, LogLevel

import your_new_module
</code></pre>

<p>Don&rsquo;t change anything else in the file!</p>
<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>

Expand Down
4 changes: 2 additions & 2 deletions docs/components/addons/maya-rubika/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="../../..">v0.1.1-Alpha</a>
<a href="../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../../../../..">v0.1.1-Alpha</a>
<a href="../../../../../..">v0.1.2-Alpha</a>
</li>


Expand Down
34 changes: 22 additions & 12 deletions docs/components/addons/maya/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="../../..">v0.1.1-Alpha</a>
<a href="../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../../../../..">v0.1.1-Alpha</a>
<a href="../../../../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -1328,6 +1328,7 @@ <h2 id="installation">Installation</h2>
PYTHONPATH+:=plug-ins
MAYA_SHELF_PATH+:=shelves
</code></pre>

<p>Do not change anything else in the file.</p>
<ul>
<li>In order to prevent unintended modifications to the <em>Ramses</em> shelf, you can set its <em>read-only</em> attribute:<ul>
Expand Down Expand Up @@ -1428,7 +1429,7 @@ <h2 id="save"><img alt="" src="../../../img/icons/save.svg" style="width:32px" /
<li><code>-set_comment</code> or <code>-sc</code>: <em>boolean</em> used to set a comment associated to the current version file.</li>
<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>
</ul>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds

# Save the current file
Expand All @@ -1440,6 +1441,7 @@ <h2 id="save"><img alt="" src="../../../img/icons/save.svg" style="width:32px" /
# Save the file with a custom comment
cmds.ramSave(sc = True, comment = &quot;A new comment!&quot;)
</code></pre>

<h2 id="comment"><img alt="" src="../../../img/icons/comment.svg" style="width:32px" /> Comment</h2>
<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>
<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>
Expand All @@ -1454,19 +1456,21 @@ <h2 id="comment"><img alt="" src="../../../img/icons/comment.svg" style="width:3
</figure>

<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>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds
# Save the file with a custom comment
cmds.ramSave(sc = True, comment = &quot;A new comment!&quot;)
</code></pre>

<h2 id="incremental-save"><img alt="" src="../../../img/icons/saveversion.svg" style="width:32px" /> Incremental Save</h2>
<p>The <em>Incremental Save</em> runs the save command and forces it to increment to a new version.</p>
<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>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds
# Incremental save
cmds.ramSaveVersion( updateStatus=False )
</code></pre>

<h2 id="update-status-and-publish"><img alt="" src="../../../img/icons/savestatus.svg" style="width:32px" /> Update Status and Publish</h2>
<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>
<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>
Expand Down Expand Up @@ -1498,7 +1502,7 @@ <h2 id="update-status-and-publish"><img alt="" src="../../../img/icons/savestatu
<li><code>-publish</code> or <code>-p</code>: <em>boolean</em> activates the publication of the scene.</li>
<li><code>-preview</code> or <code>-pv</code>: <em>boolean</em> activates the creation of a preview.</li>
</ul>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds

# Shows the update status dialog
Expand All @@ -1512,6 +1516,7 @@ <h2 id="update-status-and-publish"><img alt="" src="../../../img/icons/savestatu
# Publishes and creates a preview without showing the status dialog
cmds.ramSaveVersion(publish = True, preview = True, us = False)
</code></pre>

<h3 id="publication">Publication</h3>
<p>The publication of the scene is done in two steps:</p>
<ol>
Expand All @@ -1531,12 +1536,13 @@ <h2 id="preview"><img alt="" src="../../../img/icons/preview.svg" style="width:3
<p>Ramses also automatically burns useful meta-data in the image, like the frame number, the focal length, the comment, etc.</p>
<p><img alt="" src="../../../img/maya/blast.png" /></p>
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramPreview</code>.</p>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds

# Shows the preview dialog
cmds.ramPreview()
</code></pre>

<h3 id="playblasts">Playblasts</h3>
<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>
<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>
Expand All @@ -1559,12 +1565,13 @@ <h2 id="save-as"><img alt="" src="../../../img/icons/saveas.svg" style="width:32
</ul>
<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>
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramSaveAs</code>.</p>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds

# Shows the save as dialog
cmds.ramSaveAs()
</code></pre>

<h2 id="template"><img alt="" src="../../../img/icons/template.svg" style="width:32px" /> Template</h2>
<p>Use the <em>Template</em> command to create a new template file to be used with a specific step.</p>
<p><img alt="" src="../../../img/maya/template.png" /></p>
Expand All @@ -1584,42 +1591,45 @@ <h2 id="template"><img alt="" src="../../../img/icons/template.svg" style="width
</figure>

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

# Shows the publish template dialog
cmds.ramPublishTemplate()
</code></pre>

<h2 id="open-and-import"><img alt="" src="../../../img/icons/open.svg" style="width:32px" /> Open and Import</h2>
<p>The <em>Open and Import</em> command automatically finds available scenes from your projects.</p>
<p><img alt="" src="../../../img/maya/open.png" /></p>
<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>
<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>
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramOpen</code>.</p>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds

# Shows the open/import dialog
cmds.ramOpen()
</code></pre>

<h2 id="retrieve-version"><img alt="" src="../../../img/icons/restoreversion.svg" style="width:32px" /> Retrieve Version</h2>
<p>The <em>Retrieve version</em> command can be used to check and restore a previous version of the current scene.</p>
<p><img alt="" src="../../../img/maya/versionlist.png" /></p>
<p>The <em>Mel</em> and <em>Python</em> corresponding command is: <code>ramRetrieveVersion</code>.</p>
<pre><code class="language-py"># Python
<pre><code class="py"># Python
import maya.cmds as cmds

# Shows the retrieve version dialog
cmds.ramRetrieveVersion()
</code></pre>

<h2 id="settings"><img alt="" src="../../../img/icons/gotosettings.svg" style="width:32px" /> Settings</h2>
<h3 id="versionning">Versionning</h3>
<p><img alt="" src="../../../img/maya/versionsettings.png" /></p>
<ul>
<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>
<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>
<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>
<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>
<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>
</ul>
<h3 id="folders">Folders</h3>
<p><img alt="" src="../../../img/maya/foldersettings.png" /></p>
Expand Down
4 changes: 2 additions & 2 deletions docs/components/client/admin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="../../..">v0.1.1-Alpha</a>
<a href="../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../../../../..">v0.1.1-Alpha</a>
<a href="../../../../../..">v0.1.2-Alpha</a>
</li>


Expand Down
4 changes: 2 additions & 2 deletions docs/components/client/applications/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="../../..">v0.1.1-Alpha</a>
<a href="../../..">v0.1.2-Alpha</a>
</li>


Expand Down Expand Up @@ -796,7 +796,7 @@


<li >
<a href="../../../../../..">v0.1.1-Alpha</a>
<a href="../../../../../..">v0.1.2-Alpha</a>
</li>


Expand Down
Loading

0 comments on commit c5eeb26

Please sign in to comment.