"Bogeys" container - Revision history

Rob: /* reversed */

2019-05-06T23:19:28Z

reversed

← Older revision		Revision as of 23:19, 6 May 2019
Line 17:		Line 17:
	====reversed====		====reversed====
	:Type: Boolean		:Type: Boolean
	:Desc: Reverses the animation direction~~, use~~ when the bogie attachment point in the traincar asset has been rotated 180 degrees around the Z axis. 1 is reversed. 0 is not reversed and the default value.		:Desc: Reverses the animation direction. Used when the bogie attachment point in the traincar asset has been rotated 180 degrees around the Z axis. 1 is reversed. 0 is not reversed and the default value.

	====rotation-permitted====		====rotation-permitted====

Rob: /* reversed */

2019-05-06T23:17:42Z

reversed

← Older revision		Revision as of 23:17, 6 May 2019
Line 17:		Line 17:
	====reversed====		====reversed====
	:Type: Boolean		:Type: Boolean
	:Desc: Reverses the animation direction when the bogie attachment point in the asset has been rotated 180 degrees around the Z axis. 1 is reversed. 0 is not reversed and the default value.		:Desc: Reverses the animation direction, use when the bogie attachment point in the traincar asset has been rotated 180 degrees around the Z axis. 1 is reversed. 0 is not reversed and the default value.

	====rotation-permitted====		====rotation-permitted====

Rob at 23:14, 6 May 2019

2019-05-06T23:14:34Z

← Older revision		Revision as of 23:14, 6 May 2019
Line 17:		Line 17:
	====reversed====		====reversed====
	:Type: Boolean		:Type: Boolean
	:Desc: ~~Allows~~ the bogie ~~asset to be reversed at its~~ attachment point~~. i.e.~~ 180 degrees in the ~~asset~~ Z axis. 1 is reversed. 0 is not reversed and the default value.		:Desc: Reverses the animation direction when the bogie attachment point in the asset has been rotated 180 degrees around the Z axis. 1 is reversed. 0 is not reversed and the default value.

	====rotation-permitted====		====rotation-permitted====

Pcas1986: A rewrite to make this page conform to similar container pages. The tag descriptions are new but the examples are as before but ordered into a list. I removed the comments about TC3 and compliance with earlier versions of Trainz.

2014-02-11T06:00:28Z

A rewrite to make this page conform to similar container pages. The tag descriptions are new but the examples are as before but ordered into a list. I removed the comments about TC3 and compliance with earlier versions of Trainz.

