Clutter Effect Layer - Revision history

Stokia01: /* Asset Configuration */

2025-04-25T23:04:06Z

Asset Configuration

← Older revision		Revision as of 23:04, 25 April 2025
Line 61:		Line 61:

	Once you start to construct your Trainz mesh library asset be sure to use the [[m.clutter]] material for all your meshes. This will allow your clutter asset to fade in and out where required. You will also want to take note about the fadeInEndDistance and fadeOutEndDistance in your [[mesh metadata file\|mesh metadata files]] to get your fade transitions correct.		Once you start to construct your Trainz mesh library asset be sure to use the [[m.clutter]] material for all your meshes. This will allow your clutter asset to fade in and out where required. You will also want to take note about the fadeInEndDistance and fadeOutEndDistance in your [[mesh metadata file\|mesh metadata files]] to get your fade transitions correct.

			Assets must also be identified as clutter assets using the tag [[Custom category identifier\|custom-category-list]] "FXCLT". Assets identified using this tag will not be visible in the Scenery assets tab in Trainz.

	== Mesh Asset Creation ==		== Mesh Asset Creation ==

Pware: /* See Also */

2024-01-30T10:38:28Z

Pw3r at 06:07, 5 February 2020

2020-02-05T06:07:45Z

← Older revision		Revision as of 06:07, 5 February 2020
Line 17:		Line 17:

	====spacing====		====spacing====
	Controls the distance new clutter objects will spawn from each other.		Controls the distance new clutter objects will spawn from each other. A smaller distance also means more meshes will be added, so this field can heavily impact performance.

	====random-rotation====		====random-rotation====
Line 23:		Line 23:

	====draw-distance====		====draw-distance====
	Sets the maximum distance at which this clutter effect will draw.		Sets the maximum distance at which this clutter effect will draw. The smaller you can make this the better your performance will be, so take the time to consider a sensible value.

	====mesh-assets====		====mesh-assets====
	~~The~~ assets ~~which will~~ be randomly ~~spawned~~ for ~~this effect~~. ~~This controls~~ the ~~visuals for~~ the clutter ~~effect, and~~ you ~~must add at least one mesh here before anything~~ will be ~~visible in the world~~.		This is where you select one or more assets to be randomly generated for your clutter layer.

			* Click the "Add Asset" button to add a new asset row.
			* Click in the text box to show the list of available clutter assets.
			* Select the asset you want to use in from the dropdown list.
			* Adjust the slider next to each asset to determine how frequently to spawn this particular asset.
			* Move the slider all the way to the right to give a very high spawn frequency.
			* Move the slider all the way to the left stop it from spawning altogether (0 spawn frequency).
			* When the slider is all the way to the left a delete button will also be displayed. Click that to remove this asset row.

			Note that performance of each individual mesh asset can vary, so editing this may heavily impact performance.

	====avoid-water====		====avoid-water====

Pw3r at 05:55, 5 February 2020

2020-02-05T05:55:28Z

← Older revision		Revision as of 05:55, 5 February 2020
Line 5:		Line 5:
	== Surveyor Configuration ==		== Surveyor Configuration ==
	In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog\| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.		In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog\| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.

			[[File:clutter_effect_options.jpg\|right]]

	====name====		====name====
	~~[[File:clutter_effect_options.jpg\|right]]~~
	The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.		The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.

Pw3r at 05:55, 5 February 2020

2020-02-05T05:55:03Z

← Older revision		Revision as of 05:55, 5 February 2020
Line 4:		Line 4:

	== Surveyor Configuration ==		== Surveyor Configuration ==
	~~[[File:clutter_effect_options.jpg\|right]]~~

	In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog\| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.		In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog\| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.

	====name====		====name====
			[[File:clutter_effect_options.jpg\|right]]
	The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.		The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.

Pw3r at 05:53, 5 February 2020

2020-02-05T05:53:33Z

← Older revision		Revision as of 05:53, 5 February 2020
Line 4:		Line 4:

	== Surveyor Configuration ==		== Surveyor Configuration ==
			[[File:clutter_effect_options.jpg\|right]]

	In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog\| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.		In Surveyor, effect layers are added and configured using the [[Help:Effect_Layer_Dialog\| Effect Layers dialog]]. Once added to the Route, the effect itself is "painted" onto the world using the topology tools (e.g. "Height up", "Plateau", etc.). Below is a detailed breakdown of the editable fields for a clutter effect layer.

	====name====		====name====
	The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.		The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.

	====clutter-density====		====clutter-density====
	Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.		Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.

	Effect data bindings have 3 configurable field. The first field is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values, but uses more data. This field can also be set to Zero, meaning that it uses no data within the Route files, and every vertex will use the Default value for this binding. The second field is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, but uses more data. A large value is better for quickly bulk filling, and uses much less data storage space, but can be difficult to pain precisely. The final field is the default value. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.		Effect data bindings have 3 configurable field. The first field is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values, but uses more data. This field can also be set to Zero, meaning that it uses no data within the Route files, and every vertex will use the Default value for this binding. The second field is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, but uses more data. A large value is better for quickly bulk filling, and uses much less data storage space, but can be difficult to pain precisely. The final field is the default value. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.

