# Copyright 2018 Timothy M. Shead
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Integration with Modo, https://www.foundry.com/products/modo.
"""
import re
import subprocess
import rq
import buildcat
def _modo_executable():
return buildcat.executable("modo_cl")
[docs]def info():
"""Return information describing the worker's local Modo installation.
Environment Variables
---------------------
PATH: required
Your PATH environment variable *must* be configured so that the worker
can run the `modo_cl` executable.
Returns
-------
metadata: :class:`dict`
A collection of key-value pairs containing a description of the
Modo installation on the machine where the job was run.
"""
code = """
query platformservice appversion ?
app.quit
"""
command = [_modo_executable()]
process = subprocess.Popen(command, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False, universal_newlines=True)
stdout, stderr = process.communicate(code)
version = re.search("> : (\d+)", stdout).group(1)
result = buildcat.info()
result.update({
"modo": {
"executable": _modo_executable(),
"version": version,
},
})
return result
[docs]def render_frames(lxofile, frames):
"""Render a half-open range of frames from a Modo .lxo file.
Environment Variables
---------------------
PATH: required
Your PATH environment variable *must* be configured so that the worker
can run the `modo_cl` executable.
Parameters
----------
lxofile: :class:`str`, required
Path to the file to be rendered.
frames: :class:`tuple` of three integers, required
Contains the half-open (start, stop, step) range of frames to be rendered.
"""
lxofile = str(lxofile)
start = int(frames[0])
stop = int(frames[1])
step = int(frames[2])
code = f"""
log.toConsole true
log.toConsoleRolling true
scene.open "{lxofile}"
pref.value render.threads auto
select.Item Render
item.channel first {start}
item.channel last {stop-1}
item.channel step {step}
render.animation {{*}}
app.quit
"""
command = [_modo_executable()]
process = subprocess.Popen(command, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False, universal_newlines=True)
stdout, stderr = process.communicate(code)
print(stdout, stderr)
[docs]def split_frames(lxofile, frames):
"""Render a range of frames from a Modo .lxo file as individual jobs.
Parameters
----------
lxofile: :class:`str`, required
Path to the file to be rendered.
frames: :class:`tuple` of three integers, required
Contains the half-open (start, end, step) of frames to be rendered.
"""
lxofile = str(lxofile)
start = int(frames[0])
end = int(frames[1])
step = int(frames[2])
q = rq.Queue(rq.get_current_job().origin, connection=rq.get_current_connection())
for frame in range(start, end, step):
q.enqueue("buildcat.modo.render_frames", lxofile, (frame, frame+1, 1))