← Older revision		Revision as of 06:00, 11 February 2014
Line 1:		Line 1:
	As of ~~classics 3 and later, you can now specify "sideplay-permitted"~~ and ~~"rotation-permitted" in the~~ [[~~"Bogeys" container~~]].		The bogeys container is a list of bogey subcontainers and is used by [[KIND Traincar]] assets. Each bogey subcontainer has a unique tag name and these tag names are matched with bogie attachments in the traincar mesh. These are a.bog0, a.bog1, etc.

	~~The default is '0' for sideplay, and '1' for rotation, which matches previous Trainz behaviour. Each is a boolean option (you can set either '0' or '1').~~

	~~With "sideplay-permitted 1",~~ the ~~bogie will follow the track, rather than stay rigidly locked in place at the location of the attachment point on the body~~.		==Supported Tags==
			Each bogey container supports the following tags. Each tag is shown here with its default value.

	~~With "~~rotation-permitted 0~~", the bogie will not rotate to align itself with the track. This is useful when the wheels being represented are fixed to the frame of the vehicle, and are not mounted on a rotating bogie.~~		bogey <KUID:0:0>
			reversed 0
			rotation-permitted 1
			sideplay-permitted 0

	~~For example~~, a Tri-Bo locomotive where the centre bogie slides from side to side can be represented like this:
			====bogey====
			:Type: Asset KUID
			:Desc: Specifies the bogie asset to use at the attachment point.

			====reversed====
			:Type: Boolean
			:Desc: Allows the bogie asset to be reversed at its attachment point. i.e. 180 degrees in the asset Z axis. 1 is reversed. 0 is not reversed and the default value.

			====rotation-permitted====
			:Type: Boolean
			:Desc: Allows the bogey to rotate itself in the Z axis to align with track direction. If 1 (default) then the bogey will rotate and if 0 then the bogey will not rotate. Using a zero value can be useful when the wheels being represented are fixed to the frame of the vehicle, and are not mounted on a rotating bogey.

			====sideplay-permitted====
			:Type: Boolean
			:Desc: Allows the bogie asset to move sideways to follow the track rather than remaining fixed at its attachment point. 0 (default) is no sideplay. 1 allows sideplay.


			==Examples==

			====Example 1====

			A Tri-Bo locomotive where the centre bogie slides from side to side can be represented like this:

	bogeys {		bogeys {
Line 25:		Line 50:
	}		}

	a.bog0 and a.bog1 are used for the two end bogies, and will locate the vehicle on the track ~~as happens now~~. But the bogie attached at a.bog2 in the middle will now follow the track through curves rather than stay firmly riveted on the underframe with it's wheels dangling in mid air.		a.bog0 and a.bog1 are used for the two end bogies, and will locate the vehicle on the track. But the bogie attached at a.bog2 in the middle will now follow the track through curves rather than stay firmly riveted on the underframe with it's wheels dangling in mid air.


			====Example 2====

	~~Another example~~ is a loco with central power bogies, and outer bogies to help traverse curves. The PRR GG1 (wheel pattern 2-co-co-2) is of this type. This can now be represented as follows:		This is a loco with central power bogies, and outer bogies to help traverse curves. The PRR GG1 (wheel pattern 2-co-co-2) is of this type. This can now be represented as follows:

	bogeys {		bogeys {
Line 52:		Line 79:

	a.bog0 and a.bog1 are used for the main power bogies to locate the vehicle correctly on the track. a.bog2 and a.bog3 are used for the leading and trailing unpowered bogies. These are permitted sideplay so they follow the track.		a.bog0 and a.bog1 are used for the main power bogies to locate the vehicle correctly on the track. a.bog2 and a.bog3 are used for the leading and trailing unpowered bogies. These are permitted sideplay so they follow the track.


			====Example 3====

	A two axle rigid frame vehicle can be represented as follows:		A two axle rigid frame vehicle can be represented as follows:
Line 68:		Line 98:
	}		}

	In this case, each "bogie" would be a single axle. The location of the attachment point will specify how the vehicle is aligned when on a curve, so should be placed at the location of the axle in the 'y' direction.		In this case, each bogie would be a single axle. The location of the attachment point will specify how the vehicle is aligned when on a curve, so should be placed at the location of the axle in the 'y' direction.


			====Example 4====

	An interesting case might be a three axle rigid frame vehicle - with sideplay (but no rotation!) on the centre axle. This might be represented as follows:		An interesting case might be a three axle rigid frame vehicle - with sideplay (but no rotation!) on the centre axle. This might be represented as follows:
Line 93:		Line 125:


			====Example 5====

	These tags are useful for steam locos too. Consider the pacific '4-6-2' wheel pattern. Looking from the front (a.limfront) end through to the back (a.limback), one way to arrange the bogie attachment points to get the required behaviour is:		These tags are useful for steam locos too. Consider the pacific '4-6-2' wheel pattern. Looking from the front (a.limfront) end through to the back (a.limback), one way to arrange the bogie attachment points to get the required behaviour is:
Line 105:		Line 138:

	This will produce the correct behaviour both from the locomotive body and the various bogies.		This will produce the correct behaviour both from the locomotive body and the various bogies.



	Using these parameters should mean that even very flexible locos (e.g. a Mallet or Garratt) can be built in a much more realistic manner, and with fewer separate pieces that need assembly in Surveyor.		Using these parameters should mean that even very flexible locos (e.g. a Mallet or Garratt) can be built in a much more realistic manner, and with fewer separate pieces that need assembly in Surveyor.
