KIND Texture - Revision history

Builderbob: Rewrite.

2019-04-28T05:49:43Z

Rewrite.

← Older revision		Revision as of 05:49, 28 April 2019
Line 1:		Line 1:
	[[KIND Texture]] is a ~~kuid-assigned data type definition which 'exposes' a simple~~ texture ~~within the Trainz data base~~ as an ~~general kuid selectable~~ asset~~, ''as opposed to a 'private' texture available only to the self-definition of a single~~ asset''.		[[KIND Texture]] defines a single texture as an asset that can be referenced from another asset or via scripting.

	~~These explicitly defined textures become~~ a ~~public and shared resource that can be referenced by [[KUID]] for use~~ as a custom corona, for example for several or many content assets. This is a desirable practice with respect to file byte-counts—textures in a typical Trainz install have been shown by independent Trainz users to take up over half the HDD data space needed in local content.		Making a texture available as an asset may reduce resource requirements where the texture is used by a number of assets, and may assist in maintaining consistency between different variations of the same basic asset. [[KIND Texture-group]] serves a similar function where there are multiple textures associated with a group of assets.

	~~Exposing and reusing a common texture allows many assets to share it and minimizes the HDD footprint of the~~ asset ~~whilst also cutting down the amount of memory the texture needs in RAM memory. This in turn can have large posative performance benefits in~~ the ~~case where an~~ texture ~~asset~~ is used ~~frequently on~~ a ~~Trainz-board region, for example as part~~ of ~~the definition of the streets, roads~~, and ~~bridges~~ in ~~a town or alternatively as~~ the ~~bark or leaf texture in~~ a ~~forest of trees, in a common spline scenery object such as shrubbery, and so forth. The more instanced objects~~ are ~~enumerated for the graphics engine to render, the more incremental payback~~ a ~~common element such as this texture asset will return~~.

	==Parent Classes==		==Parent Classes==
	* [[KIND TrainzBaseSpec]]		* [[KIND TrainzBaseSpec]]
	==Child Classes==		==Child Classes==
	* ~~None.~~		* [[KIND Groundtexture]]

	==Supported Tags==		==Supported Tags==
			The KIND Texture config.txt file supports the following tags. Each tag is shown here with its default value.

			texture <null>
			subblend 0
			subrotation 0

	====texture====		====texture====
	:Type: [[Texture file]]		:Type: [[Texture file]]
	:Compulsory: 3.4		:Compulsory: 3.4
	:Description: Name of ~~image to be used expressed in~~ [[texture file]] ~~format~~. See example below.		:Default: None
			:Description: Name of texture. Note that this is a [[texture file]], not an image file. See example below.

	====subblend====		====subblend====
	:Type: Float		:Type: Float
	:Compulsory: No		:Compulsory: No
			:Default: 0.00
	:Description: ''TBD''		:Description: ''TBD''

