========== References ========== Wizard references are a type of `scene description`. You indicate to wizard wich assets you will need in your scene. .. _Create a reference: ------------------ Create a reference ------------------ .. note:: You need to init the work environment before creating a reference, See :ref:`Create a work environment` Go to the references tab. .. image:: _images/references_tab.jpg :width: 1200 :alt: Alternative text Then press Tab, it will open a search tool, you can now search the asset you need by typing its name. Select the needed assets and press enter or double click on the selected asset. .. image:: _images/create_reference.gif :width: 1200 :alt: Alternative text You can also Right click > Add references or click on the |create_reference_button| button. .. |create_reference_button| image:: _images/create_reference_button.png :width: 30 :alt: Alternative text .. note:: When you open the search widget to create a reference, it proposes the published stages of the current asset. .. warning:: If you don't find an asset you want to import, verify that an export exists for this asset. .. note:: You can check 'Reference with auto update' to reference assets with the auto update checked by default. This options is saved in your user settings. .. image:: _images/auto_update_by_default.jpg :width: 1200 :alt: Alternative text --------------- Quick reference --------------- In the references tab, there is a section for creating quick references of stages related to the current asset. For exemple if you are in the stage `shading` of `Albert`, you can click on the |quick_reference_modeling_button| button to import the modeling of `Albert`. .. |quick_reference_modeling_button| image:: _images/quick_reference_modeling_button.png :width: 30 :alt: Alternative text .. image:: _images/quick_import.gif :width: 1200 :alt: Alternative text .. note:: If the stage you want to quick import is not created, the quick import button of this stage will not appear. If there is no export existing for the stage you want to import, you will get an error. ------------------ Modify a reference ------------------ Once you have created a reference you can modify it. You can modify the exported asset and modify the export version. .. note:: The export version is colored, orange mean your reference doesn't points the default export version. Green means you match the default export version. .. image:: _images/modify_reference.gif :width: 1200 :alt: Alternative text The `Auto update` checkbox permits to always match to the default version. If a new version is exported, the reference will always be modified to match the default export version. The default export version can be the last one or choosen by the users in the exports tab. .. image:: _images/auto_update_reference.jpg :width: 1200 :alt: Alternative text ---------------------- Deactivate a reference ---------------------- You can deactivate a reference by unchecking the On/Off toggle. A deactivated reference will not be imported or updated in softwares. .. image:: _images/deactivate_reference.jpg :width: 1200 :alt: Alternative text -------------------------------- Set an export version as default -------------------------------- You can modify the export version that is referenced by default. When you create an export, the default export version is always the last one, but you can declare a specific version as default. For example, if you have 6 export versions but the number 6 is corrupted, you can declare the number 5 as default and the number 6 will be ignored when you reference this asset. To declare a default export version, go to the exports tab .. image:: _images/default_export.jpg :width: 1200 :alt: Alternative text Then modify the default export by selecting the export version and Right click > set as default .. image:: _images/set_default_export_version.gif :width: 1200 :alt: Alternative text To set the last version as default version, select the export parent row and Right click > Set default as always last .. image:: _images/set_default_as_always_last.gif :width: 1200 :alt: Alternative text ------ Groups ------ You can also group references with the group manager. To open the group manager, go to wizard menu > Window > Groups manager .. image:: _images/group_manager.jpg :width: 1200 :alt: Alternative text Create a group by clicking on the |create_variant| button. .. |create_variant| image:: _images/create_variant.png :width: 30 :alt: Alternative text .. image:: _images/create_group.gif :width: 1200 :alt: Alternative text Modify the group color by clicking on the color picker button. .. image:: _images/modify_group_color.gif :width: 1200 :alt: Alternative text Create grouped references by pressing tab or by clicking on the |create_reference_button| button. .. image:: _images/create_grouped_reference.gif :width: 1200 :alt: Alternative text Delete a group by clicking on the |archive_button| in the group manager. ------------------- Referencing a group ------------------- Go to the references tab. .. image:: _images/references_tab.jpg :width: 1200 :alt: Alternative text Then press Tab, it will open a search tool, you can now search the group you need by typing its name. You can also type 'groups' Select the needed groups and press enter or double click on the selected group. .. image:: _images/reference_group.gif :width: 1200 :alt: Alternative text You can also access a group by double clicking on it in the references tab. .. image:: _images/open_group.gif :width: 1200 :alt: Alternative text ------------ Modify state ------------ You can modify the state of the referenced asset, for exemple if there is an error on this reference, switch to `error` and enter your comment. .. image:: _images/modify_reference_state.gif :width: 1200 :alt: Alternative text ------------------ Remove a reference ------------------ Select the references you want to remove and Right click > Remove selected references or click on the |archive_button| button in the references tab .. |archive_button| image:: _images/archive_button.png :width: 30 :alt: Alternative text