Line 112:		Line 143:


	===Random debugging hint===		==Random debugging hint==

	Q: "But I set this feature, and when I go round a corner, my bogie now floats off in some other direction that I wasn't expecting! What is wrong?"		Q: "But I set this feature, and when I go round a corner, my bogie now floats off in some other direction that I wasn't expecting! What is wrong?"

	A: Have you by any chance rotated the attachment point by 180 degrees in ~~MAX~~ to get the bogie to appear the other way round, but not set "reversed 1" in the config container for that bogie? These two things together can cause the effect you are seeing. You should also be able to spot this case because your wheels will be rotating the wrong way...		A: Have you by any chance rotated the attachment point by 180 degrees in your 3D editor to get the bogie to appear the other way round, but not set "reversed 1" in the config container for that bogie? These two things together can cause the effect you are seeing. You should also be able to spot this case because your wheels will be rotating the wrong way...


	[[Category:Config Container\|B]]		[[Category:Config Container\|B]]

Pcas1986: Add sort criterion

2014-01-24T05:42:15Z

Add sort criterion

← Older revision		Revision as of 05:42, 24 January 2014
Line 119:		Line 119:


	[[Category:Config Container]]		[[Category:Config Container\|B]]

Barn700 at 19:13, 6 December 2010

2010-12-06T19:13:02Z

← Older revision		Revision as of 19:13, 6 December 2010
Line 1:		Line 1:
	As of classics 3 and later, you can now specify "~~permits~~-~~sideplay~~" and "~~permits~~-~~rotation~~" in the [["Bogeys" container]].		As of classics 3 and later, you can now specify "sideplay-permitted" and "rotation-permitted" in the [["Bogeys" container]].

	The default is '0' for sideplay, and '1' for rotation, which matches previous Trainz behaviour. Each is a boolean option (you can set either '0' or '1').		The default is '0' for sideplay, and '1' for rotation, which matches previous Trainz behaviour. Each is a boolean option (you can set either '0' or '1').

	With "~~permits~~-~~sideplay~~ 1", the bogie will follow the track, rather than stay rigidly locked in place at the location of the attachment point on the body.		With "sideplay-permitted 1", the bogie will follow the track, rather than stay rigidly locked in place at the location of the attachment point on the body.

	With "~~permits~~-~~rotation~~ 0", the bogie will not rotate to align itself with the track. This is useful when the wheels being represented are fixed to the frame of the vehicle, and are not mounted on a rotating bogie.		With "rotation-permitted 0", the bogie will not rotate to align itself with the track. This is useful when the wheels being represented are fixed to the frame of the vehicle, and are not mounted on a rotating bogie.

	For example, a Tri-Bo locomotive where the centre bogie slides from side to side can be represented like this:		For example, a Tri-Bo locomotive where the centre bogie slides from side to side can be represented like this:

Windwalkr: 1 revision

2010-02-03T13:58:13Z

1 revision

← Older revision	Revision as of 13:58, 3 February 2010
(No difference)

Windwalkr at 05:06, 30 July 2008

2008-07-30T05:06:47Z

New page

As of classics 3 and later, you can now specify "permits-sideplay" and "permits-rotation" in the [["Bogeys" container]].

The default is '0' for sideplay, and '1' for rotation, which matches previous Trainz behaviour. Each is a boolean option (you can set either '0' or '1').

With "permits-sideplay 1", the bogie will follow the track, rather than stay rigidly locked in place at the location of the attachment point on the body.

With "permits-rotation 0", the bogie will not rotate to align itself with the track. This is useful when the wheels being represented are fixed to the frame of the vehicle, and are not mounted on a rotating bogie.

For example, a Tri-Bo locomotive where the centre bogie slides from side to side can be represented like this:

bogeys {
0 {
reversed 0
bogey <KUID2:xxxxx:yyyyy:zzz>
}
1 {
reversed 1
bogey <KUID2:xxxxx:yyyyy:zzz>
}
2 {
reversed 0
sideplay-permitted 1
bogey <KUID2:xxxxx:yyyyy:zzz>
}
}

