Skip to content

Commit

Permalink
v3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Duduf committed Jun 24, 2022
1 parent 3f3282c commit 22b7ee1
Show file tree
Hide file tree
Showing 35 changed files with 77 additions and 137 deletions.
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

7 changes: 3 additions & 4 deletions docs/changelog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@
<ul class="nav bs-sidenav">
<li class="first-level active"><a href="#changelog">Changelog</a></li>
<li class="second-level"><a href="#300">3.0.0</a></li>

<li class="second-level"><a href="#212">2.1.2</a></li>

<li class="second-level"><a href="#211">2.1.1</a></li>
Expand Down Expand Up @@ -247,10 +247,9 @@ <h1 id="changelog">Changelog</h1>
<p>This is the list of what has changed since the first public version of <em>DuBlast</em>.</p>
<h2 id="300">3.0.0</h2>
<ul>
<li>Separated code into panels, playblast, & properties files</li>
<li>Added Shading controls</li>
<li>Added icons to Panels</li>
<li>Added Icon button to View 3D</li>
<li>Added icons to Panels and improved UI</li>
<li>Code refactor: separated into panels, playblast, &amp; properties files</li>
</ul>
<h2 id="212">2.1.2</h2>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/doc-license/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@


<li >
<a href="..">v2.1.2</a>
<a href="..">v3.0.0</a>
</li>


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


<li >
<a href="../..">v2.1.2</a>
<a href="../..">v3.0.0</a>
</li>


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


<li >
<a href="..">v2.1.2</a>
<a href="..">v3.0.0</a>
</li>


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


<li >
<a href="../..">v2.1.2</a>
<a href="../..">v3.0.0</a>
</li>


Expand Down
Binary file removed docs/img/annotations_enabled.png
Binary file not shown.
Binary file added docs/img/icons/annotations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/icons/annotations.png~
Binary file not shown.
Binary file added docs/img/icons/increment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/icons/increment.png~
Binary file not shown.
Binary file added docs/img/icons/metadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/icons/metadata.png~
Binary file not shown.
Binary file removed docs/img/increment_enabled.png
Binary file not shown.
Binary file added docs/img/logos/operator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/img/metadata_enabled.png
Binary file not shown.
Binary file modified docs/img/metadata_settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/operator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/scene.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/img/shading.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -236,16 +236,16 @@
<h1 id="dublast">DuBlast</h1>
<p><img alt="Icon" src="img/dublast.png" /></p>
<p><em>DuBlast</em> is an add-on for <em>Blender</em> which makes it easy to create and play animation playblasts, without having to change any render or output setting.</p>
<p><a href="https://rainboxlab.org/tools/dublast/">You can download it here</a>.</p>
<p><a href="https://rxlaboratory.org/tools/dublast-for-blender/">You can download it here</a>.</p>
<h2 id="usage">Usage</h2>
<p><code>3D View ▸ View Menu ▸ Animation Playblast</code></p>
<p>It adds an <em>Animation Playblast</em> entry in the <em>View 3D &gt; View</em> menu.</p>
<p><img alt="Menu screenshot" class="screenshot" src="img/menu.png" /></p>
<p><img alt="Menu screenshot" src="img/menu.png" /></p>
<p>It renders the animation with the current viewport settings, temporarily overriding the output settings. By default, it will render the animation with a resolution of 25% of the output dimensions, in the default temp folder for your system. It then automatically opens and plays the animation.</p>
<p>By default, the rendered animation is stored in an <em>MP4</em> file, with custom settings tweaked for better animation playback and seekability (it is easy to go frame by frame in these files).</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>By default, <em>DuBlast</em> will overwrite the same existing playblast file.</p><p><img alt="Increment Screenshot" class="screenshot" src="img/increment_enabled.png" /></p><p>By using enabling the <em>increment</em> toggle button, <em>DuBlast</em> appends the date and time to the file so that you can keep the history and compare versions.</p>
<p>If you use the <em>overwrite</em> operator, <em>DuBlast</em> will always save on the same file. By using the <em>increment</em> operator, <em>DuBlast</em> appends the date and time to the file so that you can keep the history and compare versions.</p>
</div>
<p>You can <a href="settings/">adjust these and other settings</a> for playblast creation in the <em>Output Settings</em> Tab of the <em>Properties</em> panel.</p>
<div class="admonition tip">
Expand Down Expand Up @@ -399,6 +399,6 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
</html>

