Libs3D Library ShapesV2: Difference between revisions

From GiderosMobile
No edit summary
No edit summary
 
Line 154: Line 154:


== Extra ==
== Extra ==
The ''3DShapes.lua'' file comes with many modes:
The ''3DShapes.lua'' file comes with many modes: ''Mesh3D.MODE_TEXTURE=1'', ''Mesh3D.MODE_LIGHTING=2'', ''Mesh3D.MODE_BUMP=4'', ''Mesh3D.MODE_SHADOW=8'', ''Mesh3D.MODE_ANIMATED=16'', ''Mesh3D.MODE_INSTANCED=32'', ''Mesh3D.MODE_COLORED=64'', ''Mesh3D.MODE_VOXEL=128'', ''Mesh3D.MODE_OCCLUSION=256'', ''Mesh3D.MODE_DEPTHMASK=512'', ''Mesh3D.MODE_BRICKS=1024'', ''Mesh3D.MODE_FOG=2048''
 
So far we have used:
*Mesh3D.MODE_TEXTURE=1
*Mesh3D.MODE_TEXTURE=1
*Mesh3D.MODE_LIGHTING=2 --ie normals
*Mesh3D.MODE_LIGHTING=2 --ie normals
*Mesh3D.MODE_BUMP=4
*Mesh3D.MODE_BUMP=4
*Mesh3D.MODE_SHADOW=8
*Mesh3D.MODE_SHADOW=8
*Mesh3D.MODE_ANIMATED=16
*Mesh3D.MODE_INSTANCED=32
*Mesh3D.MODE_COLORED=64
*Mesh3D.MODE_COLORED=64
*Mesh3D.MODE_VOXEL=128
*Mesh3D.MODE_OCCLUSION=256
*Mesh3D.MODE_DEPTHMASK=512
*Mesh3D.MODE_BRICKS=1024
*'''Mesh3D.MODE_FOG=2048'''


