3D Model

Parent element name: hill
Element name: 3dmodel or model

WARNING

You can name element 3dmodel in DSJ4 versions from 1.7.0, model only from 1.8.0.

TIP

Attributes related to skeletal modeling are usually not needed.

TIP

refx, refy and refz attributes values should be set to near the center of the object.

TIP

refbone applies for skeletal modeling.

Attribute	Type	Default value	Description
id	String		3D Model Identification
refx	Float	0.0	Default reference of X coordinate for lighting
refy	Float	0.0	Default reference of Y coordinate for lighting
refz	Float	0.0	Default reference of Z coordinate for lighting
refbone	String		Identification of the default reference bone for lighting

Batch

Parent element name: 3dmodel
Element name: batch

TIP

Flexible Vertex Format (FVF) defines which data each vertex will contain when the batch is sent to a rendering pipeline. For further reference go here.

In most cases, it's enough to set fvf attribute value equal to 322.
322 = D3DFVF_XYZ + D3DFVF_DIFFUSE + D3DFVF_TEX1 + D3DFVF_TEXCOORDSIZE2(0)

For statically lit objects you don't define D3DFVF_NORMAL as the vertices will be pre-lit.

WARNING

Currently, the 3dmodel does not support multitexturing.

TIP

The lower the attribute order value is, the faster batch will render.

TIP

If you have two surfaces that are overlapping each other, specify the zbias attribute, so this surface will appear "above" the second surface.

TIP

alphatest attribute works in the following way:

if the value is set to 0, rendering batch is disabled
if the value is in the range from 1 to 255, rendering batch is enabled when alpha >= alphatest
if the value is in the range from 256 to 511, rendering batch is enabled when alpha < alphatest - 256

TIP

Blending mode works in the following way:

when the value is set to 0, blend mode is normal
when the value is set to 1, blend mode is set to addition
when the value is set to 2, blend mode is set to substraction

TIP

Set staticlighting attribute value to true for static non-moving objects for the best performance.

TIP

b1, b2, b3, b4 and refbone attributes apply for skeletal modeling.

Attribute	Type	Default value	Description
id	String		Batch Identification
fvf	+Integer	0	Flexible Vertex Format
texture1	Texture		Batch texture
material	Material		Batch material
order	+Integer	0	Rendering order
zbias	Float	0	Z-index
alphatest	+Integer	0	Toggles rendering based on alpha
blending	Boolean	False	Toggles alpha blending
culling	Boolean	True	Toggles face culling (CCW), should be enabled whenever possible for the best performance
blendmode	Integer	0	Blending mode
zwrite	Boolean	True	Toggles writing Z-values to Z-buffer
staticligthing	Boolean	False	Toggles precalculate lighting
mipmaplodbias	Float	0.0	Select sharper/softer mipmap level
refx	Float	0.0	Reference of X-point for lighting
refy	Float	0.0	Reference of Y-point for lighting
refz	Float	0.0	Reference of Z-point for lighting
b1	String		Identification of the first bone
b2	String		Identification of the second bone
b3	String		Identification of the third bone
b4	String		Identification of the fourth bone
refbone	String		Reference of bone
type	String	normal, blend, glass	Texture type

Vertex

Parent element name: batch
Element name: vertex

TIP

Leave nx, ny and nz values to 0 to calculate normals automatically.

TIP

b1, b2, b3, b4 attributes apply for skeletal modeling.

Attribute	Type	Default value	Description
x	Float	0.0	Position relative to the X-axis
y	Float	0.0	Position relative to the Y-axis
z	Float	0.0	Position relative to the Z-axis
diffuse	Color		Diffuse color for texture
u1	Float		Texture u coordinate
v1	Float		Texture v coordinate
nx	Float	0.0	Normal vector relative to the X-axis
ny	Float	0.0	Normal vector relative to the Y-axis
nz	Float	0.0	Normal vector relative to the Z-axis
psize	Float	0.0	Point size when rendering points
b1	String		Identification of the first bone
b2	String		Identification of the second bone
b3	String		Identification of the third bone
b4	String		Identification of the fourth bone
w1	Float	0.0	Weight of the first bone
w2	Float	0.0	Weight of the second bone
w3	Float	0.0	Weight of the third bone
rhw	Float	0.0	Reciprocal of homegenous w

Face

Parent element name: batch
Element name: face

Attribute	Type	Description
v1	String	Identification of the first vertex
v2	String	Identification of the second vertex
v3	String	Identification of the third vertex