Pw3r at 05:45, 5 February 2020

2020-02-05T05:45:42Z

← Older revision		Revision as of 05:45, 5 February 2020
Line 8:		Line 8:
	====name====		====name====
	The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.		The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.

	====clutter-density====		====clutter-density====
	Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.		Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.

	Effect data bindings have 3 configurable field. The first field is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values, but uses more data. This field can also be set to Zero, meaning that it uses no data within the Route files, and every vertex will use the Default value for this binding. The second field is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, but uses more data. A large value is better for quickly bulk filling, and uses much less data storage space, but can be difficult to pain precisely. The final field is the default value. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.		Effect data bindings have 3 configurable field. The first field is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values, but uses more data. This field can also be set to Zero, meaning that it uses no data within the Route files, and every vertex will use the Default value for this binding. The second field is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, but uses more data. A large value is better for quickly bulk filling, and uses much less data storage space, but can be difficult to pain precisely. The final field is the default value. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.

Pw3r at 05:44, 5 February 2020

2020-02-05T05:44:22Z

← Older revision		Revision as of 05:44, 5 February 2020
Line 12:		Line 12:
	Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.		Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.

	Effect data bindings have 3 configurable ~~values~~. The first ~~value~~ is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values. This field can also be set to Zero, meaning that it uses no data within the Route, and every vertex will use the Default value for this binding. The second ~~value~~ is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, ~~whereas a~~ large value is better for quickly bulk filling. The final ~~value~~ is the default. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.		Effect data bindings have 3 configurable field. The first field is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values, but uses more data. This field can also be set to Zero, meaning that it uses no data within the Route files, and every vertex will use the Default value for this binding. The second field is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, but uses more data. A large value is better for quickly bulk filling, and uses much less data storage space, but can be difficult to pain precisely. The final field is the default value. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.

	====spacing====		====spacing====

Pw3r at 05:40, 5 February 2020

2020-02-05T05:40:56Z

← Older revision		Revision as of 05:40, 5 February 2020
Line 7:		Line 7:

	====name====		====name====
			The name of this effect layer. This is used for display and identification purposes only, and has no effect on use or visuals.

	====clutter-density====		====clutter-density====
	Data storage semantics for the clutter density data.		Data storage semantics for the clutter density data. This controls the amount of data that this effect layer will use within the Route. Allocating more data for an effect layer allows more control over painting it, but there is a (shared) limit to how much data you can allocate for effect layers so it's best to keep this as low as possible.

			Effect data bindings have 3 configurable values. The first value is the bit depth, which controls how much data each effect "vertex" uses. A higher bit depth means more layers of control between the minumum and maximum values. This field can also be set to Zero, meaning that it uses no data within the Route, and every vertex will use the Default value for this binding. The second value is the vertex grid size. This controls the distance between each effect layer vertex. A smaller value means you can paint the effect with very high precision or over a very small area, whereas a large value is better for quickly bulk filling. The final value is the default. The default is used when the bit depth is set to zero, and to pre-fill newly added ground sections.

	====spacing====		====spacing====
Line 20:		Line 24:

	====mesh-assets====		====mesh-assets====
	The assets which will be randomly spawned for this effect.		The assets which will be randomly spawned for this effect. This controls the visuals for the clutter effect, and you must add at least one mesh here before anything will be visible in the world.

	====avoid-water====		====avoid-water====

Pw3r at 05:30, 5 February 2020

2020-02-05T05:30:36Z

← Older revision		Revision as of 05:30, 5 February 2020
Line 8:		Line 8:
	====name====		====name====
	====clutter-density====		====clutter-density====
			Data storage semantics for the clutter density data.

	====spacing====		====spacing====
			Controls the distance new clutter objects will spawn from each other.

	====random-rotation====		====random-rotation====
			Enables/disables random mesh rotation around the height (z) axis.

	====draw-distance====		====draw-distance====
			Sets the maximum distance at which this clutter effect will draw.

	====mesh-assets====		====mesh-assets====
			The assets which will be randomly spawned for this effect.

	====avoid-water====		====avoid-water====
			Whether to avoid rendering this effect under water. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

	====altitude-range====		====altitude-range====
			The minimum and maximum altitude at which to render this effect. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

	====gradient-range====		====gradient-range====
			The minimum and maximum terrain gradient (degrees) on which to render this effect. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

	====ground-texture-mask====		====ground-texture-mask====
			Causes this effect layer to only render on specific ground texture assets. This feature was added for the TRS19 2020q1 subscriber update, and is currently only available to subscribers.

	== Asset Configuration ==		== Asset Configuration ==

← Older revision		Revision as of 10:38, 30 January 2024
Line 78:		Line 78:
	* [[TurfFX_Effect_Layer]]		* [[TurfFX_Effect_Layer]]
	* [[Effect_Layer_Assets]]		* [[Effect_Layer_Assets]]
			* [[Color_effect_layer\|Color Effect Layer]]

	Back to [[Effect_Layer]]		Back to [[Effect_Layer]]