CallMeRZIBI / Ray_Casting

Ray Caster

My ray casting engine project, most of the calculations came from this beautiful piece of art: https://lodev.org/cgtutor/raycasting.html

Simple Ray Caster

When creating simple ray caster you must give it those arguments:

RayCasting.UntexturedRayCaster SimpleRayCaster = new UtexturedRayCaster(screenWidth, screenHeight, renderingScale);

• screenWidth - int
• screenHeight - int
• renderingScale - int - scales the rendering width and size (default is 1) *isn't working at the moment

To create map that you can walk on you have to call this method

SimpleRayCaster.CreateMap(map, StartingPosX, StartingPosY, dirX, dirY, planeX, planeY);

and give it those parameters

• map - 2D array of numbers which are corresponding to indexes of textures - 1 (0 isn't anything)
• StartingPosX - double which corresponds to position of player X axis
• StartingPosY - double which corresponds to position of player Y axis
• dirX - double (default is -1) correspond to rotation
• dirY - double (default is 0) correspond to rotation
• planeX - double (default is 0) correspond to
• planeY - double (default is 0.66) correspond to

Move Camera

There is default movement with W A S D implemented, to use it you have to call this method

SimpleRayCaster.Move(W_Down, A_Down, S_Down, D_Down);

and give it those parameters as arguments for implemented movement

• W_Down (default is false in case you don't use built in movement) - bool if W is pressed (true = pressed)
• A_Down (default is false) - bool if A is pressed (true = pressed)
• S_Down (default is false) - bool if S is pressed (true = pressed)
• D_Down (default is false) - bool if D is pressed (true = pressed)

To move camera you can call this method:

SimpleRayCaster.CameraPos(double PosX, double PosY, double DirX, double DirY);

and pass it those arguments:

• PosX is double containing the X position of camera
• PosY is double containing the Y position of camera
• DirX is double containing the X position towards which camera is rotated
• DirY is double containing the Y position towards which camera is rotated

Update frame

SimpleRayCaster.UpdateRayCast();

Get frame from simple ray caster

SimpleRayCaster.GetGLVertices();

output:

• 2D float array of vertices

Ray Caster

You create RayCaster like this:

RayCasting.TexturedRayCaster rayCaster = new RayCasting.TexturedRayCaster();

Multi Threaded

You can also run raycaster multithreadedly by calling this method

rayCaster.MultiThreaded(threadNum);

and give it those parameters

• threadNum - int - number of threads you give it

To create map that you can walk on you have to call this method

rayCaster.CreateMap(map);

and give it those parameters

• map - 2D array of numbers which are corresponding to indexes of textures - 1 (0 isn't anything)

Set what kind of floor and ceiling you want

To have floor and ceiling only as color use this method

rayCaster.UseFloorCeilingColors(FloorColor, CeilingColor);

and give it those parameters as arguments

• FloorColor - 1D byte array with RGB values from 0 - 255
• CeilingColor - 1D byte array with RGB values from 0 - 255

And to have textured ceiling and floor use this method

rayCaster.UseFloorCeilingTextures(TexFloorIndex, TexCeilingIndex);

and give it those parameters as argument

• TexFloorIndex - int - index of texture in textures list that you give to ray caster
• TexCeilingIndex - int - index of texture in textures list that you give to ray caster

There is default movement with W A S D implemented, to use it you have to call this method

SimpleRayCaster.Move(W_Down, A_Down, S_Down, D_Down, cameraId, moveSpeed, rotSpeed);

and give it those parameters as arguments for implemented movement

• W_Down (default is false in case you don't use built in movement) - bool if W is pressed (true = pressed)
• A_Down (default is false) - bool if A is pressed (true = pressed)
• S_Down (default is false) - bool if S is pressed (true = pressed)
• D_Down (default is false) - bool if D is pressed (true = pressed)
• cameraId - (int) Id of cmera that you want to move
• moveSpeed (default is 5) - float of movement speed
• rotSpeed (default is 3) - float of rotation speed

Update frame

SimpleRayCaster.UpdateRayCast();

Camera

RayCasting.Camera camera = new Camera();

you can give those arguments to constructor:

• ScreenWidth - int of rendering width
• ScreenHeight - int of rendering height
• posX - double corresponding to position on X axis
• posY - double corresponding to position on Y axis
• dirX - double corresponding of X direction
• dirY - double corresponding of Y direction
• planeX - double (default is 0) correspond to
• planeY - double (default is 0.66) correspond to

and it has those public variables:

• all of the variables that you can put in constructor
• buffer - 3D byte array which you can directly use as RGB texture for OpenGL
• ZBuffer - double - DON'T MESS WITH IT!!!
• Id - int corresponding to count of the cameras

Setting camera position

You can set the position of the camera with this method

camera.SetCameraPos(PosX, PosY, DirX, DirY);

and give it those arguments:

• PosX - double corresponding to position on X axis
• PosY - double corresponding to position on Y axis
• DirX - double corresponding of X direction
• DirY - double corresponding of Y direction

Map

RayCasting.Map map = new Map();

Map has one public variable

• map - 2d array of integers that are corresponding to texture indexes + 1 that you'll load (0 is empty)

Map has 2 private variables

• Height - height of the map
• Width - width of the map

You can load or save map

Loading

map.LoadMap(path);

You have to give it this parameter as argument

• path - path to map's json file

Saving

map.SaveMap(path);

You have to give it this parameter as argument

• path - path to map's json file

Note

You have to first declare map and then you can save it

Textures

You can load textures in two different ways

From path

rayCaster.LoadTexturesFromPaths(paths);

You have to give it this parameter as argument

• paths - 1D string array which is containing paths to images

Or load it yourself and then give List of textures to it

rayCaster.LoadTextures(textures);

You have to give it this parameter as argument

• textures - List of Textures, the Texture class is in the library

Creating texture

RayCasting.Texture texture = new RayCasting.Texture(path);

You have to give it this parameter as argument

• path - string with path to image

Sprites

You can load sprites with this method

rayCaster.LoadSprites(sprites);

You have to give it this parameter as argument

• sprites - List of Sprites

Creating sprite

RayCasting.Sprite sprite = new RayCasting.Sprite();

This class have three public variables

• posX - double for position
• posY - double for position
• posZ - double for position (default is 0) *relies on resolution
• scaleX - double for scailing (default is 1)
• scaleY - double for scailing (default is 1)
• texture - Texture of the sprite

You can give sprite texture simply like public variable or with this method

sprite.LoadTextureFromPath(path);

And give it this parameter as argument

• path - string with path to image

Sound

This engine has a builtin sound system that supports Windows (when executing any of Tasks it stutters), Linux (with alsa) and MacOS X (currently untested). - souce: https://scientificprogrammer.net/2019/08/18/building-net-core-audio-application-part-1/\ It's able to play, stop, pause and resume sound.

You can create sound object

RayCasting.Sound.Sound sound = new RayCasting.Sound.Sound(?path);

And give it this argument

• path - string corresponding to path to sound, optional

This class has those public variables

• Playing - bool: true if sound is playing
• Puased - bool: true if sound is paused
• PlaybackFinished - event: fires on playback finished

If you want to change path to sound you can simply do it by calling this method

sound.SetPath(path);

And give it those arguments

• path - string corresponding to path to sound

Playing sound

sound.Play();

Stopping sound

sound.Stop();

Pausing sound

sound.Pause();

Resuming sound

sound.Resume();

All of those operational methods are Tasks, so you can wait for their completions and so on...