Viz Artist User Guide

Version 3.14 | Published October 30, 2020 ©

Scene Tree Menu

At the top of the Scene Tree area is a control menu:

images/download/attachments/50613437/tk_stl.png

  • Tree

    • Tree: Shows an overview of all the Containers in the Scene (see Tree Button).

    • Sort: Sorts the items in the Scene Tree based upon criteria that are set in the Display area (see Scene Tree Menu).

    • Search: Searches items in the Scene Tree (see Scene Tree Menu).

  • Media Assets Manager: In the Media Asset Manager, add Media Assets to a Scene as:

    • DVE

    • Texture

  • images/download/attachments/50613437/tk_log_err.png Scene Log: Shows if an error occurs. Opens the Log window, which gives information about the loading process of the Scene, such as errors, for example if a plug-in is not found. Click on it to open the Scene Log. If the log window is closed, but not cleared, the exclamation mark icon shows in gray. It shows red again if another fault occurs.

  • images/download/thumbnails/50613437/tk_ve_ico.png Media Asset Properties Editor: Opens the Media Asset Panel Editor panel of the Scene Settings.

  • images/download/thumbnails/50613437/tk_sp_ico.png Scene plug-in: Opens the Plug-in panel panel of the Scene Settings. In the plug-in panel, Scene plug-ins can be added to the current Scene. This icon turns orange when a Scene contains a Scene plug-in. Click on the icon to view the Scene plug-in properties panel.

  • images/download/thumbnails/50613437/tk_sti.png Scene Info: Opens the Scene Information window, which gives information about the Scene entered by the designer. Shows orange if information is available.

This section contains information on the following topics:

Tree Button

If the Tree button is clicked, all Containers are shown in the hierarchical Scene Tree Menu.

images/download/attachments/50613437/tk_stl.png

  • images/download/attachments/50613437/tk_tree_fav.png Show/Hide Favorites: Shows or hides the Favorites Bar.

  • images/download/thumbnails/50613437/tk_tb_lockun.png Lock/Unlock: Locks or unlocks the ability to modify the transformation of selected Containers in the Scene Editor. Middle mouse click to lock or unlock all Containers.

  • images/download/thumbnails/50613437/tk_tb_showyn.png Show/Hide: Shows or hides selected Containers in the Scene Editor, and eventually in the final rendered output. Middle mouse click to show or hide all Containers.

  • images/download/thumbnails/50613437/tk_tb_onc.png Expand/Collapse: Expands or collapses the Scene Tree.

  • images/download/thumbnails/50613437/tk_script_ss.png Start/Stop: Starts (compiles) or stops all Container scripts.

  • images/download/thumbnails/50613437/tk_tb_zio.png Zoom In/Zoom Out: Zooms in (larger Containers) or Zooms out (smaller Containers) on the Container tree. Zoom out applies smaller icons to the Containers. This gives a better overview, especially in complex Scenes.

  • images/download/thumbnails/50613437/tk_tb_groupun.png Group/Ungroup: Creates a new container group, and places the selected Containers as Sub-Containers. The Ungroup button moves the Sub-Containers up one level.

  • images/download/thumbnails/50613437/tk_tb_sj.png Merge/Split: Merges the selected Containers to one compound object, or splits an existing compound object.

  • images/download/thumbnails/50613437/tk_tb_ag.png Create Group: Creates a new empty group at the top of the Scene Tree. Drag the icon to place a new group at a specific place in the Scene Tree.

  • images/download/thumbnails/50613437/tk_tree_c.png Color: Applies a color to selected Containers. You can define text labels for the colors in the Global Settings Panel to make them more descriptive.

  • images/download/thumbnails/50613437/tk_refresh.png Refresh: Refreshes the Scene Tree. Use this button if scripts have been deployed to change the Scene Tree.

Scene Tree View

images/download/attachments/50613437/tk_scenetree.png

Sort Button

Click the Sort button to enable the Scene Tree Menu, where the items in the Scene Tree can be sorted based on various criteria. A sorted Scene Tree makes it possible to analyze the Scene and optimize the performance.

images/download/attachments/50613437/tk_sorttree.png

  • images/download/attachments/50613437/tk_tree_fav.png Show/Hide Favorites: Shows or hides the Favorites Bar .

  • images/download/thumbnails/50613437/tk_ts_vertices.png Vector: Sorts the Scene Tree by the number of vectors the Containers (which have Geometries) have. The Container with most vectors is shown on top.

  • images/download/thumbnails/50613437/tk_tsort_rtime.png Render Time: Sorts the Scene Tree by the time it takes to render the Containers. Each Container is shown with the percentage of total time the Scene takes to be rendered. The Container with the highest percentage is shown on top.

  • images/download/thumbnails/50613437/tk_tree_c.png Sort by Colors: Filters Containers by color. Click on the icon, and click on each required color to filter.

    images/download/attachments/50613437/tk_sort_c.png
  • images/download/thumbnails/50613437/tk_ts_texsize.png Texture Size: Sorts the Scene Tree by the size of the Container texture. The Container with the largest texture size is shown on top.

  • images/download/thumbnails/50613437/tk_ts_unique.png Unique: Shows unique group objects with the same Texture only once. This option is only available if the Containers are sorted by Texture size (click the Texture Size button).

  • images/download/thumbnails/50613437/tk_refresh.png Refresh: Refreshes the Scene Tree.

  • images/download/attachments/50613437/tk_ts_input.png The input box defines the number of search results displayed. Click R to set to default number of search results (20).