<!--
MkDocs version : 1.0.4
Build Date UTC : 2022-03-23 11:40:50
MkDocs version : 1.1.2
Build Date UTC : 2022-06-24 09:38:51.567882+00:00
-->
40 changes: 20 additions & 20 deletions docs/search/lunr.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.7
* Copyright (C) 2019 Oliver Nightingale
* lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
* Copyright (C) 2021 Oliver Nightingale
* @license MIT
*/

Expand Down Expand Up @@ -54,10 +54,10 @@ var lunr = function (config) {
return builder.build()
}

lunr.version = "2.3.7"
lunr.version = "2.3.9"
/*!
* lunr.utils
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -177,7 +177,7 @@ lunr.FieldRef.prototype.toString = function () {
}
/*!
* lunr.Set
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -211,8 +211,8 @@ lunr.Set.complete = {
return other
},

union: function (other) {
return other
union: function () {
return this
},

contains: function () {
Expand Down Expand Up @@ -389,7 +389,7 @@ lunr.Token.prototype.clone = function (fn) {
}
/*!
* lunr.tokenizer
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -465,7 +465,7 @@ lunr.tokenizer = function (obj, metadata) {
lunr.tokenizer.separator = /[\s\-]+/
/*!
* lunr.Pipeline
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -509,8 +509,8 @@ lunr.Pipeline.registeredFunctions = Object.create(null)
* or mutate (or add) metadata for a given token.
*
* A pipeline function can indicate that the passed token should be discarded by returning
* null. This token will not be passed to any downstream pipeline functions and will not be
* added to the index.
* null, undefined or an empty string. This token will not be passed to any downstream pipeline
* functions and will not be added to the index.
*
* Multiple tokens can be returned by returning an array of tokens. Each token will be passed
* to any downstream pipeline functions and all will returned tokens will be added to the index.
Expand Down Expand Up @@ -673,7 +673,7 @@ lunr.Pipeline.prototype.run = function (tokens) {
for (var j = 0; j < tokens.length; j++) {
var result = fn(tokens[j], j, tokens)

if (result === void 0 || result === '') continue
if (result === null || result === void 0 || result === '') continue

if (Array.isArray(result)) {
for (var k = 0; k < result.length; k++) {
Expand Down Expand Up @@ -732,7 +732,7 @@ lunr.Pipeline.prototype.toJSON = function () {
}
/*!
* lunr.Vector
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -929,7 +929,7 @@ lunr.Vector.prototype.toJSON = function () {
/* eslint-disable */
/*!
* lunr.stemmer
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
* Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
*/