Let's see the fog mode. First, we tell which shapes will be in the fog.
Let's see fog mode: '''Mesh3D.MODE_FOG=2048'''. First, we tell which shapes will be in the fog.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- fog
-- fog

Latest revision as of 17:01, 3 August 2026


This is Shapes Library V2 💪
  • dimensions where 1 unit is indeed 1 unit
  • added normal mapping
  • added a pyramid shape

Media:3DShapesV2.lua (tip: right click and save link as). Add it to the 3dbase folder and exclude from execution, 3DShapes.lua

I am ready

As we have seen, to make more advanced 3D, Gideros has a bunch of helper files packed in the Library folder.

Here is the plan:

  • start with a camera
    • a world to populate (scene)
  • some common 3D shapes (plane, cube, ...)
  • light and shadows
  • extra (fog mode)
  • the code

Copy the following two Library folders in your project assets folder:

  • 3dbase
  • luashader

The Camera

The camera is a Viewport with a perspective projection Matrix (helper file 3DView.lua). Let's add one:

application:setBackgroundColor(0x454545)

-- we set up a fullscreen 3D viewport (fov: consoles 60, pc 90)
local sw, sh = application:getContentWidth(), application:getContentHeight()
local view = D3.View.new(sw,sh, 90, 0.1,1*1024) -- (screen w,screen h, fov, near plane,far plane)

You can position the view (camera) and set its target using the Viewport:lookAt function.

-- we position the view (camera) and set its target
view:lookAt(0.4*8,0.3*8,0.3*8, 0*8,0*8,-0.1*8) -- (eyex,eyey,eyez, targetx,targety,targetz[, upx,upy,upz])

In order to display the content of the Viewport (camera) to the screen, we add it to Gideros stage.

-- we add the view (camera) to Gideros stage
stage:addChild(view)

The World (scene)

We will add all our 3D models to a scene. The scene is a simple Sprite and is part of the camera.

-- we will add 3D shapes and models to a scene
local scene = view:getScene()
scene:setAutoSort(true) -- enables depth sorting for the children of a Sprite (from farthest to nearest)

Our first shape: a Plane

We are going to use the Plane shape (helper file 3DShapesV2.lua), this will be our ground.

-- our first shape, a plane for the ground
local ground = D3.PlaneV2.new(1.2*8, 1.2*8) -- (width,depth)
-- a color
ground:mapColor(0x55ffff) -- (color,[alpha=1])

Let's texture our plane, I picked this one: https://polyhaven.com/a/forrest_ground_01, Diffuse + Normal (GL), 1K, JPG

-- texture (diffuse) and normal map
local tex = Texture.new("textures/forrest_ground_01_diff_1k.jpg", nil, { wrap=Texture.REPEAT, } )
local normal = Texture.new("textures/forrest_ground_01_nor_gl_1k.jpg", nil, { wrap=Texture.REPEAT, } )
local texsx, texsy = 0.09*8, 0.09*8 -- texture scaling
ground:mapTexture(tex, texsx, texsy, normal)

We tell the shape to receive light and shadows.

-- we tell the shape to receive light and shadows
ground:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)

And we add the ground to the world (scene).

-- we add the shape to the scene (world)
scene:addChild(ground)

More shapes

The Mesh3D class (3DShapes.lua) has other shapes you can use: D3.CubeV2, D3.SphereV2, D3.CylinderV2, D3.PyramidV2.

-- more shapes
local cube = D3.CubeV2.new(0.1*8, 0.2*8, 0.1*8) -- (w,h,d)
cube:mapColor(0xffff00) -- (color,[alpha=1])
texsx, texsy = 0.007*8, 0.007*8 -- texture scaling
cube:mapTexture(tex, texsx, texsy, normal)
cube:setPosition(-0.1*8, cube.dims.h/2, 0.0*8)
cube:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(cube)

local sphere = D3.SphereV2.new(2*8, 0.2*8) -- (steps,diameter)
sphere:mapColor(0x55ff00) -- (color,[alpha=1])
texsx, texsy = 0.01*8, 0.01*8 -- texture scaling
sphere:mapTexture(tex, texsx, texsy, normal)
sphere:setPosition(-0.3*8, sphere.dims.r, 0.0*8)
sphere:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(sphere)

local cylinder = D3.CylinderV2.new(2*8, 0.2*8, 0.2*8) -- (steps,diameter,height)
cylinder:mapColor(0xffaa00) -- (color,[alpha=1])
texsx, texsy = 0.025*8, 0.025*8 -- texture scaling
cylinder:mapTexture(tex, texsx, texsy, normal)
cylinder:setPosition(0.1*8, cylinder.dims.h/2, 0.0*8)
cylinder:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(cylinder)

local pyramid = D3.PyramidV2.new(0.15*8, 0.2*8) -- (diameter,height)
pyramid:mapColor(0xff5500) -- (color,[alpha=1])
texsx, texsy = 0.01*8, 0.01*8 -- texture scaling
pyramid:mapTexture(tex, texsx, texsy, normal)
pyramid:setPosition(0.3*8, pyramid.dims.h/2, 0.0*8)
pyramid:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(pyramid)

Lighting

The final touch is lighting (3DLighting.lua).

About lighting:

  • Lighting.setLight(x,y,z,a) sets the position of the light source (spotlight) and the amount of ambient light
  • Lighting.setLightTarget(x,y,z,d,f) sets the target of the light source. x,y,z is the position where the light is pointing at, d determines the projection distance when computing shadows (d gives the far plane, and the near plane is computed as d/16 internally). f is the FoV angle (actually the half angle), it determines the opening of your spotlight cone, and has a consequence on the shadow precision
  • Only objects between d and d/16 in the light cone will cast shadows
  • Select d wisely as it has an impact on shadow precision
  • the lib uses a 1024x1024 shadow map

The light source position and ambient light.

-- light setup
local lsx, lsy, lsz = 0.5*8, 0.55*8, 0.2*8 -- light source position
Lighting.setLight(lsx,lsy,lsz, 0.3) -- (x,y,z, ambient)

The light target has a position and a projection distance plus a field of view (fov) angle.

local ltx, lty, ltz = 0.0*8, 0.0*8, 0.0*8 -- light target position
local pd, fov = 4*8, 7*8
Lighting.setLightTarget(ltx,lty,ltz, pd,fov) -- (x,y,z, projection distance,fov)

When we added the shapes to the world, we gave the shapes the ability to receive light and shadows: D3.Mesh.MODE_LIGHTING, D3.Mesh.MODE_SHADOW. We need to compute the shadow map.

Lighting.computeShadows(scene)

Extra

The 3DShapes.lua file comes with many modes: Mesh3D.MODE_TEXTURE=1, Mesh3D.MODE_LIGHTING=2, Mesh3D.MODE_BUMP=4, Mesh3D.MODE_SHADOW=8, Mesh3D.MODE_ANIMATED=16, Mesh3D.MODE_INSTANCED=32, Mesh3D.MODE_COLORED=64, Mesh3D.MODE_VOXEL=128, Mesh3D.MODE_OCCLUSION=256, Mesh3D.MODE_DEPTHMASK=512, Mesh3D.MODE_BRICKS=1024, Mesh3D.MODE_FOG=2048

So far we have used:

  • Mesh3D.MODE_TEXTURE=1
  • Mesh3D.MODE_LIGHTING=2 --ie normals
  • Mesh3D.MODE_BUMP=4
  • Mesh3D.MODE_SHADOW=8
  • Mesh3D.MODE_COLORED=64

Let's see fog mode: Mesh3D.MODE_FOG=2048. First, we tell which shapes will be in the fog.

-- fog
ground:updateMode( D3.Mesh.MODE_FOG )
cube:updateMode( D3.Mesh.MODE_FOG )
sphere:updateMode( D3.Mesh.MODE_FOG )
cylinder:updateMode( D3.Mesh.MODE_FOG )
pyramid:updateMode( D3.Mesh.MODE_FOG )

Then we set the fog parameters (3DLighting.lua):

  • fogDistance: with a minimum distance and a distance range
  • fogColor: r,g,b,a with values between 0 and 1 (values can be greater than 1 too 😉)
Lighting.setFog(0.25*8,1*8, 0.1,0.1,0.1,2) -- (dmin,drange, r,g,b,a)

And voilà!

The code

application:setBackgroundColor(0x454545)

-- we set up a fullscreen 3D viewport (fov: consoles 60, pc 90)
local sw, sh = application:getContentWidth(), application:getContentHeight()
local view = D3.View.new(sw,sh, 90, 0.1,1*1024) -- (screen w,screen h, fov, near plane,far plane)

-- we position the view (camera) and set its target
view:lookAt(0.4*8,0.3*8,0.3*8, 0*8,0*8,-0.1*8) -- (eyex,eyey,eyez, targetx,targety,targetz[, upx,upy,upz])

-- we add the view (camera) to Gideros stage
stage:addChild(view)

-- we will add 3D shapes and models to a scene
local scene = view:getScene()
scene:setAutoSort(true) -- enables depth sorting for the children of a Sprite (from farthest to nearest)

-- a shape
local ground = D3.PlaneV2.new(1.2*8, 1.2*8) -- (width,depth)
ground:mapColor(0x55ffff) -- (color,[alpha=1])
local tex = Texture.new("textures/forrest_ground_01_diff_1k.jpg", nil, { wrap=Texture.REPEAT, } )
local normal = Texture.new("textures/forrest_ground_01_nor_gl_1k.jpg", nil, { wrap=Texture.REPEAT, } )
local texsx, texsy = 0.09*8, 0.09*8 -- texture scaling
ground:mapTexture(tex, texsx, texsy, normal)
-- we tell the shape to receive light and shadows
ground:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
-- we add the shape to the scene
scene:addChild(ground)

-- more shapes
local cube = D3.CubeV2.new(0.1*8, 0.2*8, 0.1*8) -- (w,h,d)
cube:mapColor(0xffff00) -- (color,[alpha=1])
texsx, texsy = 0.007*8, 0.007*8 -- texture scaling
cube:mapTexture(tex, texsx, texsy, normal)
cube:setPosition(-0.1*8, cube.dims.h/2, 0.0*8)
cube:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(cube)

local sphere = D3.SphereV2.new(2*8, 0.2*8) -- (steps,diameter)
sphere:mapColor(0x55ff00) -- (color,[alpha=1])
texsx, texsy = 0.01*8, 0.01*8 -- texture scaling
sphere:mapTexture(tex, texsx, texsy, normal)
sphere:setPosition(-0.3*8, sphere.dims.r, 0.0*8)
sphere:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(sphere)

local cylinder = D3.CylinderV2.new(2*8, 0.2*8, 0.2*8) -- (steps,diameter,height)
cylinder:mapColor(0xffaa00) -- (color,[alpha=1])
texsx, texsy = 0.025*8, 0.025*8 -- texture scaling
cylinder:mapTexture(tex, texsx, texsy, normal)
cylinder:setPosition(0.1*8, cylinder.dims.h/2, 0.0*8)
cylinder:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(cylinder)

local pyramid = D3.PyramidV2.new(0.15*8, 0.2*8) -- (diameter,height)
pyramid:mapColor(0xff5500) -- (color,[alpha=1])
texsx, texsy = 0.01*8, 0.01*8 -- texture scaling
pyramid:mapTexture(tex, texsx, texsy, normal)
pyramid:setPosition(0.3*8, pyramid.dims.h/2, 0.0*8)
pyramid:updateMode(D3.Mesh.MODE_LIGHTING + D3.Mesh.MODE_SHADOW)
scene:addChild(pyramid)

-- light setup
local lsx, lsy, lsz = 0.5*8, 0.55*8, 0.2*8 -- light source position
Lighting.setLight(lsx,lsy,lsz, 0.3) -- (x,y,z, ambient)
local ltx, lty, ltz = 0.0*8, 0.0*8, 0.0*8 -- light target position
local pd, fov = 4*8, 7*8
Lighting.setLightTarget(ltx,lty,ltz, pd,fov) -- (x,y,z, projection distance,fov)
Lighting.computeShadows(scene)

-- fog
ground:updateMode( D3.Mesh.MODE_FOG )
cube:updateMode( D3.Mesh.MODE_FOG )
sphere:updateMode( D3.Mesh.MODE_FOG )
cylinder:updateMode( D3.Mesh.MODE_FOG )
pyramid:updateMode( D3.Mesh.MODE_FOG )
Lighting.setFog(0.05*8, 1*8, 0.1,0.1,0.1,3) -- (dmin,drange,r,g,b,a)

-- game loop
stage:addEventListener(Event.ENTER_FRAME, function(e)
	cube:setRotationX(cube:getRotationX()+8*8*e.deltaTime)
	sphere:setRotationY(sphere:getRotationY()+9*8*e.deltaTime)
	cylinder:setRotationY(cylinder:getRotationY()+10*8*e.deltaTime)
	pyramid:setRotationX(pyramid:getRotationX()+3*8*e.deltaTime)
	Lighting.computeShadows(scene)
end)

I am out V2

You are strongly encouraged to mess with the code.

Bye for now!


Libs3D