Scene Tree Sort View

images/download/attachments/50613437/tk_stsort.png

Search Button

Click Search button to access the search controls. Here you can search for items in the scene tree, and inside containers scripts and scene scripts.

images/download/attachments/50613437/search_bar.jpg

Use the different buttons to search for specific properties of the Scene (see Search Options) or highlight the search results. Search results are highlighted in the Scene Tree, and the number of search results are displayed.

Example: If a plug-in (for example Extrude) is dragged to Properties, clicking the Show all button highlights all occurrences of that plug-in within the Scene Tree.

Search Options

images/download/attachments/50613437/search_barc.jpg

  • Name: Search for Containers with a specified name. Type the search string in the Name field (1). Wildcards, for example *, ? and [ ], may be used in the search.

    Tip: By default, the text wildcard character, *, is added to the start and at the end of the search string. This means that searching for player finds any node named player in the scene tree, and also nodes named for instance player-name or secondplayername.

    Click on the drop arrow (2) to show extended search parameters. Options are to search for Parameter, Values and plug-in names within the Scene. When the extended parameters option is active, all other search options than Name are inactive.

  • images/download/attachments/50613437/search_con.jpg Search for Containers: Searches in the tree for container properties.

  • images/download/attachments/50613437/search_script.jpg Search in Script: Searches all scripts in your scene, container scripts and scene scripts.

  • images/download/attachments/50613437/si_script.jpg Show in Script: Shows the search results inside the script editor.

  • images/download/attachments/50613437/tk_drop_sl.png Drop area for Properties: Drag an item from the Server Panel, from a Container in the Scene Tree or from the Favorites Bar to search for its occurrence within the Scene.

  • images/download/attachments/50613437/tk_tb_hide.png Hidden: Searches for all hidden Containers.

  • images/download/attachments/50613437/tk_tb_lock.png Locked: Searches for all locked Containers.

  • images/download/attachments/50613437/tk_search_ip.png Inactive Properties: Searches for Containers that contain properties that are set to inactive.

  • images/download/thumbnails/50613437/tk_ctiles.png Color: Searches for all Containers with the assigned color tile.

Show Search Results

  • images/download/thumbnails/50613437/tk_ts_next.png Show Next: Shows the next result.

  • images/download/thumbnails/50613437/tk_ts_prev.png Show Previous: Shows the previous result.

  • images/download/thumbnails/50613437/tk_ts_first.png Show First: Shows the first result.

  • images/download/thumbnails/50613437/tk_ts_last.png Show Last: Shows the last result.

  • images/download/thumbnails/50613437/tk_ts_all.png Show All: Shows all results.

  • images/download/attachments/50613437/found.jpg Search Results: Shows how many results were found.

    Tip: If a specific plug-in is no longer to be used in a Scene, make a search for the plug-in and select Show All to highlight all the results. Drag one of the highlighted plug-ins to the trash can, and all the highlighted plug-ins are deleted from the Scene.

    Tip: If Show all search results is selected, the transformation properties can be changed for all highlighted Containers.

    Tip: If Show all search results is selected, a plug-in or an item (except a Scene) can be added to all the highlighted Containers (drag a plug-in or an item to one of the highlighted Containers).

To Do an Extended Search

images/download/attachments/50613437/search_extend.jpg

  1. Go to the Scene Tree and click Search.

  2. Click drop arrow to show the extended search options (1).

  3. Enter a search criteria. The search criteria can be a combination of Parameter, Value and plug-in name. Below are some examples:

    • Parameter: tesselation, width, *show*

    • Value: 20, *10.0*

    • Plugin: *rect*

  4. Press Enter.

  5. Use the Show Search Results buttons to navigate the Scene Tree.

    Tip: Use the label names in the plug-in editors as a search criteria. If there is no hit, use the asterisk ( * ) symbol.

To Do a Script Search

images/download/attachments/50613437/search_scripts.jpg

  1. Load a scene that contains scripts, either scene scripts, container scripts, or both script types.

  2. Go to the Scene Tree and click Search to open the search fields.

  3. Enter your search term, then click the Search Script icon.

  4. The search result contains all container scripts and scene scripts that contain the search term within the script code.

  5. Clicking the Show in Script button to open the selected script and highlight the search result inside the script window:

    images/download/attachments/50613437/search_results.jpg
  6. You can also click Scene Script to open the scene Script Editor, highlighting the search result inside the script window:

    images/download/attachments/50613437/sis_script.jpg

Tip: You can also perform an advanced search inside the script editor, to search not just within a single script but in all scripts used in the scene.