Line 25:		Line 30:
	:Type: Float		:Type: Float
	:Compulsory: No		:Compulsory: No
			:Default: 0.00
	:Description: ''TBD''		:Description: ''TBD''

	==Example Config.txt==		==Example Config.txt==
	*'''[[Texture file]]s''' are ASCII specification files (text format) instructing ContentManager (CM) how to render each single texture.
	*Texture files have a ".texture.txt" name extension within the assets' folder		kuid <kuid:101046:104687>
	*Texture files within a config.txt file such as the below ''MUST NOT'' have the ''''.txt'''' extension, or CM will generate an error.		username "Corona Red diffuse"
	<tt>		kind "texture"
	~~{\|width="100%" text-align=~~"~~center~~" ~~float="center" bgcolor="#FAFAFC" <!--~~		trainz-build 3.5
	~~#F0F8FF~~" ~~---> padding="9px~~"		texture "orange.texture"
	~~\|- border="1"~~		category-class "JC"
	~~\| '''Tag or structure braces''' \|\| '''Data fields'''~~		category-era "1800s"
	\|-		category-region "AU"
	~~\| kuid \|\|<kuid:56113:1267>~~		description "A Red corona.
	\|-		subblend 0.50
	\| trainz-build ~~\|\| 2~~.5		subrotation 45.00
	\|-		thumbnails
	~~\| category-class \|\|~~ "JO"		{
	\|-		0
	\| category-~~region\|\|~~ "AU"		{
	\|-		image "$screenshot$.jpg"
	\| category-era \|\| "~~2000s;2010s~~"		width 240
	\|-		height 180
	~~\| username \|\|~~ "~~testTexture~~"		}
	\|-		}
	~~\| kind \|\| "texture~~"
	\|-		The above "texture" tag value 'orange.texture' specifies a [[Texture file]] which contains the information about the image to be used for the texture.
	~~\| '''texture \|\| "eg~~.~~texture"'''~~
	\|-		==See Also==
	\| thumbnails\|\|		* [[KIND Texture-group]]
	\|-		* [[KIND Groundtexture]]
	\| { \|\|
	\|-
	\| 0\|\|
	\|-
	~~\|      ~~ {\|\|
	\|-
	~~\|      ~~ image \|\| "~~thumb~~.jpg"
	\|-
	~~\|      ~~ width \|\| 240
	\|-
	~~\|      ~~ height \|\| 180
	\|-
	~~\|      ~~ }\|\|
	\|-
	~~\| }\|\|~~
	\|}
	~~</tt>~~
	The above "texture" tag specifies a [[Texture file]] ~~located within~~ the [[~~asset folder~~]].

	==Categories==		==Categories==
	[[Category:Asset KIND\|Texture]]		[[Category:Asset KIND\|Texture]]
	[[Category:TBD\|Texture]]		[[Category:TBD\|Texture]]

Builderbob: /* Child Classes */ Restored to "None".

2016-10-01T05:34:42Z

Child Classes: Restored to "None".

← Older revision		Revision as of 05:34, 1 October 2016
Line 8:		Line 8:
	* [[KIND TrainzBaseSpec]]		* [[KIND TrainzBaseSpec]]
	==Child Classes==		==Child Classes==
	* ~~Whichever assets make use of the new common texture resource~~.		* None.

	==Supported Tags==		==Supported Tags==

Pcas1986: Added texture tag

2014-03-01T02:31:30Z

Added texture tag

← Older revision		Revision as of 02:31, 1 March 2014
Line 11:		Line 11:

	==Supported Tags==		==Supported Tags==

			====texture====
			:Type: [[Texture file]]
			:Compulsory: 3.4
			:Description: Name of image to be used expressed in [[texture file]] format. See example below.

	====subblend====		====subblend====

Pcas1986: Added missing tags although the meaning of those tags is unknown

2014-03-01T02:16:22Z

Added missing tags although the meaning of those tags is unknown

← Older revision		Revision as of 02:16, 1 March 2014
Line 1:		Line 1:
	~~{{ORP-top}}~~
	[[KIND Texture]] is a kuid-assigned data type definition which 'exposes' a simple texture within the Trainz data base as an general kuid selectable asset, ''as opposed to a 'private' texture available only to the self-definition of a single asset''.		[[KIND Texture]] is a kuid-assigned data type definition which 'exposes' a simple texture within the Trainz data base as an general kuid selectable asset, ''as opposed to a 'private' texture available only to the self-definition of a single asset''.

Line 12:		Line 11:

	==Supported Tags==		==Supported Tags==
	TBD.
			====subblend====
			:Type: Float
			:Compulsory: No
			:Description: ''TBD''

			====subrotation====
			:Type: Float
			:Compulsory: No
			:Description: ''TBD''

	==Example Config.txt==		==Example Config.txt==
Line 64:		Line 72:
	[[Category:Asset KIND\|Texture]]		[[Category:Asset KIND\|Texture]]
	[[Category:TBD\|Texture]]		[[Category:TBD\|Texture]]
	~~{{ORP-bot\|Texture}}~~

Fabartus: --KIND Texture (redundant, wikimarkup rendering produces automatically)

2013-11-20T16:42:10Z

--KIND Texture (redundant, wikimarkup rendering produces automatically)

