Vz:Doc:IpControl
From M1Research
(Difference between revisions)
(→Commands) |
|||
| Line 2: | Line 2: | ||
By default <b>VZ</b> uses 8001 IP port for that service. To connect to this port and send commands you need a telnet client program. Find appropriate "telnet" program for operating. "putty" is nice free program. | By default <b>VZ</b> uses 8001 IP port for that service. To connect to this port and send commands you need a telnet client program. Find appropriate "telnet" program for operating. "putty" is nice free program. | ||
| + | |||
| + | ==Connecting== | ||
| + | <pre> | ||
| + | [verem@elbrus reports]$ telnet vz-dev 8001 | ||
| + | Trying 10.1.5.23... | ||
| + | Connected to vz-dev.internal.m1stereo.tv (10.1.5.23). | ||
| + | Escape character is '^]'. | ||
| + | ViZualizator (vz-1.0-release) [tcpserver] | ||
| + | |||
| + | vz in$> | ||
| + | </pre> | ||
| + | As use can see vz service is online and is ready to accept commands. | ||
==Commands== | ==Commands== | ||
<b>NOTE!</b> Tune your telnet program for UTF-8 characters. | <b>NOTE!</b> Tune your telnet program for UTF-8 characters. | ||
| - | Each command sent to VZ has javascript-like structure. | + | |
| + | Each command sent to VZ has javascript-like structure. I try to descibe most usefull commands format with examples. | ||
*<code>renderman.load(<scene_name>)</code> | *<code>renderman.load(<scene_name>)</code> | ||
| Line 17: | Line 30: | ||
vz out$> OK</pre> | vz out$> OK</pre> | ||
| - | + | *<code>tree.container.<container_id>.visible=<value></code> | |
| - | < | + | Container visibility control |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | vz in$> | + | *<code>tree.motion.director.<director_id>.start([<position>])</code> |
| - | </pre> | + | *<code>tree.motion.director.<director_id>.stop()</code> |
| - | + | *<code>tree.motion.director.<director_id>.continue()</code> | |
| + | *<code>tree.motion.director.<director_id>.reset([<position>])</code> | ||
| + | Directors (animation) control, for example: | ||
| + | |||
| + | <pre>vz in$> scene.tree.motion.director.main.start() | ||
| + | vz out$> OK</pre> Start animation on director <code>main</code>. | ||
| + | |||
| + | <pre>vz in$> scene.tree.motion.director.main.cont() | ||
| + | vz out$> OK</pre> Continue animation on director <code>main</code> after pausing. | ||
| + | |||
| + | *<code>tree.motion.timeline.<timeline_id>.<t1|t2|y1|y2>=<value></code> | ||
| + | timeline modification. | ||
Revision as of 20:20, 24 March 2007
IP Control protocol is simplest way for VZ control.
By default VZ uses 8001 IP port for that service. To connect to this port and send commands you need a telnet client program. Find appropriate "telnet" program for operating. "putty" is nice free program.
Connecting
[verem@elbrus reports]$ telnet vz-dev 8001 Trying 10.1.5.23... Connected to vz-dev.internal.m1stereo.tv (10.1.5.23). Escape character is '^]'. ViZualizator (vz-1.0-release) [tcpserver] vz in$>
As use can see vz service is online and is ready to accept commands.
Commands
NOTE! Tune your telnet program for UTF-8 characters.
Each command sent to VZ has javascript-like structure. I try to descibe most usefull commands format with examples.
renderman.load(<scene_name>)
Perform scene loading into rendering engine, for example:
vz in$> renderman.load(./projects/demo1.xml) vz out$> OK!Load
tree.function.<function_id>.<parameter_name>=<value>
perform parameter setting for function, for example:
vz in$> scene.tree.function.text_1.s_text=Maksym Veremeyenko vz out$> OK
tree.container.<container_id>.visible=<value>
Container visibility control
tree.motion.director.<director_id>.start([<position>])tree.motion.director.<director_id>.stop()tree.motion.director.<director_id>.continue()tree.motion.director.<director_id>.reset([<position>])
Directors (animation) control, for example:
vz in$> scene.tree.motion.director.main.start() vz out$> OKStart animation on director
main.
vz in$> scene.tree.motion.director.main.cont() vz out$> OKContinue animation on director
main after pausing.
tree.motion.timeline.<timeline_id>.<t1|t2|y1|y2>=<value>
timeline modification.
