Skip to content

interactive#

-interactive

Start CNode in interactive mode.

The interactive mode gives you the possibility to use Clarisse in pure command line. You can then use Python commands and scripts to create or freely modify projects. To start the interactive mode you must launch CNode with the interactive option:

cnode -interactive

Note

Except for configuration arguments such as -search_path, -config_file etc... all other arguments are ignored when using the interactive mode.

Here is what you should get:

CNODE 5.0 SP10 Copyright (c) 2009-2022 Isotropix SAS.
Build #XXXX MM DD 2022
Isotropix Clarisse command line.
Clarisse licensing up and running.
Entering Interactive Mode...
project:/>>>

Important

In order to be able to script with Python, Clarisse and CNode require Python to be installed in the system. Please check Python in Clarisse section for more information. |

The Prompt#

While running in interactive mode, it's quite similar to using a terminal. You must input commands and press Enter. Here, input commands are any built-in or python ones. For more information on the Python API please refer to the SDK/API Documentation section found the web documentation.

CNode prompt always displays the current path in the project. By default, CNODE current context is the root of the project.

project:/>>>

cd command#

Very much alike a standard shell in which you can change directory, in CNode, you can navigate through your project using the cd command. It's very easy, just type cd path_to_your_context. For example:

project:/>>> cd default
project://default>>>

As displayed by the prompt, you are now located in the default context (project://default). Again similarly to a terminal you can go back up using either:

project://default>>> cd ..
project:/>>>

Or

project://default>>> cd /
project:/>>>

Or

project://default>>> cd project:/
project:/>>>

ls command#

Within a shell, in which ls command is used to list folder content, in CNode it lists the content of a context. Type ls context_path, where context_path can be empty to list the current context.

For example:

project://canyon>>> ls
 c--w 10/16/11 15:46 cliffs
 c--w 10/16/11 15:46 handplaced_rocks
 c--w 10/16/11 15:46 envset
 c--w 10/16/11 15:46 spaceships
 c--w 10/16/11 15:46 lighting
 ---w 10/16/11 15:46 raytracer_previz (RendererRaytracer)
 ---w 10/16/11 15:46 renderCam (CameraPerspective)
 ---w 10/16/11 15:46 previz (Image)
 ---w 10/16/11 15:46 raytracer_hd (RendererRaytracer)
 ---w 10/16/11 15:46 set_geogroup (Group)
 ---w 10/16/11 15:46 spaceships_geogroup (Group)
 ---w 10/16/11 15:46 skyenv_geogroup (Group)
 ---w 10/16/11 15:46 scatter_plants (SceneObjectScatterer)
 ---w 10/16/11 15:46 scatter_rocks (SceneObjectScatterer)
 ---w 10/16/11 15:46 vignette (Image)
 ---w 10/16/11 15:46 vignettemap (TextureMap)
 ---w 10/16/11 15:46 miniride_layered (Image)
 ---w 10/16/11 15:46 miniride (Image)
 ---w 10/16/11 15:46 layout_Cam (CameraPerspective)
 ---w 10/16/11 15:46 glowsky (Image)

As you can see there are a few information on the left of each listed item. Here is the syntax:

flags date time item_name (item class) -> source_name

flags lists the state of the item. c defines if it's a context, p if it's private, s if it's static, w if it's modifiable. item class is the class of the Item. -> source_name is the fullname of the source of the instance.

Useful Python Commands#

Clarisse provides a set of useful commands. They can be found in the Scripting/SDK documentation under Modules clarisse_helper. This helper allows you to quickly load/save projects, render images and so on. As all Clarisse related Python API they are under the namespace ix. For example:

To load a project you can:

project:/>>> ix.load_project("C:/content/canyon/miniride.project")

To render the image you can:

project:/>>> ix.render_image("project://canyon/miniride")

Exiting an Interactive Session#

To exit an interactive session, press Ctrl+D

Stopping a Running Script#

To stop a running script press Ctrl+C