Expand Down Expand Up @@ -1151,7 +1151,7 @@ lunr.stemmer = (function(){
lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')
/*!
* lunr.stopWordFilter
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -1316,7 +1316,7 @@ lunr.stopWordFilter = lunr.generateStopWordFilter([
lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')
/*!
* lunr.trimmer
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand All @@ -1343,7 +1343,7 @@ lunr.trimmer = function (token) {
lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')
/*!
* lunr.TokenSet
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -1827,7 +1827,7 @@ lunr.TokenSet.Builder.prototype.minimize = function (downTo) {
}
/*!
* lunr.Index
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down Expand Up @@ -1994,7 +1994,7 @@ lunr.Index.prototype.query = function (fn) {
*/
var clause = query.clauses[i],
terms = null,
clauseMatches = lunr.Set.complete
clauseMatches = lunr.Set.empty

if (clause.usePipeline) {
terms = this.pipeline.runString(clause.term, {
Expand Down Expand Up @@ -2319,7 +2319,7 @@ lunr.Index.load = function (serializedIndex) {
}
/*!
* lunr.Builder
* Copyright (C) 2019 Oliver Nightingale
* Copyright (C) 2021 Oliver Nightingale
*/

/**
Expand Down
4 changes: 3 additions & 1 deletion docs/search/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function displayResults (results) {

function doSearch () {
var query = document.getElementById('mkdocs-search-query').value;
if (query.length > 2) {
if (query.length > min_search_length) {
if (!window.Worker) {
displayResults(search(query));
} else {
Expand Down Expand Up @@ -73,6 +73,8 @@ function onWorkerMessage (e) {
} else if (e.data.results) {
var results = e.data.results;
displayResults(results);
} else if (e.data.config) {
min_search_length = e.data.config.min_search_length-1;
}
}

Expand Down
2 changes: 1 addition & 1 deletion docs/search/search_index.json

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/search/worker.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ function onScriptsLoaded () {
if (data.config && data.config.separator && data.config.separator.length) {
lunr.tokenizer.separator = new RegExp(data.config.separator);
}

if (data.index) {
index = lunr.Index.load(data.index);
data.docs.forEach(function (doc) {
Expand All @@ -84,6 +85,7 @@ function onScriptsLoaded () {
console.log('Lunr index built, search ready');
}
allowSearch = true;
postMessage({config: data.config});
postMessage({allowSearch: allowSearch});
}

Expand Down
52 changes: 25 additions & 27 deletions docs/settings/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -163,10 +163,10 @@
<div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="first-level active"><a href="#dublast-output-settings">DuBlast Output Settings</a></li>
<li class="second-level"><a href="#annotations">Annotations</a></li>
<li class="second-level"><a href="#operator">Operator</a></li>

<li class="second-level"><a href="#scene">Scene</a></li>

<li class="second-level"><a href="#shading">Shading</a></li>

<li class="second-level"><a href="#output">Output</a></li>
Expand Down Expand Up @@ -236,43 +236,41 @@
<div class="col-md-9" role="main">

<h1 id="dublast-output-settings"><em>DuBlast</em> Output Settings</h1>
<p><img alt="Settings Screenshot" class="screenshot" src="../img/settings.png" /></p>
<p><img alt="Settings Screenshot" src="../img/settings.png" /></p>
<p><code>Properties ▸ Output Properties ▸ Playblast</code></p>
<p>The output settings for <em>DuBlast</em> are located in the <em>Output Settings</em> Tab of the <em>Properties</em> panel.</p>
<h2 id="annotations">Annotations</h2>
<p><img alt="Annotations Screenshot" class="screenshot" src="../img/annotations_enabled.png" /></p>
<p>To render the annotations, enable the Annotations toggle. DuBlast automatically converts the annotations to a <em>Grease Pencil</em> object, and removes it after the rendering process.</p>
<p><img alt="Annotations Screenshot" class="screenshot" src="../img/annotations.png" /></p>
<h2 id="operator">Operator</h2>
<p><img alt="Operator Screenshot" src="../img/operator.png" /></p>
<ul>
<li><img alt="" src="../img/icons/increment.png" style="width:24px" /> Add the current date and time in the file name, instead of overwriting the same file for each playblast.</li>
<li><img alt="" src="../img/icons/metadata.png" style="width:24px" /> Burn the metadata in the video.</li>
<li><img alt="" src="../img/icons/annotations.png" style="width:24px" /> Include annotations.<br />
To render the annotations, DuBlast automatically converts the annotations to a <em>Grease Pencil</em> object, and removes it after the rendering process.</li>
</ul>
<h2 id="scene">Scene</h2>
<p><img alt="Scene Screenshot" class="screenshot" src="../img/scene.png" /></p>
<h3 id="camera">Camera</h3>
<p>Use the <em>Scene Camera</em> option to force the rendering process to use the camera instead of the current view.</p>
<h3 id="frame-range">Frame range</h3>
<p>Uncheck the <em>Scene Frame Range</em> option to set a custom frame range for the playblast, different from the scene.</p>
<p><img alt="Scene Screenshot" src="../img/scene.png" /></p>
<ul>
<li><em>Scene Camera</em>: always use the camera currently set to the scene.</li>
<li><em>Scene Frame Range</em>: use the frame range of the scene or a custom range.</li>
</ul>
<h2 id="shading">Shading</h2>
<p><img alt="Shading Screenshot" class="screenshot" src="../img/shading.png" /></p>
<p>Specify shading settings for your render. Using the Scene Camera will create an OpenGL render, so Solid shading mode will be used. You can still specify the Lighting and Color with the toggle buttons.</p>
<p><img alt="Scene Screenshot" src="../img/shading.png" /></p>
<p>Adjust the shading of the viewport for the playblast.</p>
<h2 id="output">Output</h2>
<p><img alt="Scene Screenshot" src="../img/output.png" /></p>
<p>A few formats are available (<em>PNG</em>, <em>JPEG</em>, <em>AVI JPEG</em> and <em>MP4</em>); all of them are presets carefully crafted to be animator friendly (easy to seek and play). The default is <em>MP4</em>, which will make smaller files for the same quality and can be played easily with any player on any system. These <em>MP4</em> files have custom settings to enable frame by frame seeking. They&rsquo;re also very fast to encode when creating the playblast.</p>
<p>You can set a custom output path for the playblast, different from the scene/render output.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>When rendering to <em>MP4</em> (the default), <em>DuBlast</em> will automatically adjust the dimension of the playblast to fit <em>MP4</em> requirements (an even number of columns and lines). This will not affect the scene output settings.</p>
</div>
<h2 id="output">Output</h2>
<p><img alt="Output Screenshot" class="screenshot" src="../img/output.png" /></p>
<p>The resolution is a percentage of the output dimensions.</p>
<p>A few formats are available (<em>PNG</em>, <em>JPEG</em>, <em>AVI JPEG</em> and <em>MP4</em>); all of them are presets carefully crafted to be animator friendly (easy to seek and play). The default is <em>MP4</em>, which will make smaller files for the same quality and can be played easily with any player on any system. These <em>MP4</em> files have custom settings to enable frame by frame seeking. They&rsquo;re also very fast to encode when creating the playblast.</p>
<p>You can set a custom output path for the playblast, different from the scene/render output.</p>
<h2 id="metadata">Metadata</h2>
<p>You can burn different metadata into the image by enabling the Metadata toggle.</p>
<p><img alt="Metadata Screenshot" class="screenshot" src="../img/metadata_enabled.png" /></p>
<p>Choose which metadata to burn into your render with the checkboxes.</p>
<p><img alt="Metadata Screenshot" class="screenshot" src="../img/metadata_settings.png" /></p>
<p><img alt="Scene Screenshot" src="../img/metadata_settings.png" /></p>
<p>You can burn some metadata into the image.</p>
<p>If the <em>Auto-size Text</em> option is checked, the font size set in the scene settings will be scaled according to the <em>Resolution</em> setting of the playblast, so that the metadata text is the same size both in the 100% output of the scene and the scaled down playblast</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These metadata options are not the same as of the scene ; the scene options are kept separated so you can easily have different metadata between the scene and your playblasts.</p>
</div>
<div class="admonition hint">
<p class="admonition-title">Hint</p>
<p>The font size set in the scene settings will be scaled according to the <em>Resolution</em> setting of the playblast, so that the metadata text is the same size both in the 100% output of the scene and the scaled down playblast</p>
</div></div>


Expand Down
Loading

0 comments on commit 22b7ee1

Please sign in to comment.