← Older revision		Revision as of 16:42, 20 November 2013
Line 1:		Line 1:
	~~=KIND Texture=~~
	{{ORP-top}}		{{ORP-top}}
	[[KIND Texture]] is a kuid-assigned data type definition which 'exposes' a simple texture within the Trainz data base as an general kuid selectable asset, ''as opposed to a 'private' texture available only to the self-definition of a single asset''.		[[KIND Texture]] is a kuid-assigned data type definition which 'exposes' a simple texture within the Trainz data base as an general kuid selectable asset, ''as opposed to a 'private' texture available only to the self-definition of a single asset''.

Fabartus: +{{ORP-top}}+{{ORP-bot}} and clarify

2013-11-20T16:40:46Z

+{{ORP-top}}+{{ORP-bot}} and clarify

← Older revision		Revision as of 16:40, 20 November 2013
Line 1:		Line 1:
	[[KIND Texture]] exposes a simple texture as an asset. These can be referenced by [[KUID]] for use as a custom corona, for example.		=KIND Texture=
			{{ORP-top}}
			[[KIND Texture]] is a kuid-assigned data type definition which 'exposes' a simple texture within the Trainz data base as an general kuid selectable asset, ''as opposed to a 'private' texture available only to the self-definition of a single asset''.

			These explicitly defined textures become a public and shared resource that can be referenced by [[KUID]] for use as a custom corona, for example for several or many content assets. This is a desirable practice with respect to file byte-counts—textures in a typical Trainz install have been shown by independent Trainz users to take up over half the HDD data space needed in local content.

			Exposing and reusing a common texture allows many assets to share it and minimizes the HDD footprint of the asset whilst also cutting down the amount of memory the texture needs in RAM memory. This in turn can have large posative performance benefits in the case where an texture asset is used frequently on a Trainz-board region, for example as part of the definition of the streets, roads, and bridges in a town or alternatively as the bark or leaf texture in a forest of trees, in a common spline scenery object such as shrubbery, and so forth. The more instanced objects are enumerated for the graphics engine to render, the more incremental payback a common element such as this texture asset will return.

	~~=KIND Hierarchy=~~
	==Parent Classes==		==Parent Classes==
	* [[KIND TrainzBaseSpec]]		* [[KIND TrainzBaseSpec]]
	==Child Classes==		==Child Classes==
	* ~~''none~~.''		* Whichever assets make use of the new common texture resource.

	==Supported Tags==		==Supported Tags==
Line 55:		Line 60:
	\|}		\|}
	</tt>		</tt>
	The above "texture" tag specifies a [[Texture file]] located within the asset folder.		The above "texture" tag specifies a [[Texture file]] located within the [[asset folder]].

	==Categories==		==Categories==
	[[Category:Asset KIND]]		[[Category:Asset KIND\|Texture]]
	[[Category:TBD]]		[[Category:TBD\|Texture]]
			{{ORP-bot\|Texture}}

Fabartus: /* Example Config.txt */ tweak

2013-06-28T14:16:56Z

Example Config.txt: tweak

