3DModels:obj meta - Revision history

Flozi: /* Data Types */ template

2014-10-02T17:03:32Z

Data Types: template

← Older revision		Revision as of 18:03, 2 October 2014
Line 21:		Line 21:
	check [http://www.lua.org/docs.html Lua Documentation].		check [http://www.lua.org/docs.html Lua Documentation].

	= Data Types =		=Data Types=
			{{DataTypes}}
	~~; <span style="color:#00ff88">int</span> : An integer number. eg. 5~~
	~~; <span style="color:#00ff88">float</span> : A number with decimals. eg 1.023~~
	~~; <span style="color:#00ff88">bool</span> : A value which can be true or false. eg true~~
	~~; <span style="color:#00ff88">string</span> : Text, or more precisely a string of alphanumeric characters. eg "string of characters"~~
	~~; <span style="color:#00ff88">rgb</span> : Three float components, representing red, green and blue components, ranged from 0.0 to 1.0. eg~~ {~~0.0, 0.0, 0.0}~~
	~~; <span style="color:#00ff88">float3</span> : Three float components, eg~~ {~~0.0, 0.0, 0.0~~}
	~~; <span style="color:#00ff88">float4</span> : Four float components, eg {0.0, 0.0, 0.0, 0.0~~}

	= Notes =		= Notes =

Flozi: new category, 3D Models

2013-03-20T13:43:00Z

new category, 3D Models

← Older revision		Revision as of 14:43, 20 March 2013
Line 97:		Line 97:
	{{tag\|name=offset\|type=float3\|special=Required		{{tag\|name=offset\|type=float3\|special=Required
	\|description=the offset of the piece vertices either in parent or world space}}		\|description=the offset of the piece vertices either in parent or world space}}
			[[Category:3D Models]]

Flozi: Flozi moved page Enetheru:mesh obj meta to 3DModels:obj meta without leaving a redirect: Author request

2013-03-20T13:41:29Z

Flozi moved page Enetheru:mesh obj meta to 3DModels:obj meta without leaving a redirect: Author request

← Older revision	Revision as of 14:41, 20 March 2013
(No difference)

Flozi: /* Source */ reformat

2013-03-01T23:05:35Z

Source: reformat

← Older revision		Revision as of 00:05, 2 March 2013
Line 14:		Line 14:
	If you notice something is incorrect, fix it please!		If you notice something is incorrect, fix it please!
	==Source==		==Source==
	The engine source code which reads this file is viewable here:{{sourcelink\|file=rts/Rendering/Models/OBJParser.cpp}}		The engine source code which reads this file is viewable here:

			* {{sourcelink\|file=rts/Rendering/Models/OBJParser.cpp}}

	= General Formatting =		= General Formatting =

Enetheru: re-structured the pieces section to be more compatible with the assimp meta format.

2012-09-05T05:13:31Z

re-structured the pieces section to be more compatible with the assimp meta format.

← Older revision		Revision as of 06:13, 5 September 2012
Line 29:		Line 29:
	; <span style="color:#00ff88">float4</span> : Four float components, eg {0.0, 0.0, 0.0, 0.0}		; <span style="color:#00ff88">float4</span> : Four float components, eg {0.0, 0.0, 0.0, 0.0}

			= Notes =
			* each model-table must define EXACTLY one root-piece in its "pieces" sub-table
			* the script MUST return exactly one model-table (which may be named arbitrarily)
			* the tree must reference ONLY object names defined in the .obj file
			* a piece-table key may NOT be "name" or "offset" (these are reserved keywords)
	= Sections =		= Sections =
	== meshname.lua ==		== meshname.lua ==
Line 72:		Line 77:
	<code><pre>meshname = {		<code><pre>meshname = {
	pieces = {		pieces = {
	~~[1]~~ = {		piecename = {
	~~name = "",~~
	offset = {0.0, 0.0, 0.0},		offset = {0.0, 0.0, 0.0},
	~~[2]~~ = {		anotherpiecename = {
	~~name = "",~~
	offset = {0.0, 0.0, 0.0},		offset = {0.0, 0.0, 0.0},
	...		...

Enetheru: slight change to main description.

2012-09-05T04:39:24Z

slight change to main description.

← Older revision		Revision as of 05:39, 5 September 2012
Line 1:		Line 1:
	= .obj Mesh Meta Reference =		= .obj Mesh Meta Reference =
	so because wavefront .obj files dont contain all the required information for 3d models in spring this extra file was needed to fill in the missing pieces.		so because wavefront .obj files dont contain all the required information for 3d models in spring this extra file was needed to fill in the missing pieces.

			the file accompanies your mesh such that:

			<code>objects3d/myobjmesh.obj</code>

			<code>objects3d/myobjmesh.lua</code> (this is the meta info file)

	variables are organised as such:		variables are organised as such:
Line 8:		Line 14:
	If you notice something is incorrect, fix it please!		If you notice something is incorrect, fix it please!
	==Source==		==Source==
	The engine source code which reads this file is viewable here:		The engine source code which reads this file is viewable here:{{sourcelink\|file=rts/Rendering/Models/OBJParser.cpp}}
	{{sourcelink\|file=rts/Rendering/Models/OBJParser.cpp}}

	= General Formatting =		= General Formatting =

Enetheru: /* Extra Mesh Info Reference */ renamed title.

2012-09-05T04:31:18Z

Extra Mesh Info Reference: renamed title.

← Older revision		Revision as of 05:31, 5 September 2012
Line 1:		Line 1:
	= ~~Extra~~ Mesh ~~Info~~ Reference =		= .obj Mesh Meta Reference =
	so because wavefront .obj files dont contain all the required information for 3d models in spring this extra file was needed to fill in the missing pieces.		so because wavefront .obj files dont contain all the required information for 3d models in spring this extra file was needed to fill in the missing pieces.

Enetheru: /* Source */ added link to source code.

2012-09-05T04:30:34Z

Source: added link to source code.

← Older revision		Revision as of 05:30, 5 September 2012
Line 8:		Line 8:
	If you notice something is incorrect, fix it please!		If you notice something is incorrect, fix it please!
	==Source==		==Source==
	The engine source code which reads this file ~~from the map~~ is viewable here:		The engine source code which reads this file is viewable here:
	~~???~~		{{sourcelink\|file=rts/Rendering/Models/OBJParser.cpp}}

	= General Formatting =		= General Formatting =

Enetheru: Enetheru moved page Enetheru:mesh extra to Enetheru:mesh obj meta: because the meta data is specific to obj loader.

2012-09-05T04:28:43Z

Enetheru moved page Enetheru:mesh extra to Enetheru:mesh obj meta: because the meta data is specific to obj loader.

← Older revision	Revision as of 05:28, 5 September 2012
(No difference)

Enetheru: created basic definition.

2012-09-04T03:47:12Z

created basic definition.

New page

= Extra Mesh Info Reference =
so because wavefront .obj files dont contain all the required information for 3d models in spring this extra file was needed to fill in the missing pieces.

variables are organised as such:
{{tag|name=VariableName|type=type|range=[valid range]|special=Required|default=value
|description=Description}}

If you notice something is incorrect, fix it please!
==Source==
The engine source code which reads this file from the map is viewable here:
???

= General Formatting =
check [http://www.lua.org/docs.html Lua Documentation].

= Data Types =

; int : An integer number. eg. 5
; float : A number with decimals. eg 1.023
; bool : A value which can be true or false. eg true
; string : Text, or more precisely a string of alphanumeric characters. eg "string of characters"
; rgb : Three float components, representing red, green and blue components, ranged from 0.0 to 1.0. eg {0.0, 0.0, 0.0}
; float3 : Three float components, eg {0.0, 0.0, 0.0}
; float4 : Four float components, eg {0.0, 0.0, 0.0, 0.0}

= Sections =
== meshname.lua ==
<code><pre>meshname = {
pieces = {
...
},

radius = 0,
midpos = 0,
tex1 = "",
--tex2 = "",
numpieces = 1,

globalvertexoffset = true,
localpieceoffset = true,
}
return meshname</pre></code>

===== meshname =====
name of your mesh...

{{tag|name=midpos|type=float3|special=Required
|description=the local of the median point of the mesh from the origin}}

{{tag|name=radius|type=float|special=Required
|description=from the midpos the radius of the mesh, used for occlusion culling}}

{{tag|name=tex1|type=string
|description=filename of the texture image to use for diffuse and teamcolor}}

{{tag|name=tex2|type=string
|description=filename of the texture image to use for ambient, specular and transparency}}

{{tag|name=globalvertexoffsets|type=bool
|description=whether the vertex coordinates are relative to the global origin, or the local origin}}

{{tag|name=localpieceoffsets|type=bool
|description=whether the piece offsets are relative to the global origin, or the parent offset}}

== pieces ==
Specifies the hierarchy of objects
<code><pre>meshname = {
pieces = {
[1] = {
name = "",
offset = {0.0, 0.0, 0.0},
[2] = {
name = "",
offset = {0.0, 0.0, 0.0},
...
},
...
},
},
...
}
return meshname</pre></code>

{{tag|name=name|type=string|special=Required
|description=each piece name needs to correspond to an object in the mesh file. For an .obj file it would be the "o" tag}}

{{tag|name=offset|type=float3|special=Required
|description=the offset of the piece vertices either in parent or world space}}