a.bog0 and a.bog1 are used for the two end bogies, and will locate the vehicle on the track as happens now. But the bogie attached at a.bog2 in the middle will now follow the track through curves rather than stay firmly riveted on the underframe with it's wheels dangling in mid air.

Another example is a loco with central power bogies, and outer bogies to help traverse curves. The PRR GG1 (wheel pattern 2-co-co-2) is of this type. This can now be represented as follows:

bogeys {
0 {
reversed 0
bogey <KUID2:xxxxx:yyyyy:zzz>
}
1 {
reversed 1
bogey <KUID2:xxxxx:yyyyy:zzz>
}
2 {
reversed 0
sideplay-permitted 1
bogey <KUID2:xxxxx:yyyyy:zzz>
}
3 {
reversed 1
sideplay-permitted 1
bogey <KUID2:xxxxx:yyyyy:zzz>
}
}

a.bog0 and a.bog1 are used for the main power bogies to locate the vehicle correctly on the track. a.bog2 and a.bog3 are used for the leading and trailing unpowered bogies. These are permitted sideplay so they follow the track.

A two axle rigid frame vehicle can be represented as follows:

bogeys {
0 {
reversed 0
rotation-permitted 0
bogey <KUID2:xxxxx:yyyyy:zzz>
}
1 {
reversed 1
rotation-permitted 0
bogey <KUID2:xxxxx:yyyyy:zzz>
}
}

In this case, each "bogie" would be a single axle. The location of the attachment point will specify how the vehicle is aligned when on a curve, so should be placed at the location of the axle in the 'y' direction.

An interesting case might be a three axle rigid frame vehicle - with sideplay (but no rotation!) on the centre axle. This might be represented as follows:

bogeys {
0 {
reversed 0
rotation-permitted 0
bogey <KUID2:xxxxx:yyyyy:zzz>
}
1 {
reversed 0
rotation-permitted 0
bogey <KUID2:xxxxx:yyyyy:zzz>
}
2 {
reversed 0
rotation-permitted 0
sideplay-permitted 1
bogey <KUID2:xxxxx:yyyyy:zzz>
}
}

These tags are useful for steam locos too. Consider the pacific '4-6-2' wheel pattern. Looking from the front (a.limfront) end through to the back (a.limback), one way to arrange the bogie attachment points to get the required behaviour is:

a.bog2 - front bogie (the '4' in '4-6-2'). For best results, the attachment point should be the centre of the wheelbase. Use 'sideplay-permitted 1' on this bogie.

a.bog0 - drive bogie (the '6' in '4-6-2'). The attachment point should be circa where the front axle is. Move it back a bit if you have a lot of axles (e.g. 5 or more) in the drive bogie. Configure this one with 'sideplay-permitted 0' and 'rotation-permitted 0' - you don't want it moving around on curves at all! (With 'rotation-permitted 0' there is now no need to locate it at 0,0,0 to stop it rotating).

a.bog1 - an invisible bogie in line with the rear axle of the drive bogie. Move slightly forward if your drive bogie is large (e.g. 5 axles or more). This will make the locomotive body follow the track properly.

a.bog3 - trailing pony truck (the '2' in '4-6-2'). The attachment point should be in line with axle. Use 'sideplay-permitted 1' as with the front bogie.

This will produce the correct behaviour both from the locomotive body and the various bogies.

Using these parameters should mean that even very flexible locos (e.g. a Mallet or Garratt) can be built in a much more realistic manner, and with fewer separate pieces that need assembly in Surveyor.

===Random debugging hint===

Q: "But I set this feature, and when I go round a corner, my bogie now floats off in some other direction that I wasn't expecting! What is wrong?"

A: Have you by any chance rotated the attachment point by 180 degrees in MAX to get the bogie to appear the other way round, but not set "reversed 1" in the config container for that bogie? These two things together can cause the effect you are seeing. You should also be able to spot this case because your wheels will be rotating the wrong way...

[[Category:Config Container]]