Template Project: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
 
(79 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{learned|what a template is|about project templates in the Tygron Engine|about the available default project templates in the Tygron Engine|how to make a project template|how you can share your project template within your domain}}
[[File:Api_tools_geo.png|thumb|right|400px|[[Template]] in relation to [[Source]]s and [[Geo Plugin]]s]]
A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same [[Indicators]] and [[Actions]]. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.


==What is a template in the Tygron Engine==
==Which elements are transferred to a new project==
A template is a project that can be used to create a new project with. This new project can have a different location as the original template project, but has the same  [[Indicators]], [[Actions]], [[Overlays]] settings etc. as the  template project. This is very convenient in case a similar spatial issue is at hand on different locations and you want to create different projects for these locations. Also, this functionality enables the user to make elaborate predefined actions or custom indicators, which can then be easily transposed with a template to another area.
In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.
This functionality saves a lot of time and makes preparing projects faster.


==What is transferred to a new project==
===Elements that ''are transferred'' to a new project===
In a template project, certain elements are transferred to a new project, created with the template.
* [[Indicator]]s
These elements are the elements that are not spatial, thus the elements that are not linked to a location.
* [[Stakeholder]]s
These are for example:
* [[Overlay]]s and their settings, such as the grid size
* [[Indicators]]
* New [[Functions]]/changes in [[function values]]
* [[Overlays]]  
* New [[Terrain Type]]s/changes in terrain types
* [[Stakeholders]]
* [[Global]]s
* [[Panels]] (the location of the panels must be set)
* [[Action Menu]]s
* New [[functions]]/changes in function values
* New/changed [[Upgrade Type]]s
* [[Globals]]
* [[Actions]]
* New/changed [[Upgrade types]]
* [[WFS]] connections in the [[Geo Data Wizard]]
* [[WFS]] connections in the [[Geo Data Wizard]]
* [[Geo Plugin]]s


===Elements that are ''not transferred'' to a new project===
* [[Area]]s, [[Building]]s, [[Neighborhood]]s, [[Network]]s,[[Plot]]s, [[Terrain]]s, [[Zone]]s
:These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
* [[Measure]]s
:Measures which are drawn at a certain location and therefore are not applicable to other locations/projects.
* [[Cinematics]]
:A cinematic has one or more key point locations within the project area, which will not be applicable to other locations/projects.
* [[Panel]]s
: Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.


Elements that are not transferred to a new project are for example:
===Transferred elements that rely on spatial data===
* (Imported) [[Areas]]. The areas have a certain location in the template project. The new project is very likely on a new location and therefore the areas are not in that location and in the new project
* [[Overlay]]s
* [[Measures]]. Measures are drawn on a certain location, this location is also not present in the new project anymore
: Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the [[Rainfall Overlay]], such as water areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, ''are'' transferred from the template.
* [[Cinematics]]. In a cinematic, the camera has a certain location in the 3D world, since the location is different in the new project, the cinematic will not be trasnferred.


==How to create a template project==
===Template settings===
To create a template project, start with a project that you want to use as a template for other projects.
[[File:Template_settings_panel.png|right|500px]]
In the template settings screen, the data sources that should be used by default when using this template, can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on the template.


The map needs to be cleared, so the project is as small as possible. This will ensure the creation of a new project based on the template will be as fast as possible.
{{Editor location|Template}}


The clear map option is a permanent setting and can't be undone. Even if the project is not saved after the map is cleared, when opening the project again the map will be empty. Therefore it is recommended to create a new version first, or to make a copy of your project by saving the project under a different name.  
In the template settings screen, the data sources that should be used by default when using this template, can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template. Changes made are stored in [[Geo Option]] items.


