Render

Module that handles 3D rendering. More...

Functions
int	Render::createVertex (number x, number y, number z, number u, number v, number n1, number n2, number n3)
	Create a vertex. More...
void	Render::destroyVertex (int v)
	Destroy a vertex. More...
int	Render::loadModel (table v, int texture)
	Load a set of vertices as 3D model. More...
int	Render::loadObject (string filename, int texture)
	Load an .obj model. More...
void	Render::unloadModel (int model)
	Free a model. More...
void	Render::drawModel (int model, number x, number y, number z, number angleX, number angleY, number angleZ, bool unbind)
	Print a model on screen. More...
void	Render::useTexture (int model, int texture)
	Set a given texture for a model. More...
void	Render::setCamera (number x, number y, number z, number rot_x, number rot_y, number rot_z)
	Set view camera instance settings. More...

Detailed Description

Module that handles 3D rendering.

Function Documentation

createVertex()

int Render::createVertex	(	number	x,
		number	y,
		number	z,
		number	u,
		number	v,
		number	n1,
		number	n2,
		number	n3
	)

Create a vertex.

Usage example:

v = Render.createVertex(1.0, 1.0, 0.0, 0.0, 0.5, 1.0, 1.0, 1.0)

Parameters

x	- X coordinate of the vertex.
y	- Y coordinate of the vertex.
z	- Z coordinate of the vertex.
u	- U coordinate for texture mapping.
v	- v coordinate for texture mapping.
n1	- Normal X coordinate of the vertex.
n2	- Normal Y coordinate of the vertex.
n3	- Normal Z coordinate of the vertex.

Returns

The created vertex ID.

destroyVertex()

void Render::destroyVertex

(

int

v

)

Destroy a vertex.

Usage example:

Render.destroyVertex(v)

Parameters

v	- Vertex ID created with Render.createVertex to destroy.

loadModel()

int Render::loadModel	(	table	v,
		int	texture
	)

Load a set of vertices as 3D model.

Usage example:

texture = Graphics.loadImage("app0:/texture.png")
mdl = Render.loadModel(vertices_table, texture)

Parameters

v	- A table with the model vertices.
texture	- A valid image ID.

Returns

A valid model ID.

loadObject()

int Render::loadObject	(	string	filename,
		int	texture
	)

Load an .obj model.

Usage example:

texture = Graphics.loadImage("app0:/texture.png")
mdl = Render.loadObject("app0:/model.obj", texture)

Parameters

filename	- Name of the file to load.
texture	- Texture ID to use.

Returns

A valid model ID.

unloadModel()

void Render::unloadModel

(

int

model

)

Free a model.

Usage example:

Render.unloadModel(mdl)

Parameters

model

- A valid model ID.

Note

The texture is not unloaded automatically.

drawModel()

void Render::drawModel	(	int	model,
		number	x,
		number	y,
		number	z,
		number	angleX,
		number	angleY,
		number	angleZ,
		bool	unbind
	)

Print a model on screen.

Usage example:

Render.drawModel(mdl, 1.0, 1.0, -5.0, 1.0, 1.0, 0.0)

Parameters

model	- A valid model ID.
x	- X coordinate of the model.
y	- Y coordinate of the model.
z	- Z coordinate of the model.
angleX	- X rotation value of the model.
angleY	- Y rotation value of the model.
angleZ	- Z rotation value of the model.
unbind	- Draw the model unbinded from camera instance (optional).

Note

If not specified, unbind param will be set as false.

useTexture()

void Render::useTexture	(	int	model,
		int	texture
	)

Set a given texture for a model.

Usage example:

texture = Graphics.loadImage("app0:/texture.png")
Render.useTexture(mdl, texture)

Parameters

model	- A valid model ID.
texture	- Texture ID to use.

Note

The old texture is not unloaded automatically.

setCamera()

void Render::setCamera	(	number	x,
		number	y,
		number	z,
		number	rot_x,
		number	rot_y,
		number	rot_z
	)

Set view camera instance settings.

Usage example:

Render.setCamera(0.0, 1.0, 1.0, 0.0, 0.0, 0.0)

Parameters

x	- X coordinate of the camera.
y	- Y coordinate of the camera.
z	- Z coordinate of the camera.
rot_x	- X related rotation value of the camera.
rot_y	- Y related rotation value of the camera.
rot_z	- Z related rotation value of the camera.