Seam

Parent element name: 3dmodel
Element name: seam

TIP

Add seams between vertices in different batches to smoothen the surface when using automatic vertex normals calculation.

Attribute	Type	Description
b1	String	Identification of the source batch
v1	String	Identification of the source vertex
b2	String	Identification of the target batch
v2	String	Identification of the target vertex

Transformation

Parent element name: hill
Element name: transformation

WARNING

Matrix and rotate, scale, translate elements exlcude each other. You can have either transformation element with matrix only, or with rotate, scale and tranaslate elements.

Attribute	Type	Description
id	String	Identification of transformation

Matrix

TIP

Refer to this article for explanation on matrix representation.

Attribute	Type
m11	Float
m22	Float
m21	Float
m33	Float
m44	Float

Rotate

Attribute	Type	Allowed values	Description
axis	String	x, y, z	Reference to built-in game axis
angle	+Integer		Rotation angle of target model

Scale

Attribute	Type	Description
x	+Integer	Scale of target model relative to the X-axis
y	+Integer	Scale of target model relative to the Y-axis
z	+Integer	Scale of target model relative to the Z-axis

Translate

Attribute	Type	Description
x	+Integer	Translation of target model relative to the X-axis
y	+Integer	Translation of target model relative to the Y-axis
z	+Integer	Translation of target model relative to the Z-axis

3D Model Instance

Parent element name: hill
Element name: 3dmodel-instance or model-instance

WARNING

You can name element 3dmodel in DSJ4 versions from 1.7.0, model only from 1.8.0.

Attribute	Type	Description
id	String	Identification of the 3d model to instantiate
x	Float	Position relative to the X-axis
y	Float	Position relative to the Y-axis
z	Float	Position relative to the Z-axis
refx	String	A reference to the X-axis, which 3dmodel is based on
refy	String	A reference to the Y-axis, which 3dmodel is based on
refz	String	A reference to the Z-axis, which 3dmodel is based on
transformation	String	A reference to transformation element

Code snippets

<hill version="DSJ4-1.10.0">
    <!-- Rest of code omitted for clearance -->
   <model id="vdf134-roof">
      <batch id="roof" texture1="Textures\concrete5.png" material="Materials\material1.xml" fvf="322" order="0">
         <vertex id="1" x="-3" y="0" z="-3" u1="-3" v1="-3" diffuse="0xff747681"/>
         <vertex id="2" x="-3" y="0" z="3" u1="-3" v1="3" diffuse="0xff747681"/>
         <vertex id="3" x="0" y="2.5" z="0" u1="0" v1="0" diffuse="0xff747681"/>
         
         <vertex id="4" x="3" y="0" z="3" u1="3" v1="3" diffuse="0xff747681"/>
         <vertex id="5" x="3" y="0" z="-3" u1="3" v1="-3" diffuse="0xff747681"/>
         <vertex id="6" x="0" y="2.5" z="0" u1="0" v1="0" diffuse="0xff747681"/>

         <vertex id="7" x="-3" y="0" z="3" u1="-3" v1="3" diffuse="0xff747681"/>
         <vertex id="8" x="3" y="0" z="3" u1="3" v1="3" diffuse="0xff747681"/>
         <vertex id="9" x="0" y="2.5" z="0" u1="0" v1="0" diffuse="0xff747681"/>

         <vertex id="10" x="3" y="0" z="-3" u1="3" v1="-3" diffuse="0xff747681"/>
         <vertex id="11" x="-3" y="0" z="-3" u1="-3" v1="-3" diffuse="0xff747681"/>
         <vertex id="12" x="0" y="2.5" z="0" u1="0" v1="0" diffuse="0xff747681"/>
         
         <face v1="1" v2="2" v3="3"/>
         <face v1="4" v2="5" v3="6"/>
         <face v1="7" v2="8" v3="9"/>
         <face v1="10" v2="11" v3="12"/>
      </batch>
   </model>
   <model-instance id="vdf134-roof" refx="inrun0" refy="inrun-top" x="3.525" y="2.85" z="1.175"/>
</hill>

By Jussi Koskela

Distance markers

# 3D Model

# Batch

# Vertex

# Face

# Seam

# Transformation

# Matrix

# Rotate

# Scale

# Translate

# 3D Model Instance

# Code snippets

3D Model

Batch

Vertex

Face

Seam

Transformation

Matrix

Rotate

Scale

Translate

3D Model Instance

Code snippets