See below for the steps.
{{Editor steps|title=create a template project|Start with a project you want to use as a template|Create a new version of your project|Go in the Editor Ribbon to Tools --> Template --> Template settings.|Set the desired data sources for new projects based on this template| Clear map. '''Warning''': this will remove the 3D world from your project and can't be undone. Therefore you have created a new version first in step 2.|When the map is cleared, save the project under a new name so as to create a new project or create a new version|Close the project|Log in to the menu (make sure you have domain admin rights)|Go to "Options" and then select "Projects"| Click on the Check box named "Template" to mark the project as a template}}


==How to add your own template==
{{article end
|howtos=
* [[How to create a Template Project]]
* [[How to share a Template Project with other users in your domain]]
* [[How to base a new Project on a Template Project]]
|videos={{video|gallery=
{{video|link=https://youtu.be/VZrazrmgYZM|description=Video tutorial on using Template Projects.}}
}}
}}


 
{{editor tools nav}}
: '''Setting a project as a template makes the project read only!'''
[[Category:Project Metadata]]
<br clear=all>
{{Editor steps|title=set a project as template|Log in with Domain Admin rights|Select "Options"|Select "Projects"| Highlight project to be made a template| Check box named "Template (project becomes read only)"}}
 
==Sharing your template with other users in your domain==
[[File:Q1-2016-TemplatePermissions2.jpg|right|400px]]
: When a project has been made a project template, the read and write permissions will change. This is to ensure that nobody accidentally edits the project template. No write permissions remain (project cannot be edited anymore) and only the creator can read the template by default. In order to change the read permissions, so that other users within the same domain can also use the template, the creator can change the permissions of the original project in the editor.
<br clear=all>
{{Editor steps|title=share the template with other users in your domain|Load in the editor the template project to be shared with the domain|Select "File" when in main view|Select "Permissions"| Change the entry for "Other users in domain" to "Read"|Save project}}

Latest revision as of 14:45, 28 September 2023

Template in relation to Sources and Geo Plugins

A template (project) contains a predefined generic structure that can be copied when creating a new project. This new project can have a location that differs from the template project upon which it is based. However, it will, for instance, contain the same Indicators and Actions. This can be convenient in cases of similar spatial issues at hand that occur at different locations that require different projects. Also, this functionality enables the user to develop elaborate predefined actions and custom indicators, which can then be easily applied to multiple areas/projects by simply using a template, saving the user a lot of time and effort in the long run.

Which elements are transferred to a new project

In a template project, elements that are not spatial, that is, not linked to a specific location, will be transferred to a new project.

Elements that are transferred to a new project

Elements that are not transferred to a new project

These type of spatial objects are bound to a specific location in the template project and are therefore not migrated to other locations/projects.
Measures which are drawn at a certain location and therefore are not applicable to other locations/projects.
A cinematic has one or more key point locations within the project area, which will not be applicable to other locations/projects.
Panels which are position or are instances of panel templates, which will not be applicable to other locations/projects due to removed content items.

Transferred elements that rely on spatial data

Overlays are transferred to a new project (they will be recalculated for the new project), as will the settings in the template project, such as the grid size. However, specific data that are imported and used for, for instance, the Rainfall Overlay, such as water areas and weirs, are spatial data and are therefore not transferred to the new project. These datasets should therefore be imported manually into the new project. On the contrary, settings such as the length and duration of the rainfall event, are transferred from the template.

Template settings

Template settings panel.png
Editor → Tools (Ribbon tab) → Template (Ribbon bar)

In the template settings screen, the data sources that should be used by default when using this template, can be set. For example AHN3 can be selected so that the AHN3 is always used when creating a project based on that template. Changes made are stored in Geo Option items.


How-to's

Videos

Video tutorial on using Template Projects.
Editor ribbon icon tools.pngTools
Tools
Building style • Environment • Cinematics • Screenshot • Free Cam • Web Interface • API Overview • Triggers • Template • Geo Plugins • Debug Info
Environment
Sun angle • Solar Panels • Lighting • Weather
Cinematics
Special Effects • Particle Emitters
Screenshot
GIF animation • Video recording
Geo Plugins
Error Logs • Geo Links • Geo Options • Sources
Editor
Current Situation • Future Design • Multi Scenario • Tools • Community
Retrieved from "https://support.tygron.com/w/index.php?title=Template_Project&oldid=55578"