← Older revision		Revision as of 14:16, 28 June 2013
Line 15:		Line 15:
	*Texture files within a config.txt file such as the below ''MUST NOT'' have the ''''.txt'''' extension, or CM will generate an error.		*Texture files within a config.txt file such as the below ''MUST NOT'' have the ''''.txt'''' extension, or CM will generate an error.
	<tt>		<tt>
	{\|width="100%" text-align="center" float="center" bgcolor="#~~E6E6FA~~"<!--#F0F8FF" --->		{\|width="100%" text-align="center" float="center" bgcolor="#FAFAFC" <!--
			#F0F8FF" ---> padding="9px"
	\|- border="1"		\|- border="1"
	\| '''Tag or structure braces''' \|\| '''Data fields'''		\| '''Tag or structure braces''' \|\| '''Data fields'''

Fabartus: /* Example Config.txt */ annotate, tablize approximating config.txt spacings

2013-06-28T14:08:56Z

Example Config.txt: annotate, tablize approximating config.txt spacings

← Older revision		Revision as of 14:08, 28 June 2013
Line 11:		Line 11:

	==Example Config.txt==		==Example Config.txt==
			*'''[[Texture file]]s''' are ASCII specification files (text format) instructing ContentManager (CM) how to render each single texture.
	kuid <kuid:56113:1267>		*Texture files have a ".texture.txt" name extension within the assets' folder
	trainz-build 2.5		*Texture files within a config.txt file such as the below ''MUST NOT'' have the ''''.txt'''' extension, or CM will generate an error.
	category-class "JO"		<tt>
	category-region "AU"		{\|width="100%" text-align="center" float="center" bgcolor="#E6E6FA"<!--#F0F8FF" --->
	category-era "2000s;2010s"		\|- border="1"
	username "testTexture"		\| '''Tag or structure braces''' \|\| '''Data fields'''
	kind "texture"		\|-
	texture "eg.texture"		\| kuid \|\|<kuid:56113:1267>
	thumbnails		\|-
	{		\| trainz-build \|\| 2.5
	0		\|-
	{		\| category-class \|\| "JO"
	image "thumb.jpg"		\|-
	width 240		\| category-region\|\| "AU"
	height 180		\|-
	}		\| category-era \|\| "2000s;2010s"
	}		\|-
			\| username \|\| "testTexture"
	The "texture" tag specifies a [[Texture file]] located within the asset folder.		\|-
			\| kind \|\| "texture"
			\|-
			\| '''texture \|\| "eg.texture"'''
			\|-
			\| thumbnails\|\|
			\|-
			\| { \|\|
			\|-
			\| 0\|\|
			\|-
			\|       {\|\|
			\|-
			\|       image \|\| "thumb.jpg"
			\|-
			\|       width \|\| 240
			\|-
			\|       height \|\| 180
			\|-
			\|       }\|\|
			\|-
			\| }\|\|
			\|}
			</tt>
			The above "texture" tag specifies a [[Texture file]] located within the asset folder.

	==Categories==		==Categories==
	[[Category:Asset KIND]]		[[Category:Asset KIND]]
	[[Category:TBD]]		[[Category:TBD]]

Windwalkr at 11:51, 10 February 2013

2013-02-10T11:51:40Z

← Older revision		Revision as of 11:51, 10 February 2013
Line 1:		Line 1:
	~~You can reference~~ a simple texture as an asset. These can be referenced by ~~kuid~~ for use as a custom corona, for example.		[[KIND Texture]] exposes a simple texture as an asset. These can be referenced by [[KUID]] for use as a custom corona, for example.

	~~Sample config~~.txt:		=KIND Hierarchy=
			==Parent Classes==
			* [[KIND TrainzBaseSpec]]
			==Child Classes==
			* ''none.''

			==Supported Tags==
			TBD.

			==Example Config.txt==

	kuid <kuid:56113:1267>		kuid <kuid:56113:1267>
Line 26:		Line 35:
	==Categories==		==Categories==
	[[Category:Asset KIND]]		[[Category:Asset KIND]]
			[[Category:TBD]]

Windwalkr at 08:53, 18 October 2010

2010-10-18T08:53:32Z

← Older revision		Revision as of 08:53, 18 October 2010
Line 3:		Line 3:
	Sample config.txt:		Sample config.txt:

	~~[[TagName_Kuid\|~~kuid]] <kuid:56113:1267>		kuid <kuid:56113:1267>
	~~[[TagName_Trainz-build\|~~trainz-build]] 2.5		trainz-build 2.5
	~~[[TagName_Category-class\|~~category-class]] "JO"		category-class "JO"
	~~[[TagName_Category-region\|~~category-region]] "AU"		category-region "AU"
	~~[[TagName_Category-era\|~~category-era]] "2000s;2010s"		category-era "2000s;2010s"
	~~[[TagName_Username\|~~username]] "testTexture"		username "testTexture"
	~~[[TagName_Kind\|~~kind]] "texture"		kind "texture"
	~~[[TagName_Texture\|~~texture]] "eg.texture"		texture "eg.texture"
	~~[[%22Thumbnails%22_container\|~~thumbnails]]		thumbnails
	{		{
	0		0